Class Index | File Index

Classes


Class R.lang.OneShotTrigger


Extends R.lang.OneShotTimeout.
An extension of R.lang.OneShotTimeout which is a one-shot timer that triggers a callback, at regular intervals, until the timer has expired. When the timer expires, the trigger will automatically destroy itself. Within the callbacks, this refers to the Timer object itself.
Defined in: oneshottrigger.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
R.lang.OneShotTrigger(name, interval, callback, triggerInterval, triggerCallback)
Create a one-shot triggering timeout
Method Summary
Method Attributes Method Name and Description
 
Get the class name of this object
Methods borrowed from class R.lang.Timeout:
cancel, destroy, restart
Methods borrowed from class R.lang.AbstractTimer:
getCallback, getInterval, getTimer, isRunning, pause, release, setCallback, setInterval, setTimer
Methods borrowed from class R.engine.BaseObject:
addEvent, addEvents, getElement, jQ, removeEvent, setElement, triggerEvent, update
Methods borrowed from class R.engine.PooledObject:
clearObjectDataModel, getId, getName, getObjectDataModel, getProperties, isDestroyed, setName, setObjectDataModel, toString, toXML
Class Detail
R.lang.OneShotTrigger(name, interval, callback, triggerInterval, triggerCallback)
Create a one-shot triggering timeout
Parameters:
name
{String} The name of the timer
interval
{Number} The full interval for the timer, in milliseconds
callback
{Function} The function to call when the full interval is reached
triggerInterval
{Number} The interval between triggers, in milliseconds
triggerCallback
{Function} The function to call for each trigger interval
Method Detail
{String} getClassName()
Get the class name of this object
Returns:
{String} "R.lang.OneShotTrigger"

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Mar 18 2013 16:09:19 GMT-0400 (EDT)