dojox/widget/AutoRotator.js

• Provides:

  • dojox.widget.AutoRotator

• Requires:

  • dojox.widget.Rotator in common

• dojox.widget.AutoRotator

  • type

    Function

  • chains:
    • dojox.widget.Rotator: (prototype)
    • dojox.widget.Rotator: (call)
  • summary

    A rotator that automatically transitions between child nodes.

  • description

    Adds automatic rotating to the dojox.widget.Rotator.  The
    AutoRotator has parameters that control how user input can
    affect the rotator including a suspend when hovering over the
    rotator and pausing when the user manually advances to another
    pane.

  • example

    	<div dojoType="dojox.widget.AutoRotator" duration="3000">
    		<div>
    			Pane 1!
    		</div>
    		<div duration="5000">
    			Pane 2 with an overrided duration!
    		</div>
    	</div>

• dojox.widget.AutoRotator.suspendOnHover

  • type

    boolean

  • summary

    Pause the rotator when the mouse hovers over it.

• dojox.widget.AutoRotator.duration

  • type

    int

  • summary

    The time in milliseconds before transitioning to the next pane.  The
    default value is 4000 (4 seconds).

• dojox.widget.AutoRotator.autoStart

  • type

    boolean

  • summary

    Starts the timer to transition children upon creation.

• dojox.widget.AutoRotator.pauseOnManualChange

  • type

    boolean

  • summary

    Pause the rotator when the pane is changed or a controller's next or
    previous buttons are clicked.

• dojox.widget.AutoRotator.cycles

  • type

    int

  • summary

    Number of cycles before pausing.

• dojox.widget.AutoRotator.random

  • type

    boolean

  • summary

    Determines if the panes should cycle randomly.

• dojox.widget.AutoRotator.reverse

  • type

    boolean

  • summary

    Causes the rotator to rotate in reverse order.

• dojox.widget.AutoRotator.constructor

  • constructor - constructor
  • type

    Function

  • summary

    Initializes the timer and connect to the rotator.

• dojox.widget.AutoRotator.destroy

  • summary

    Disconnect the AutoRotator's events.

  • type

    Function

• dojox.widget.AutoRotator.play

  • parameters:
    • skipCycleDecrement: (typeof boolean)
    • skipDuration: (typeof boolean)
  • summary

    Sets the state to "playing" and schedules the next cycle to run.

  • type

    Function

• dojox.widget.AutoRotator.playing

  • type

    bool

• dojox.widget.AutoRotator._resumeDuration

  • type

    Number

• dojox.widget.AutoRotator._endTime

  • type

    String

• dojox.widget.AutoRotator._timer

  • type

    Object

• dojox.widget.AutoRotator.pause

  • summary

    Sets the state to "not playing" and clears the cycle timer.

  • type

    Function

• dojox.widget.AutoRotator._suspended

  • type

    bool

• dojox.widget.AutoRotator._now

  • summary

    Helper function to return the current system time in milliseconds.

  • type

    Function

• dojox.widget.AutoRotator._resetTimer

  • summary

    Resets the timer used to schedule the next transition.

  • type

    Function

• dojox.widget.AutoRotator._cycle

  • parameters:
    • manual: (typeof boolean|int)
  • summary

    Cycles the rotator to the next/previous pane.

  • type

    Function

• dojox.widget.AutoRotator.onManualChange

  • parameters:
    • action: (typeof string)
  • summary

    Override the Rotator's onManualChange so we can pause.

  • type

    Function

• dojox.widget

  • type

    Object

• dojox

  • type

    Object