Adobe InDesign CS5 Server (7.0) Object Model JS: Behavior

InDesign Server CS5

Class

Behavior

 

A behavior object.

Superclass of AnimationBehavior, GotoAnchorBehavior, GotoFirstPageBehavior, GotoLastPageBehavior, GotoNextPageBehavior, GotoNextStateBehavior, GotoNextViewBehavior, GotoPageBehavior, GotoPreviousPageBehavior, GotoPreviousStateBehavior, GotoPreviousViewBehavior, GotoStateBehavior, GotoURLBehavior, MovieBehavior, OpenFileBehavior, ShowHideFieldsBehavior, SoundBehavior, and ViewZoomBehavior

QuickLinks

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

Hierarchy

Button
Behavior
AnimationBehavior | GotoAnchorBehavior | GotoFirstPageBehavior | GotoLastPageBehavior | GotoNextPageBehavior | GotoNextStateBehavior | GotoNextViewBehavior | GotoPageBehavior | GotoPreviousPageBehavior | GotoPreviousStateBehavior | GotoPreviousViewBehavior | GotoStateBehavior | GotoURLBehavior | MovieBehavior | OpenFileBehavior | ShowHideFieldsBehavior | SoundBehavior | ViewZoomBehavior
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 readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the Behavior.
indexnumber readonlyThe index of the Behavior 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 Behavior.
parentButton readonlyThe parent of the Behavior (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 Behavior 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 Behavior.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

TimingTarget.dynamicTarget

Used in:

Behavior Behaviors.nextItem (obj: Behavior)

Behavior Behaviors.previousItem (obj: Behavior)

Return

Array of Behavior Behavior.getElements ()

Behavior Behaviors.[] (index: number)

Behavior Behaviors.anyItem ()

Array of Behavior Behaviors.everyItem ()

Behavior Behaviors.firstItem ()

Behavior Behaviors.item (index: varies)

Behavior Behaviors.itemByID (id: number)

Behavior Behaviors.itemByName (name: string)

Array of Behavior Behaviors.itemByRange (from: varies, to: varies)

Behavior Behaviors.lastItem ()

Behavior Behaviors.middleItem ()

Behavior Behaviors.nextItem (obj: Behavior)

Behavior Behaviors.previousItem (obj: Behavior)

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