Adobe InCopy CS5 (7.0) Object Model JS: IdleTask

InCopy CS5

Class

IdleTask

 An attachable idle task.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application
IdleTask
Event | EventListener | IdleEvent | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the IdleTask.
indexnumber readonlyThe index of the IdleTask within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the IdleTask.
parentApplication readonlyThe parent of the IdleTask (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
sleepnumber r/wAmount of time to sleep (in milliseconds) before calling this task again. Setting this to zero will cause task to be deleted.

Class

PropertyTypeAccessDescription
ON_IDLEstring readonlyDispatched at idle time for this IdleTask. This event does not bubble. This event is not cancelable. (default: onIdle)

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of IdleTask getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the IdleTask.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the IdleTask.

string toSpecifier ()
Retrieves the object specifier.

Element of

IdleEvent.parent

Used in:

IdleTask IdleTasks.nextItem (obj: IdleTask)

IdleTask IdleTasks.previousItem (obj: IdleTask)

Return

Array of IdleTask IdleTask.getElements ()

IdleTask IdleTasks.[] (index: number)

IdleTask IdleTasks.add ([withProperties: Object])

IdleTask IdleTasks.anyItem ()

Array of IdleTask IdleTasks.everyItem ()

IdleTask IdleTasks.firstItem ()

IdleTask IdleTasks.item (index: varies)

IdleTask IdleTasks.itemByID (id: number)

IdleTask IdleTasks.itemByName (name: string)

Array of IdleTask IdleTasks.itemByRange (from: varies, to: varies)

IdleTask IdleTasks.lastItem ()

IdleTask IdleTasks.middleItem ()

IdleTask IdleTasks.nextItem (obj: IdleTask)

IdleTask IdleTasks.previousItem (obj: IdleTask)

Jongware, 23-Mar-2011 v3.0.3dContents :: Index