AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.Timer Class

    Defined in: alloy-ui/src/aui-timer/js/aui-timer.js:14
    Module: aui-timer

    A base class for Timer.

    Constructor

    Methods

    _create

    (
    • repeats
    • ms
    • fn
    )
    Object protected

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:166

    Creates a collection of timer definitions.

    Parameters:

    • repeats Object
    • ms Object
    • fn Object

    Returns:

    Object:

    _decrementNextRunTime

    (
    • tasks
    )
    protected

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:186

    Subtracts the current time with the last run time. The result of this operation is subtracted with the task timeout.

    Parameters:

    • tasks Object

    _getNearestInterval

    (
    • num
    )
    Number protected

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:198

    Calculates the nearest interval by using the modulus of the argument with the interval as reference.

    Parameters:

    • num Object

    Returns:

    Number:

    _lazyDestroy

    () protected

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:226

    Checks if the timer is initialized and empty, then calls the clearTimeout function using the global interval id.

    _lazyInit

    () protected

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:243

    Checks if the timer is initialized and contains a task, then calls the setTimeout function and stores the global interval id.

    _loop

    (
    • i
    • pendingTasks
    • length
    )
    protected

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:264

    Goes through all pending tasks and initializes its timer or unregisters it depending on the task status.

    Parameters:

    • i Object
    • pendingTasks Object
    • length Object

    _resetNextRunTime

    (
    • task
    )
    protected

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:326

    Resets the next run time.

    Parameters:

    • task Object

    _runner

    () protected

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:310

    Gets the arguments to call the _loop method.

    A.clearInterval

    (
    • id
    )
    static

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:345

    Cancels repeated action which was set up using setInterval function.

    Parameters:

    • id Object

    A.clearTimeout

    (
    • id
    )
    static

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:354

    Clears the delay set by setTimeout function.

    Parameters:

    • id Object

    A.setInterval

    (
    • fn
    • ms
    • context
    )
    static

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:363

    Calls a function repeatedly, with a fixed time delay between each call to that function.

    Parameters:

    • fn Object
    • ms Object
    • context Object

    A.setTimeout

    (
    • fn
    • ms
    • context
    )
    static

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:375

    Calls a function after a specified delay.

    Parameters:

    • fn Object
    • ms Object
    • context Object

    clearInterval

    (
    • id
    )

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:22

    Cancels repeated action which was set up using setInterval function.

    Parameters:

    • id Object

    clearTimeout

    (
    • id
    )

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:34

    Clears the delay set by setTimeout function.

    Parameters:

    • id Object

    intervalTime

    (
    • newInterval
    )
    Number

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:46

    Defines the fixed time delay between each interval.

    Parameters:

    • newInterval Object

    Returns:

    Number:

    isRepeatable

    (
    • task
    )
    Boolean

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:63

    Checks if the task is repeatable or not.

    Parameters:

    • task Object

    Returns:

    Boolean:

    register

    (
    • repeats
    • fn
    • ms
    • context
    • args
    )

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:107

    Adds a new task to the timer.

    Parameters:

    • repeats Object
    • fn Object
    • ms Object
    • context Object
    • args Object

    run

    (
    • task
    )

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:135

    Runs the task function.

    Parameters:

    • task Object

    setInterval

    (
    • fn
    • ms
    • context
    )

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:90

    Calls a function repeatedly, with a fixed time delay between each call to that function.

    Parameters:

    • fn Object
    • ms Object
    • context Object

    setTimeout

    (
    • fn
    • ms
    • context
    )

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:74

    Calls a function after a specified delay.

    Parameters:

    • fn Object
    • ms Object
    • context Object

    unregister

    (
    • repeats
    • id
    )

    Defined in alloy-ui/src/aui-timer/js/aui-timer.js:147

    Removes a task from the timer.

    Parameters:

    • repeats Object
    • id Object