Packagecom.adobe.indesign
Classpublic class IdleTask
InheritanceIdleTask Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  eventListeners : EventListeners
[read-only] A collection of event listeners.
IdleTask
  events : Events
[read-only] A collection of events.
IdleTask
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the IdleTask.
IdleTask
  index : Number
[read-only] The index of the IdleTask within its containing object.
IdleTask
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
IdleTask
  label : String
A property that can be set to any string.
IdleTask
  name : String
The name of the IdleTask.
IdleTask
  ON_IDLE : String
[static] [read-only] Dispatched at idle time for this IdleTask.
IdleTask
  parent : Application
[read-only] The parent of the IdleTask (a Application).
IdleTask
  properties : Object
A property that allows setting of several properties at the same time.
IdleTask
  sleep : Number
Amount of time to sleep (in milliseconds) before calling this task again.
IdleTask
Public Methods
 MethodDefined By
  
addEventListenerIdleTask(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
IdleTask
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
IdleTask
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
Resolves the object specifier, creating an array of object references.
IdleTask
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
IdleTask
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
remove():void
Deletes the IdleTask.
IdleTask
  
removeEventListenerIdleTask(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
IdleTask
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
IdleTask
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
eventListenersproperty
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
idproperty 
id:Number  [read-only]

The unique ID of the IdleTask.


Implementation
    public function get id():Number
indexproperty 
index:Number  [read-only]

The index of the IdleTask within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
nameproperty 
name:String

The name of the IdleTask.


Implementation
    public function get name():String
    public function set name(value:String):void
ON_IDLEproperty 
ON_IDLE:String  [read-only]

Dispatched at idle time for this IdleTask. This event does not bubble. This event is not cancelable.


Implementation
    public static function get ON_IDLE():String
parentproperty 
parent:Application  [read-only]

The parent of the IdleTask (a Application).


Implementation
    public function get parent():Application
propertiesproperty 
properties:Object

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
sleepproperty 
sleep:Number

Amount of time to sleep (in milliseconds) before calling this task again. Setting this to zero will cause task to be deleted.


Implementation
    public function get sleep():Number
    public function set sleep(value:Number):void
Method Detail
addEventListenerIdleTask()method
public function addEventListenerIdleTask(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
getElements()method 
public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

Sets the label to the value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

remove()method 
public function remove():void

Deletes the IdleTask.

removeEventListenerIdleTask()method 
public function removeEventListenerIdleTask(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String