| Package | flare.animate |
| Class | public class Scheduler |
By default, the Scheduler issues updates to all scheduled items each
time the Flash Player advances to the next frame, as reported by the
Event.ENTER_FRAME event. To instead set the update interval
manually, see the timerInterval property.
| Property | Defined by | ||
|---|---|---|---|
| instance : Scheduler
[static][read-only] The default Scheduler instance.
| Scheduler | ||
| timerInterval : Number
Sets the timer interval (in milliseconds) at which the scheduler
should process events.
| Scheduler | ||
| Method | Defined by | ||
|---|---|---|---|
|
Scheduler(lock:Class)
Creates a new Scheduler--this constructor should be not used;
instead use the
instance property. | Scheduler | ||
|
add(item:ISchedulable):void
Adds an object to the scheduling list.
| Scheduler | ||
|
cancel(id:String):Boolean
Cancels any scheduled object with a matching id.
| Scheduler | ||
|
isScheduled(id:String):Boolean
Indicates if an object with the given id is currently in the
scheduler queue.
| Scheduler | ||
|
lookup(id:String):ISchedulable
Looks up the scheduled object indicated by the given id, if any.
| Scheduler | ||
|
remove(item:ISchedulable):Boolean
Removes an object from the scheduling list.
| Scheduler | ||
|
tick(event:Event):void
Frame/timer callback that invokes each scheduled object.
| Scheduler | ||
| instance | property |
instance:Scheduler [read-only]The default Scheduler instance.
Implementation public static function get instance():Scheduler
| timerInterval | property |
timerInterval:Number [read-write]
Sets the timer interval (in milliseconds) at which the scheduler
should process events. If this value is greater than zero, a
Timer instance will be used to trigger scheduler
updates at the given interval. If this value is less than or equal
to zero (the default), scheduler updates will be issued with each
time the Flash Player advances to the next frame according to the
Event.ENTER_FRAME event.
public function get timerInterval():Number
public function set timerInterval(value:Number):void
| Scheduler | () | constructor |
public function Scheduler(lock:Class)
Creates a new Scheduler--this constructor should be not used;
instead use the instance property.
lock:Class — a lock object to emulate a private constructor
|
| add | () | method |
public function add(item:ISchedulable):voidAdds an object to the scheduling list.
Parametersitem:ISchedulable — a schedulable object to add
|
| cancel | () | method |
public function cancel(id:String):BooleanCancels any scheduled object with a matching id.
Parametersid:String — the id to cancel
|
Boolean — true if an object was found and cancelled, false otherwise
|
| isScheduled | () | method |
public function isScheduled(id:String):BooleanIndicates if an object with the given id is currently in the scheduler queue.
Parametersid:String — the id to check for
|
Boolean — true if an object with that id is currently scheduled,
false otherwise
|
| lookup | () | method |
public function lookup(id:String):ISchedulableLooks up the scheduled object indicated by the given id, if any.
Parametersid:String — the id to lookup
|
ISchedulable —
the scheduled object with matching id, of null if none
|
| remove | () | method |
public function remove(item:ISchedulable):BooleanRemoves an object from the scheduling list.
Parametersitem:ISchedulable — the object to remove
|
Boolean — true if the object was found and removed, false otherwise
|
| tick | () | method |
public function tick(event:Event):voidFrame/timer callback that invokes each scheduled object.
Parametersevent:Event — the event that triggered the callback
|