dojox/widget/rotator/Controller (version 1.10)

Summary

A controller that manipulates a Rotator or AutoRotator.

Displays a series of controls that send actions to a Rotator or AutoRotator. The Controller supports the following controls:

You may specify any of these controls in any order. You may also have multiple Controllers tied to a single Rotator instance.

The Controller's DOM node may also be styled for positioning or other styled preferences.

Usage

var foo = new Controller(params,node);
dojox/widget/rotator/Controller
Parameter Type Description
params Object
node DomNode | string

See the dojox/widget/rotator/Controller reference documentation for more information.

Examples

Example 1

<div dojoType="dojox.widget.rotator.Controller"
    rotator="myRotator"
></div>

Example 2

<div dojoType="dojox.widget.rotator.Controller"
    rotator="myRotator"
    controls="prev,#,next"
    class="myCtrl"
></div>

Example 3

<div dojoType="dojox.widget.rotator.Controller"
    rotator="myRotator"
    controls="titles"
    class="myCtrl"
></div>s

Property Summary

  • commandsA comma-separated list of commands.
  • rotatorAn instance of a Rotator widget.

Method Summary

  • _buildInfo(r) Return a string containing the current pane number and the total number of panes.
  • _togglePlay(playing) Toggles the play/pause button, if it exists.
  • destroy() Disconnect from the rotator.

Event Summary

  • _onUpdate(type) Updates various pager controls when the rotator updates.

Properties

commands

A comma-separated list of commands. Valid commands are: prev An icon button to go to the previous pane. next An icon button to go to the next pane. play/pause A play and pause toggle icon button. info Displays the current and total panes. (ie "1 / 4")

Displays a number button for each pane. (ie "1 2 3 4")

titles Displays each pane's title as a tab. (ie "Home Services Contact Blog")

rotator

An instance of a Rotator widget.

Methods

_buildInfo(r)

Return a string containing the current pane number and the total number of panes.

Parameter Type Description
r dojox/widget/Rotator
Returns:string
_togglePlay(playing)

Toggles the play/pause button, if it exists.

Parameter Type Description
playing boolean
destroy()

Disconnect from the rotator.

Events

_onUpdate(type)

Updates various pager controls when the rotator updates.

Parameter Type Description
type string

Examples

Example 1

<div dojoType="dojox.widget.rotator.Controller"
    rotator="myRotator"
></div>

Example 2

<div dojoType="dojox.widget.rotator.Controller"
    rotator="myRotator"
    controls="prev,#,next"
    class="myCtrl"
></div>

Example 3

<div dojoType="dojox.widget.rotator.Controller"
    rotator="myRotator"
    controls="titles"
    class="myCtrl"
></div>s
Error in the documentation? Can’t find what you are looking for? Let us know!