Adobe InDesign CS5.5 Server (7.5) Object Model JS: GotoFirstPageBehavior

InDesign Server CS5.5

Class

GotoFirstPageBehavior

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

QuickLinks

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

Hierarchy

Button
Behavior
GotoFirstPageBehavior
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 GotoFirstPageBehavior.
indexnumber readonlyThe index of the GotoFirstPageBehavior 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 GotoFirstPageBehavior.
parentButton readonlyThe parent of the GotoFirstPageBehavior (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 GotoFirstPageBehavior 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 GotoFirstPageBehavior.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

GotoFirstPageBehavior GotoFirstPageBehaviors.nextItem (obj: GotoFirstPageBehavior)

GotoFirstPageBehavior GotoFirstPageBehaviors.previousItem (obj: GotoFirstPageBehavior)

Return

Array of GotoFirstPageBehavior GotoFirstPageBehavior.getElements ()

GotoFirstPageBehavior GotoFirstPageBehaviors.[] (index: number)

GotoFirstPageBehavior GotoFirstPageBehaviors.add ([withProperties: Object])

GotoFirstPageBehavior GotoFirstPageBehaviors.anyItem ()

Array of GotoFirstPageBehavior GotoFirstPageBehaviors.everyItem ()

GotoFirstPageBehavior GotoFirstPageBehaviors.firstItem ()

GotoFirstPageBehavior GotoFirstPageBehaviors.item (index: varies)

GotoFirstPageBehavior GotoFirstPageBehaviors.itemByID (id: number)

GotoFirstPageBehavior GotoFirstPageBehaviors.itemByName (name: string)

Array of GotoFirstPageBehavior GotoFirstPageBehaviors.itemByRange (from: varies, to: varies)

GotoFirstPageBehavior GotoFirstPageBehaviors.lastItem ()

GotoFirstPageBehavior GotoFirstPageBehaviors.middleItem ()

GotoFirstPageBehavior GotoFirstPageBehaviors.nextItem (obj: GotoFirstPageBehavior)

GotoFirstPageBehavior GotoFirstPageBehaviors.previousItem (obj: GotoFirstPageBehavior)

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