API Preview tool | The Dojo Toolkit

dojox/widget/Rotator.js

Provides:
- dojox.widget.Rotator
Requires:
- dojo.parser in common in project dojo
dojox.widget.Rotator
- type
```
Function
```
- summary
```
Initializes the panes and events.
```
- 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>
```
- parameters:
  - params: (typeof Object)
  - node: (typeof DomNode|string)
- source: [view]
     d.mixin(this, params);
  
     var _t = this,
      t = _t.transition,
      tt = _t._transitions = {},
      idm = _t._idMap = {},
      tp = _t.transitionParams = eval("({ " + _t.transitionParams + " })"),
      node = _t._domNode = dojo.byId(node),
      cb = _t._domNodeContentBox = d.contentBox(node), // we are going to assume the rotator will not be changing size
  
      // default styles to apply to all the container node and rotator's panes
      p = {
       left: 0,
       top: 0
      },
  
      warn = function(bt, dt){
       console.warn(_t.declaredClass, ' - Unable to find transition "', bt, '", defaulting to "', dt, '".');
      };
  
     // if we don't have an id, then generate one
     _t.id = node.id || (new Date()).getTime();
  
     // force the rotator DOM node to a relative position and attach the container node to it
     if(d.style(node, "position") == "static"){
      d.style(node, "position", "relative");
     }
  
     // create our object for caching transition objects
     tt[t] = d.getObject(t);
     if(!tt[t]){
      warn(t, _defaultTransition);
      tt[_t.transition = _defaultTransition] = d.getObject(_defaultTransition);
     }
  
     // clean up the transition params
     if(!tp.duration){
      tp.duration = _defaultTransitionDuration;
     }
  
     // if there are any panes being passed in, add them to this node
     d.forEach(_t.panes, function(p){
      d.create("div", p, node);
     });
  
     // zero out our panes array to store the real pane instance
     var pp = _t.panes = [];
  
     // find and initialize the panes
     d.query(">", node).forEach(function(n, i){
      var q = { node: n, idx: i, params: d.mixin({}, tp, eval("({ " + (d.attr(n, "transitionParams") || "") + " })")) },
       r = q.trans = d.attr(n, "transition") || _t.transition;
  
      // cache each pane's title, duration, and waitForEvent attributes
      d.forEach(["id", "title", "duration", "waitForEvent"], function(a){
       q[a] = d.attr(n, a);
      });
  
      if(q.id){
       idm[q.id] = i;
      }
  
      // cache the transition function
      if(!tt[r] && !(tt[r] = d.getObject(r))){
       warn(r, q.trans = _t.transition);
      }
  
      p.position = "absolute";
      p.display = _noneStr;
  
      // find the selected pane and initialize styles
      if(_t.idx == null || d.attr(n, "selected")){
       if(_t.idx != null){
        d.style(pp[_t.idx].node, _displayStr, _noneStr);
       }
       _t.idx = i;
       p.display = "";
      }
      d.style(n, p);
  
      // check for any declarative script blocks
      d.query("> script[type^='dojo/method']", n).orphan().forEach(function(s){
       var e = d.attr(s, "event");
       if(e){
        q[e] = d.parser._functionFromScript(s);
       }
      });
  
      // add this pane to the array of panes
      pp.push(q);
     });
  
     _t._controlSub = d.subscribe(_t.id + "/rotator/control", _t, "control");

dojox.widget.Rotator.transition

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
&quot;dojox.widget.rotator.swap&quot;.

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.destroy
- type
```
Function
```
- source: [view]
  d.forEach([this._controlSub, this.wfe], d.unsubscribe);
  d.destroy(this._domNode);
- summary
```
Destroys the Rotator and its DOM node.
```
dojox.widget.Rotator.next
- type
```
Function
```
- source: [view]
  return this.go(this.idx + 1);
- summary
```
Transitions the Rotator to the next pane.
```
dojox.widget.Rotator.prev
- type
```
Function
```
- source: [view]
  return this.go(this.idx - 1);
- summary
```
Transitions the Rotator to the previous pane.
```
dojox.widget.Rotator.go
- type
```
Function
```
- parameters:
  - p: (typeof int|string)
- source: [view]
     var _t = this,
      i = _t.idx,
      pp = _t.panes,
      len = pp.length,
      idm = _t._idMap[p];
  
     // we gotta move on, so if the current pane is waiting for an event, just
     // ignore it and clean up
     _t._resetWaitForEvent();
  
     // determine the next index and set it to idx for the next go to
     p = idm != null ? idm : (p || 0);
     p = p < len ? (p < 0 ? len-1 : p) : 0;
  
     // if we're already on the requested pane or still transitioning, then return
     if(p == i || _t.anim){
      return null;
     }
  
     // get the current and next panes
     var current = pp[i],
      next = pp[p];
  
     // adjust the zIndexes so our animations look good... this must be done before
     // the animation is created so the animation could override it if necessary
     d.style(current.node, _zIndex, 2);
     d.style(next.node, _zIndex, 1);
  
     // info object passed to animations and onIn/Out events
     var info = {
       current: current,
       next: next,
       rotator: _t
      },
  
      // get the transition
      anim = _t.anim = _t._transitions[next.trans](d.mixin({
       rotatorBox: _t._domNodeContentBox
      }, info, next.params));
  
     if(anim){
      // create the deferred that we'll be returning
      var def = new d.Deferred(),
       ev = next.waitForEvent,
  
       h = d.connect(anim, "onEnd", function(){
        // reset the node styles
        d.style(current.node, {
         display: _noneStr,
         left: 0,
         opacity: 1,
         top: 0,
         zIndex: 0
        });
  
        d.disconnect(h);
        _t.anim = null;
        _t.idx = p;
  
        // fire end events
        if(current.onAfterOut){ current.onAfterOut(info); }
        if(next.onAfterIn){ next.onAfterIn(info); }
  
        _t.onUpdate("onAfterTransition");
  
        if(!ev){
         // if there is a previous waitForEvent, then we need to make
         // sure it gets unsubscribed
         _t._resetWaitForEvent();
  
         // animation is all done, fire the deferred callback.
         def.callback();
        }
       });
  
      // if we're waiting for an event, subscribe to it so we know when to continue
      _t.wfe = ev ? d.subscribe(ev, function(){
       _t._resetWaitForEvent();
       def.callback(true);
      }) : null;
  
      _t.onUpdate("onBeforeTransition");
  
      // fire start events
      if(current.onBeforeOut){ current.onBeforeOut(info); }
      if(next.onBeforeIn){ next.onBeforeIn(info); }
  
      // play the animation
      anim.play();
  
      // return the deferred
      return def; /*Deferred*/
     }
- summary
```
Transitions the Rotator to the specified pane index.
```
- returns
```
Deferred
```
dojox.widget.Rotator.onUpdate
- type
```
Function
```
- parameters:
  - type: (typeof string)
  - params: (typeof object)
- source: [view]
  d.publish(this.id + "/rotator/update", [type, this, params || {}]);
- summary
```
Send a notification to all controllers with the state of the rotator.
```
dojox.widget.Rotator._resetWaitForEvent
- type
```
Function
```
- source: [view]
     if(this.wfe){
      d.unsubscribe(this.wfe);
      this.wfe = null;
     }
- summary
```
If there is a waitForEvent pending, kill it.
```
dojox.widget.Rotator.control
- type
```
Function
```
- parameters:
  - action: (typeof string)
- source: [view]
     var args = d._toArray(arguments),
      _t = this;
     args.shift();
  
     _t._resetWaitForEvent();
  
     if(_t[action]){
      // action exists, so call it and fire deferred if applicable
      var def = _t[action].apply(_t, args);
      if(def){
       def.addCallback(function(){
        _t.onUpdate(action);
       });
      }
  
      // since this action was triggered by a controller, we assume this was a
      // manual action, so check if we should pause
      _t.onManualChange(action);
     }else{
      console.warn(_t.declaredClass, ' - Unsupported action "', action, '".');
     }
- summary
```
Dispatches an action, first to this engine, then to the Rotator.
```
dojox.widget.Rotator.resize
- type
```
Function
```
- parameters:
  - width: (typeof int)
  - height: (typeof int)
- source: [view]
     var b = this._domNodeContentBox = { w: width, h: height };
     d.contentBox(this._domNode, b);
     d.forEach(this.panes, function(p){ d.contentBox(p.node, b); });
- summary
dojox.widget.Rotator.onManualChange
- type
```
Function
```
- source: [view]
  // summary:
  // Stub function that can be overriden or connected to.
- summary
```
Stub function that can be overriden or connected to.
```
dojox.widget.Rotator.wfe
- summary
dojox.widget.Rotator._domNodeContentBox
- summary
_defaultTransitionDuration
- summary
_displayStr
- summary
_noneStr
- summary
_zIndex
- summary
p.left
- summary
p.top
- summary
p
- type
```
Object
```
- summary
dojox.widget
- type
```
Object
```
- summary
dojox
- type
```
Object
```
- summary

dojox/widget/Rotator.js

Provides:

Requires:

dojox.widget.Rotator

dojox.widget.Rotator.transition

dojox.widget.Rotator.transitionParams

dojox.widget.Rotator.panes

dojox.widget.Rotator.destroy

dojox.widget.Rotator.next

dojox.widget.Rotator.prev

dojox.widget.Rotator.go

dojox.widget.Rotator.onUpdate

dojox.widget.Rotator._resetWaitForEvent

dojox.widget.Rotator.control

dojox.widget.Rotator.resize

dojox.widget.Rotator.onManualChange

dojox.widget.Rotator.wfe

dojox.widget.Rotator._domNodeContentBox

_defaultTransitionDuration

_displayStr

_noneStr

_zIndex

p.left

p.top

p

dojox.widget

dojox