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

InDesign Server CS5.5

Class

GotoPreviousStateBehavior

 A goto previous state behavior. Base Class: Behavior

QuickLinks

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

Hierarchy

Button
Behavior
GotoPreviousStateBehavior
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
associatedMultiStateObjectMultiStateObject r/wThe associated multi-state object page item.
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 GotoPreviousStateBehavior.
indexnumber readonlyThe index of the GotoPreviousStateBehavior 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.
loopsToNextOrPreviousbool r/wIf true, will loop to the next or previous state.
namestring readonlyThe name of the GotoPreviousStateBehavior.
parentButton readonlyThe parent of the GotoPreviousStateBehavior (a Button).
propertiesObject r/wA property that allows setting of several properties at the same time.

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

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

GotoPreviousStateBehavior GotoPreviousStateBehaviors.nextItem (obj: GotoPreviousStateBehavior)

GotoPreviousStateBehavior GotoPreviousStateBehaviors.previousItem (obj: GotoPreviousStateBehavior)

Return

Array of GotoPreviousStateBehavior GotoPreviousStateBehavior.getElements ()

GotoPreviousStateBehavior GotoPreviousStateBehaviors.[] (index: number)

GotoPreviousStateBehavior GotoPreviousStateBehaviors.add ([withProperties: Object])

GotoPreviousStateBehavior GotoPreviousStateBehaviors.anyItem ()

Array of GotoPreviousStateBehavior GotoPreviousStateBehaviors.everyItem ()

GotoPreviousStateBehavior GotoPreviousStateBehaviors.firstItem ()

GotoPreviousStateBehavior GotoPreviousStateBehaviors.item (index: varies)

GotoPreviousStateBehavior GotoPreviousStateBehaviors.itemByID (id: number)

GotoPreviousStateBehavior GotoPreviousStateBehaviors.itemByName (name: string)

Array of GotoPreviousStateBehavior GotoPreviousStateBehaviors.itemByRange (from: varies, to: varies)

GotoPreviousStateBehavior GotoPreviousStateBehaviors.lastItem ()

GotoPreviousStateBehavior GotoPreviousStateBehaviors.middleItem ()

GotoPreviousStateBehavior GotoPreviousStateBehaviors.nextItem (obj: GotoPreviousStateBehavior)

GotoPreviousStateBehavior GotoPreviousStateBehaviors.previousItem (obj: GotoPreviousStateBehavior)

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