Adobe InDesign CS5 Server (7.0) Object Model JS: TimingList

InDesign Server CS5

Class

TimingList

 a timing list.

QuickLinks

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

TimingSetting
TimingList
Event | EventListener | MutationEvent | TimingGroup

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
indexnumber readonlyThe index of the TimingList within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentTimingSetting readonlyThe parent of the TimingList (a TimingSetting).
propertiesObject r/wA property that allows setting of several properties at the same time.
timingGroupsTimingGroups readonlyA collection of timing data objects.
triggerEventDynamicTriggerEvents:
DynamicTriggerEvents.ON_PAGE_LOAD
DynamicTriggerEvents.ON_PAGE_CLICK
DynamicTriggerEvents.ON_STATE_LOAD
DynamicTriggerEvents.ON_CLICK
DynamicTriggerEvents.ON_ROLLOVER
DynamicTriggerEvents.ON_RELEASE
DynamicTriggerEvents.ON_ROLLOFF
DynamicTriggerEvents.ON_SELF_CLICK
DynamicTriggerEvents.ON_SELF_ROLLOVER
readonlytrigger event.

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)

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

void remove ()
Deletes the TimingList.

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 TimingList.

string toSpecifier ()
Retrieves the object specifier.

Element of

TimingGroup.parent

Used in:

TimingList TimingLists.nextItem (obj: TimingList)

TimingList TimingLists.previousItem (obj: TimingList)

Return

Array of TimingList TimingList.getElements ()

TimingList TimingLists.[] (index: number)

TimingList TimingLists.add (triggerEvent: DynamicTriggerEvents[, withProperties: Object])

TimingList TimingLists.anyItem ()

Array of TimingList TimingLists.everyItem ()

TimingList TimingLists.firstItem ()

TimingList TimingLists.item (index: varies)

Array of TimingList TimingLists.itemByRange (from: varies, to: varies)

TimingList TimingLists.lastItem ()

TimingList TimingLists.middleItem ()

TimingList TimingLists.nextItem (obj: TimingList)

TimingList TimingLists.previousItem (obj: TimingList)

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