dojo/fx/Toggler.js

• Provides:

  • dojo.fx.Toggler

• dojo.fx.Toggler

  • type

    Function

  • parameters:
    • args
  • summary

    A simple <code>dojo.Animation</code> toggler API.

  • description

    class constructor for an animation toggler. It accepts a packed
    set of arguments about what type of animation to use in each
    direction, duration, etc. All available members are mixed into
    these animations from the constructor (for example, `node`,
    `showDuration`, `hideDuration`).

  • example

    	var t = new dojo.fx.Toggler({
    		node: "nodeId",
    		showDuration: 500,
    		// hideDuration will default to "200"
    		showFunc: dojo.fx.wipeIn,
    		// hideFunc will default to "fadeOut"
    	});
    	t.show(100); // delay showing for 100ms
    	// ...time passes...
    	t.hide();

• dojo.fx.Toggler.node

  • type

    DomNode

  • summary

    the node to target for the showing and hiding animations

• dojo.fx.Toggler.showFunc

  • alias - dojo.fadeIn
  • type

    Function

  • summary

    The function that returns the <code>dojo.Animation</code> to show the node

• dojo.fx.Toggler.hideFunc

  • alias - dojo.fadeOut
  • type

    Function

  • summary

    The function that returns the <code>dojo.Animation</code> to hide the node

• dojo.fx.Toggler.showDuration

  • type

    Time

  • summary

    in milliseconds to run the show Animation

• dojo.fx.Toggler.hideDuration

  • type

    Time

  • summary

    in milliseconds to run the hide Animation

• dojo.fx.Toggler._showArgs

  • type

    Object

• dojo.fx.Toggler._showAnim

  • type

    Object

• dojo.fx.Toggler._hideArgs

  • type

    Object

• dojo.fx.Toggler._hideAnim

  • type

    Object

• dojo.fx.Toggler._isShowing

  • type

    bool

• dojo.fx.Toggler._isHiding

  • type

    bool

• dojo.fx.Toggler.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args

• dojo.fx.Toggler.show

  • parameters:
    • delay: (typeof Integer)

      Ammount of time to stall playing the show animation

  • summary

    Toggle the node to showing

  • type

    Function

• dojo.fx.Toggler.hide

  • parameters:
    • delay: (typeof Integer)

      Ammount of time to stall playing the hide animation

  • summary

    Toggle the node to hidden

  • type

    Function

• dojo.fx

  • type

    Object

• dojo

  • type

    Object