Adobe InCopy CS6 (8.0) Object Model JS: NavigationPoint

InCopy CS6

Class

NavigationPoint

 A navigation point.

QuickLinks

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Movie
NavigationPoint
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyUnique internally-generated identifier (read only).
indexnumber readonlyThe index of the NavigationPoint within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring r/wThe UI display name.
parentMovie readonlyThe parent of the NavigationPoint (a Movie).
propertiesObject r/wA property that allows setting of several properties at the same time.
timenumber r/wThe time in seconds rounded up to two decimal places (e.g., 3.115 rounded to 3.12).

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

void remove ()
Deletes the NavigationPoint.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

NavigationPoint NavigationPoints.nextItem (obj: NavigationPoint)

NavigationPoint NavigationPoints.previousItem (obj: NavigationPoint)

Return

Array of NavigationPoint NavigationPoint.getElements ()

NavigationPoint NavigationPoints.[] (index: number)

NavigationPoint NavigationPoints.add ([withProperties: Object])

NavigationPoint NavigationPoints.anyItem ()

Array of NavigationPoint NavigationPoints.everyItem ()

NavigationPoint NavigationPoints.firstItem ()

NavigationPoint NavigationPoints.item (index: varies)

NavigationPoint NavigationPoints.itemByID (id: number)

NavigationPoint NavigationPoints.itemByName (name: string)

Array of NavigationPoint NavigationPoints.itemByRange (from: varies, to: varies)

NavigationPoint NavigationPoints.lastItem ()

NavigationPoint NavigationPoints.middleItem ()

NavigationPoint NavigationPoints.nextItem (obj: NavigationPoint)

NavigationPoint NavigationPoints.previousItem (obj: NavigationPoint)

Jongware, 29-Apr-2012 v3.0.3iContents :: Index