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

InDesign Server CS5

Class

TimingGroup

 a timing group.

QuickLinks

addEventListener, getElements, move, remove, removeEventListener, toSource, toSpecifier, unlink

Hierarchy

TimingList
TimingGroup
Event | EventListener | MutationEvent | TimingTarget

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
indexnumber readonlyThe index of the TimingGroup within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentTimingList readonlyThe parent of the TimingGroup (a TimingList).
placementnumber r/wThe placement of the timing group in the timing list.
playsnumber (range: 1 - 100) r/wThe number of times this timing group plays.
playsLoopbool r/wSet to true if timing group loops.
propertiesObject r/wA property that allows setting of several properties at the same time.
timingTargetsTimingTargets readonlyA collection of timing target.

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 TimingGroup getElements ()
Resolves the object specifier, creating an array of object references.

TimingGroup move (to: LocationOptions[, reference: varies])
Moves the timing group or target to the specified location.

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location in relation to the reference object or within the containing object.
referenceTimingGroup
TimingList
TimingTarget
The reference object. Note: Required when the to parameter specifies before or after. . Can accept: TimingGroup, TimingTarget or TimingList. (Optional)

void remove ()
Deletes the TimingGroup.

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

string toSpecifier ()
Retrieves the object specifier.

void unlink ()
Unlink all targets in the group into separate groups in this timing list.

Element of

TimingTarget.parent

Used in:

TimingGroup TimingGroups.nextItem (obj: TimingGroup)

TimingGroup TimingGroups.previousItem (obj: TimingGroup)

Return

Array of TimingGroup TimingGroup.getElements ()

TimingGroup TimingGroup.move (to: LocationOptions[, reference: varies])

TimingGroup TimingGroups.[] (index: number)

TimingGroup TimingGroups.add (dynamicTarget: varies[, delaySeconds: number=0][, withProperties: Object])

TimingGroup TimingGroups.anyItem ()

Array of TimingGroup TimingGroups.everyItem ()

TimingGroup TimingGroups.firstItem ()

TimingGroup TimingGroups.item (index: varies)

Array of TimingGroup TimingGroups.itemByRange (from: varies, to: varies)

TimingGroup TimingGroups.lastItem ()

TimingGroup TimingGroups.middleItem ()

TimingGroup TimingGroups.nextItem (obj: TimingGroup)

TimingGroup TimingGroups.previousItem (obj: TimingGroup)

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