dojox/timing/Sequence.js

• Provides:

  • dojox.timing.Sequence

• dojox.timing.Sequence

  • type

    Function

  • summary

    This class provides functionality to really sequentialize
    function calls. You need to provide a list of functions and
    some parameters for each (like: pauseBefore) and they will
    be run one after another. This can be very useful for slideshows
    or alike things.

  • description

    This array will contain the sequence defines resolved, so that
    ie. repeat:10 will result in 10 elements in the sequence, so
    the repeat handling is easier and we don't need to handle that
    many extra cases. Also the doneFunction, if given is added at the
    end of the resolved-sequences.

• dojox.timing.Sequence._defsResolved

  • type

    Array

  • summary

    The resolved sequence, for easier handling.

• dojox.timing.Sequence._goOnPause

  • type

    Integer

  • summary

    The pause to wait before really going on.

• dojox.timing.Sequence._running

  • type

    bool

• dojox.timing.Sequence.constructor

  • constructor - constructor
  • type

    Function

• dojox.timing.Sequence.go

  • parameters:
    • defs: (typeof Array)

      The sequence of actions

    • doneFunction: (typeof Function|Array)

      The function to call when done

  • summary

    Run the passed sequence definition

  • type

    Function

• dojox.timing.Sequence._curId

  • type

    Number

• dojox.timing.Sequence._go

  • summary

    Execute one task of this._defsResolved.

  • type

    Function

• dojox.timing.Sequence.goOn

  • summary

    This method just provides a hook from the outside, so that
    an interrupted sequence can be continued.

  • type

    Function

• dojox.timing.Sequence.stop

  • summary

    Stop the currently running sequence.

  • description

    This can only interrupt the sequence not the last function that
    had been started. If the last function was i.e. a slideshow
    that is handled inside a function that you have given as
    one sequence item it cant be stopped, since it is not controlled
    by this object here. In this case it would be smarter to
    run the slideshow using a sequence object so you can also stop
    it using this method.

  • type

    Function

• dojox.timing

  • type

    Object

• dojox

  • type

    Object