dojox/widget/Roller.js

• Provides:

  • dojox.widget.Roller

• Requires:

  • dijit._Widget in common

• dojox.widget.Roller

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Widget: (call)
  • summary

    A simple widget to take an unordered-list of Text and roll through them

  • description

    The Roller widget takes an unordered-list of items, and converts
    them to a single-area (the size of one list-item, however you so choose
    to style it) and loops continually, fading between items.
    
    In it's current state, it requires it be created from an unordered (or ordered)
    list, though can contain complex markup.
    
    You can manipulate the `items` array at any point during the cycle with
    standard array manipulation techniques.
    
    The class "dojoxRoller" is added to the UL element for styling purposes.

  • example

    	// create a scroller from a unordered list with id="lister"
    	var thinger = new dojox.widget.Roller.Roller({},"lister");

  • example

    	// create a scroller from a fixed array, and place in the DOM:
    	new dojox.widget.Roller({ items:["one","two","three"] }).placeAt(dojo.body());

  • example

    	// add an item:
    	dijit.byId("roller").items.push("I am a new Label");

  • example

    	// stop a roller from rolling:
    	dijit.byId("roller").stop();

• dojox.widget.Roller.delay

  • type

    Integer

  • summary

    Interval between rolls

• dojox.widget.Roller.autoStart

  • type

    Boolean

  • summary

    Toggle to control starup behavior. Call .start() manually
    if set to <code>false</code>

• dojox.widget.Roller.itemSelector

  • type

    String

  • summary

    A CSS selector to be used by <code>dojo.query</code> to find the children
    items in this widget. Defaults to &quot;&gt; li&quot;, finding only first-children
    list-items in the list, allowing for embedded lists to occur.

• dojox.widget.Roller.durationIn

  • type

    Integer

  • summary

    Speed (in ms) to apply to the "in" animation (show the node)

• dojox.widget.Roller.durationOut

  • type

    Integer

  • summary

    Speed (in ms) to apply to the "out" animation (hide the showing node)

• dojox.widget.Roller.items

  • type

    Array

  • summary

    If populated prior to instantiation, is used as the Items over the children

• dojox.widget.Roller._idx

  • type

    Integer

  • summary

    Index of the the currently visible item in the list of items[]

• dojox.widget.Roller.postCreate

  • type

    Function

• dojox.widget.Roller._roller

  • type

    Object

• dojox.widget.Roller.makeAnims

  • summary

    Animation creator function. Need to create an 'in' and 'out'
    Animation stored in _anim Object, which the rest of the widget
    will reuse.

  • type

    Function

• dojox.widget.Roller.domNode

• dojox.widget.Roller._setupConnects

  • summary

    setup the loop connection logic

  • type

    Function

• dojox.widget.Roller._anim

• dojox.widget.Roller.start

  • summary

    Starts to Roller looping

  • type

    Function

• dojox.widget.Roller.rolling

  • type

    bool

• dojox.widget.Roller._run

  • type

    Function

• dojox.widget.Roller.stop

  • summary

    Stops the Roller from looping anymore.

  • type

    Function

• dojox.widget.Roller._timeout

• dojox.widget.Roller._setIndex

  • parameters:
    • i
  • summary

    Set the Roller to some passed index. If beyond range, go to first.

  • type

    Function

• dojox.widget.Roller._roller.innerHTML

  • type

    String

• dojox.widget.RollerSlide

  • type

    Function

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

    An add-on to the Roller to modify animations. This produces
    a slide-from-bottom like effect. See <code>dojox.widget.Roller</code> for
    full API information.

• dojox.widget.RollerSlide.durationOut

  • type

    Number

• dojox.widget.RollerSlide.makeAnims

  • summary

    Animation creator function. Need to create an 'in' and 'out'
    Animation stored in _anim Object, which the rest of the widget
    will reuse.

  • type

    Function

• dojox.widget.RollerSlide.domNode

• dojox.widget._RollerHover

  • type

    Function

  • summary

    A mixin class to provide a way to automate the "stop on hover" functionality.

  • description

    A mixin class used to provide a way to automate a "stop on hover" behavior,
    while still allowing for ambigious subclassing for custom animations.
    Simply mix this class into a `dojox.widget.Roller` variant, and instantiate
    as you would. The hover connection is done automatically.
    
    The "hover" functionality is as such: Stop rotation while the mouse is over the
    instance, and resume again once leaving. Even if autoStart is disabled, the widget
    will start if a mouse enters and leaves the node in this case.

  • example

     dojo.declare("my.Roller", [dojox.widget.RollerSlide, dojox.widget._RollerHover], {});
     new my.Roller({}, "myList");

• dojox.widget._RollerHover.postCreate

  • type

    Function

• dojox.widget

  • type

    Object

• dojox

  • type

    Object