dojox/widget/Rotator.js

• Provides:

  • dojox.widget.Rotator

• Requires:

  • dojo.parser in common

• dojox.widget.Rotator

  • type

    Function

  • parameters:
    • params: (typeof Object)
    • node: (typeof DomNode|string)
  • summary

    A widget for rotating through child nodes using transitions.

  • description

    A small, fast, extensible, awesome rotator that cycles, with transitions,
    through panes (child nodes) displaying only one at a time and ties into
    controllers used to change state.
    
    The Rotator does not rely on dijit.  It is designed to be as lightweight
    as possible.  Controllers and transitions have been externalized
    so builds can be as optimized with only the components you want to use.
    
    For best results, each rotator pane should be the same height and width as
    the Rotator container node and consider setting overflow to hidden.
    While the Rotator will accept any DOM node for a rotator pane, a block
    element or element with display:block is recommended.
    
    Note: When the Rotator begins, it does not transition the first pane.
    
    subscribed topics:
    [id]/rotator/control - Controls the Rotator
    Parameters:
    /*string*/ action        - The name of a method of the Rotator to run
    /*anything?*/ args       - One or more arguments to pass to the action
    
    published topics:
    [id]/rotator/update - Notifies controllers that a pane or state has changed.
    Parameters:
    /*string*/ type          - the type of notification
    /*dojox.widget.Rotator*/ rotator
    - the rotator instance
    /*object?*/ params		 - params
    
    declarative dojo/method events (per pane):
    onBeforeIn  - Fired before the transition in starts.
    onAfterIn   - Fired after the transition in ends.
    onBeforeOut - Fired before the transition out starts.
    onAfterOut  - Fired after the transition out ends.

  • example

    	<div dojoType="dojox.widget.Rotator">
    		<div>Pane 1!</div>
    		<div>Pane 2!</div>
    	</div>

  • example

    	<script type="text/javascript">
    		dojo.require("dojox.widget.rotator.Fade");
    	</script>
    	<div dojoType="dojox.widget.Rotator" transition="dojox.widget.rotator.crossFade">
    		<div>Pane 1!</div>
    		<div>Pane 2!</div>
    	</div>

• dojox.widget.Rotator.transition

  • alias - _defaultTransition
  • type

    string

  • summary

    The name of a function that is passed two panes nodes and a duration,
    then returns a dojo.Animation object. The default value is
    "dojox.widget.rotator.swap".

• dojox.widget.Rotator.transitionParams

  • type

    string

  • summary

    Parameters for the transition. The string is read in and eval'd as an
    object.  If the duration is absent, the default value will be used.

• dojox.widget.Rotator.panes

  • type

    array

  • summary

    Array of panes to be created in the Rotator. Each array element
    will be passed as attributes to a dojo.create() call.

• dojox.widget.Rotator.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • params: (typeof Object)
    • node: (typeof DomNode|string)
  • summary

    Initializes the panes and events.

• dojox.widget.Rotator.destroy

  • summary

    Destroys the Rotator and its DOM node.

  • type

    Function

• dojox.widget.Rotator.next

  • summary

    Transitions the Rotator to the next pane.

  • type

    Function

• dojox.widget.Rotator.prev

  • summary

    Transitions the Rotator to the previous pane.

  • type

    Function

• dojox.widget.Rotator.go

  • parameters:
    • p: (typeof int|string)
  • summary

    Transitions the Rotator to the specified pane index.

  • type

    Function

• dojox.widget.Rotator.onUpdate

  • parameters:
    • type: (typeof string)
    • params: (typeof object)
  • summary

    Send a notification to all controllers with the state of the rotator.

  • type

    Function

• dojox.widget.Rotator._resetWaitForEvent

  • summary

    If there is a waitForEvent pending, kill it.

  • type

    Function

• dojox.widget.Rotator.wfe

  • type

    Object

• dojox.widget.Rotator.control

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

    Dispatches an action, first to this engine, then to the Rotator.

  • type

    Function

• dojox.widget.Rotator.resize

  • parameters:
    • width: (typeof int)
    • height: (typeof int)
  • type

    Function

• dojox.widget.Rotator._domNodeContentBox

  • type

    Object

• dojox.widget.Rotator.onManualChange

  • summary

    Stub function that can be overriden or connected to.

  • type

    Function

• dojox.widget

  • type

    Object

• dojox

  • type

    Object