Class Index | File Index

Classes


Class R.lang.Timeout


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

Class Summary
Constructor Attributes Constructor Name and Description
 
R.lang.Timeout(name, interval, callback)
Create a timeout timer
Method Summary
Method Attributes Method Name and Description
 
Cancel this timeout timer.
 
Cancel and destroy the timeout
 
Get the class name of this object
 
Restart this timeout 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.Timeout(name, interval, callback)
Create a timeout 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 timeout timer.

destroy()
Cancel and destroy the timeout

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

restart()
Restart this timeout timer

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