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

InDesign CS5.5

Class

GotoNextStateBehavior

 A goto next state behavior. Base Class: Behavior

QuickLinks

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

Hierarchy

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

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

GotoNextStateBehavior GotoNextStateBehaviors.nextItem (obj: GotoNextStateBehavior)

GotoNextStateBehavior GotoNextStateBehaviors.previousItem (obj: GotoNextStateBehavior)

Return

Array of GotoNextStateBehavior GotoNextStateBehavior.getElements ()

GotoNextStateBehavior GotoNextStateBehaviors.[] (index: number)

GotoNextStateBehavior GotoNextStateBehaviors.add ([withProperties: Object])

GotoNextStateBehavior GotoNextStateBehaviors.anyItem ()

Array of GotoNextStateBehavior GotoNextStateBehaviors.everyItem ()

GotoNextStateBehavior GotoNextStateBehaviors.firstItem ()

GotoNextStateBehavior GotoNextStateBehaviors.item (index: varies)

GotoNextStateBehavior GotoNextStateBehaviors.itemByID (id: number)

GotoNextStateBehavior GotoNextStateBehaviors.itemByName (name: string)

Array of GotoNextStateBehavior GotoNextStateBehaviors.itemByRange (from: varies, to: varies)

GotoNextStateBehavior GotoNextStateBehaviors.lastItem ()

GotoNextStateBehavior GotoNextStateBehaviors.middleItem ()

GotoNextStateBehavior GotoNextStateBehaviors.nextItem (obj: GotoNextStateBehavior)

GotoNextStateBehavior GotoNextStateBehaviors.previousItem (obj: GotoNextStateBehavior)

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