Class Index | File Index

Classes


Class R.lang.IntervalTimer


Extends R.lang.AbstractTimer.
An extension of R.lang.AbstractTimer that wraps the window.setInterval method.
Defined in: intervaltimer.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
R.lang.IntervalTimer(name, interval, callback)
Create an interval timer
Method Summary
Method Attributes Method Name and Description
 
Cancel this interval timer.
 
Cancel and destroy the interval timer.
 
Get the class name of this object
 
Restart this interval timer.
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.IntervalTimer(name, interval, callback)
Create an interval timer
Parameters:
name
{String} The name of the timer
interval
{Number} The interval for the timer, in milliseconds
callback
{Function} The function to call when the interval is reached
Method Detail
cancel()
Cancel this interval timer.

destroy()
Cancel and destroy the interval timer.

{String} getClassName()
Get the class name of this object
Returns:
{String} "R.lang.IntervalTimer"

restart()
Restart this interval timer.

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