Adobe InCopy CS5 (7.0) Object Model JS: GotoPreviousPageBehavior

InCopy CS5

Class

GotoPreviousPageBehavior

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

QuickLinks

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

Hierarchy

Button
Behavior
GotoPreviousPageBehavior
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
behaviorEventBehaviorEvents:
BehaviorEvents.MOUSE_UP
BehaviorEvents.MOUSE_DOWN
BehaviorEvents.MOUSE_ENTER
BehaviorEvents.MOUSE_EXIT
BehaviorEvents.ON_FOCUS
BehaviorEvents.ON_BLUR
readonlyThe event which triggers the behavior.
enableBehaviorbool readonlyIf true, the behavior is enabled.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the GotoPreviousPageBehavior.
indexnumber readonlyThe index of the GotoPreviousPageBehavior 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 GotoPreviousPageBehavior.
parentButton readonlyThe parent of the GotoPreviousPageBehavior (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
readonlyThe 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 GotoPreviousPageBehavior 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.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

GotoPreviousPageBehavior GotoPreviousPageBehaviors.nextItem (obj: GotoPreviousPageBehavior)

GotoPreviousPageBehavior GotoPreviousPageBehaviors.previousItem (obj: GotoPreviousPageBehavior)

Return

Array of GotoPreviousPageBehavior GotoPreviousPageBehavior.getElements ()

GotoPreviousPageBehavior GotoPreviousPageBehaviors.[] (index: number)

GotoPreviousPageBehavior GotoPreviousPageBehaviors.anyItem ()

Array of GotoPreviousPageBehavior GotoPreviousPageBehaviors.everyItem ()

GotoPreviousPageBehavior GotoPreviousPageBehaviors.firstItem ()

GotoPreviousPageBehavior GotoPreviousPageBehaviors.item (index: varies)

GotoPreviousPageBehavior GotoPreviousPageBehaviors.itemByID (id: number)

GotoPreviousPageBehavior GotoPreviousPageBehaviors.itemByName (name: string)

Array of GotoPreviousPageBehavior GotoPreviousPageBehaviors.itemByRange (from: varies, to: varies)

GotoPreviousPageBehavior GotoPreviousPageBehaviors.lastItem ()

GotoPreviousPageBehavior GotoPreviousPageBehaviors.middleItem ()

GotoPreviousPageBehavior GotoPreviousPageBehaviors.nextItem (obj: GotoPreviousPageBehavior)

GotoPreviousPageBehavior GotoPreviousPageBehaviors.previousItem (obj: GotoPreviousPageBehavior)

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