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

InDesign Server CS5

Class

GotoNextPageBehavior

 A behavior object that jumps to the next page in the document. Base Class: Behavior

QuickLinks

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

Hierarchy

Button
Behavior
GotoNextPageBehavior
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
behaviorEventBehaviorEvents:
BehaviorEvents.MOUSE_UP
BehaviorEvents.MOUSE_DOWN
BehaviorEvents.MOUSE_ENTER
BehaviorEvents.MOUSE_EXIT
BehaviorEvents.ON_FOCUS
BehaviorEvents.ON_BLUR
r/wThe event which triggers the behavior.
enableBehaviorbool r/wIf true, the behavior is enabled.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the GotoNextPageBehavior.
indexnumber readonlyThe index of the GotoNextPageBehavior 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 readonlyThe name of the GotoNextPageBehavior.
parentButton readonlyThe parent of the GotoNextPageBehavior (a Button).
propertiesObject r/wA property that allows setting of several properties at the same time.
zoomSettingGoToZoomOptions:
GoToZoomOptions.INHERIT_ZOOM
GoToZoomOptions.FIT_WINDOW
GoToZoomOptions.FIT_WIDTH
GoToZoomOptions.FIT_VISIBLE
GoToZoomOptions.ACTUAL_SIZE
r/wThe zoom setting.

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

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

GotoNextPageBehavior GotoNextPageBehaviors.nextItem (obj: GotoNextPageBehavior)

GotoNextPageBehavior GotoNextPageBehaviors.previousItem (obj: GotoNextPageBehavior)

Return

Array of GotoNextPageBehavior GotoNextPageBehavior.getElements ()

GotoNextPageBehavior GotoNextPageBehaviors.[] (index: number)

GotoNextPageBehavior GotoNextPageBehaviors.add ([withProperties: Object])

GotoNextPageBehavior GotoNextPageBehaviors.anyItem ()

Array of GotoNextPageBehavior GotoNextPageBehaviors.everyItem ()

GotoNextPageBehavior GotoNextPageBehaviors.firstItem ()

GotoNextPageBehavior GotoNextPageBehaviors.item (index: varies)

GotoNextPageBehavior GotoNextPageBehaviors.itemByID (id: number)

GotoNextPageBehavior GotoNextPageBehaviors.itemByName (name: string)

Array of GotoNextPageBehavior GotoNextPageBehaviors.itemByRange (from: varies, to: varies)

GotoNextPageBehavior GotoNextPageBehaviors.lastItem ()

GotoNextPageBehavior GotoNextPageBehaviors.middleItem ()

GotoNextPageBehavior GotoNextPageBehaviors.nextItem (obj: GotoNextPageBehavior)

GotoNextPageBehavior GotoNextPageBehaviors.previousItem (obj: GotoNextPageBehavior)

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