| window.runtime property | window.runtime.flash.utils.Timer |
| Inheritance | Timer  EventDispatcher Object |
| Runtime Versions: | AIR 1.0, |
start() method to start a timer.
Add an event listener for the timer event to set up code to be run on the timer interval.
You can create Timer objects to run once or repeat at specified intervals to execute code on a schedule. Applications may dispatch events at slightly offset intervals based on the internal frame rate of the application. Memory-intensive scripts may also offset the events.
Hide Inherited Public Properties
Show Inherited Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentCount : int [read-only]
The total number of times the timer has fired since it started
at zero. | Timer | ||
| delay : Number
The delay, in milliseconds, between timer
events. | Timer | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| repeatCount : int
The total number of times the timer is set to run. | Timer | ||
| running : Boolean [read-only]
The timer's current state; true if the timer is running, otherwise false. | Timer | ||
| Method | Defined By | ||
|---|---|---|---|
Timer(delay:Number, repeatCount:int = 0)
Constructs a new Timer object with the specified delay
and repeatCount states. | Timer | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
| dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow. | EventDispatcher | |
| hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
| hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined. | Object | |
| isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
| propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable. | Object | |
| removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object. | EventDispatcher | |
reset():void
Stops the timer, if it is running, and sets the currentCount property back to 0,
like the reset button of a stopwatch. | Timer | ||
| setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations. | Object | |
start():void
Starts the timer, if it is not already running. | Timer | ||
stop():void
Stops the timer. | Timer | ||
| toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| toString():String
Returns the string representation of the specified object. | Object | |
| valueOf():Object
Returns the primitive value of the specified object. | Object | |
| willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched whenever a Timer object reaches an interval specified according to the Timer.delay property. | Timer | |||
| Dispatched whenever it has completed the number of requests set by Timer.repeatCount. | Timer | |||
currentCount | property |
currentCount:int [read-only] | Runtime Versions: | AIR 1.0, |
The total number of times the timer has fired since it started at zero. If the timer has been reset, only the fires since the reset are counted.
delay | property |
delay:Number| Runtime Versions: | AIR 1.0, |
The delay, in milliseconds, between timer
events. If you set the delay interval while
the timer is running, the timer will restart
at the same repeatCount iteration.
Note: A delay lower than 20 milliseconds is not recommended. Timer frequency
is limited to 60 frames per second, meaning a delay lower than 16.6 milliseconds causes runtime problems.
Throws
Error — Throws an exception if the delay specified is negative or not a finite number.
|
repeatCount | property |
repeatCount:int| Runtime Versions: | AIR 1.0, |
The total number of times the timer is set to run.
If the repeat count is set to 0, the timer continues forever
or until the stop() method is invoked or the program stops.
If the repeat count is nonzero, the timer runs the specified number of times.
If repeatCount is set to a total that is the same or less then currentCount
the timer stops and will not fire again.
running | property |
running:Boolean [read-only] | Runtime Versions: | AIR 1.0, |
The timer's current state; true if the timer is running, otherwise false.
Timer | () | Constructor |
public function Timer(delay:Number, repeatCount:int = 0)| Runtime Versions: | AIR 1.0, |
Constructs a new Timer object with the specified delay
and repeatCount states.
The timer does not start automatically; you must call the start() method
to start it.
delay:Number — The delay between timer events, in milliseconds. A delay lower than 20 milliseconds is not recommended. Timer frequency
is limited to 60 frames per second, meaning a delay lower than 16.6 milliseconds causes runtime problems.
| |
repeatCount:int (default = 0) |
Throws
Error — if the delay specified is negative or not a finite number
|
reset | () | method |
public function reset():void| Runtime Versions: | AIR 1.0, |
Stops the timer, if it is running, and sets the currentCount property back to 0,
like the reset button of a stopwatch. Then, when start() is called,
the timer instance runs for the specified number of repetitions,
as set by the repeatCount value.
See also
start | () | method |
public function start():void| Runtime Versions: | AIR 1.0, |
Starts the timer, if it is not already running.
stop | () | method |
public function stop():void| Runtime Versions: | AIR 1.0, |
Stops the timer. When start() is called after stop(), the timer
instance runs for the remaining number of repetitions, as set by the repeatCount property.
See also
timer | Event |
flash.events.TimerEventproperty TimerEvent.type =
flash.events.TimerEvent.TIMER| Runtime Versions: | AIR 1.0, |
Dispatched whenever a Timer object reaches an interval specified according to the Timer.delay property.
type property of a timer event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
target | The Timer object that has reached its interval. |
timerComplete | Event |
flash.events.TimerEventproperty TimerEvent.type =
flash.events.TimerEvent.TIMER_COMPLETE| Runtime Versions: | AIR 1.0, |
Dispatched whenever it has completed the number of requests set by Timer.repeatCount.
type property of a timerComplete event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
target | The Timer object that has completed its requests. |
Thu Sep 29 2011, 02:34 AM -07:00