Adobe InDesign CS6 Server (8.0) Object Model JS: GotoPageBehavior

InDesign Server CS6

Class

GotoPageBehavior

 A behavior object that jumps to a specific page of the document. Base Class: Behavior

QuickLinks

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

Hierarchy

Button
Behavior
GotoPageBehavior
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 EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the GotoPageBehavior.
indexnumber readonlyThe index of the GotoPageBehavior 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 GotoPageBehavior.
pageNumbernumber r/wThe page number to go to expressed as an index where 1 is the first page.
parentButton readonlyThe parent of the GotoPageBehavior (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 GotoPageBehavior 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 GotoPageBehavior.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

GotoPageBehavior GotoPageBehaviors.nextItem (obj: GotoPageBehavior)

GotoPageBehavior GotoPageBehaviors.previousItem (obj: GotoPageBehavior)

Return

Array of GotoPageBehavior GotoPageBehavior.getElements ()

GotoPageBehavior GotoPageBehaviors.[] (index: number)

GotoPageBehavior GotoPageBehaviors.add ([withProperties: Object])

GotoPageBehavior GotoPageBehaviors.anyItem ()

Array of GotoPageBehavior GotoPageBehaviors.everyItem ()

GotoPageBehavior GotoPageBehaviors.firstItem ()

GotoPageBehavior GotoPageBehaviors.item (index: varies)

GotoPageBehavior GotoPageBehaviors.itemByID (id: number)

GotoPageBehavior GotoPageBehaviors.itemByName (name: string)

Array of GotoPageBehavior GotoPageBehaviors.itemByRange (from: varies, to: varies)

GotoPageBehavior GotoPageBehaviors.lastItem ()

GotoPageBehavior GotoPageBehaviors.middleItem ()

GotoPageBehavior GotoPageBehaviors.nextItem (obj: GotoPageBehavior)

GotoPageBehavior GotoPageBehaviors.previousItem (obj: GotoPageBehavior)

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