IdleTask
An attachable idle task.
Class
Read Only
String ON_IDLE = onIdle
Dispatched at idle time for this IdleTask. This event does not bubble. This event is not cancelable.
Instance
Read Only
Number id
The unique ID of the IdleTask.
Read Only
Boolean isValid
Returns true if the object specifier resolves to valid objects.
Read Only
Application parent
The parent of the IdleTask (a Application).
Read Only
Number index
The index of the IdleTask within its containing object.
Read Only
Events events
A collection of events.
Read Only
EventListeners eventListeners
A collection of event listeners.
String name
The name of the IdleTask.
Number sleep
Amount of time to sleep (in milliseconds) before calling this task again. Setting this to zero will cause task to be deleted.
String label
A property that can be set to any string.
Object properties
A property that allows setting of several properties at the same time.
Methods
remove()
Deletes the IdleTask.
insertLabel( String key, String value )
Sets the label to the value associated with the specified key.
Parameters
Type Name Description String key The key. String value The value.
String extractLabel( String key )
Gets the label value associated with the specified key.
Parameters
Type Name Description String key The key.
String toSource()
Generates a string which, if executed, will return the IdleTask.
IdleTask getElements()
Resolves the object specifier, creating an array of object references.
String toSpecifier()
Retrieves the object specifier.
EventListener addEventListener( String eventType, Mixed handler, Boolean captures )
Adds an event listener.
Parameters
Type Name Description String eventType The event type. Mixed handler The event handler. Can accept: File or JavaScript Function. Boolean captures This parameter is obsolete. (Optional)
Boolean removeEventListener( String eventType, Mixed handler, Boolean captures )
Removes the event listener.
Parameters
Type Name Description String eventType The registered event type. Mixed handler The registered event handler. Can accept: File or JavaScript Function. Boolean captures This parameter is obsolete. (Optional)