Adobe InDesign CS6 (8.0) Object Model JS: AnimationBehavior

InDesign CS6

Class

AnimationBehavior

 A animation behavior. Base Class: Behavior

QuickLinks

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

Hierarchy

Button
Behavior
AnimationBehavior
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
animatedPageItemPageItem r/wThe animation page item.
autoReverseOnRollOffbool r/wIf true, will automatically play the animation in reverse on roll off of the rollover event.
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 AnimationBehavior.
indexnumber readonlyThe index of the AnimationBehavior 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 AnimationBehavior.
operationAnimationPlayOperations:
AnimationPlayOperations.PLAY
AnimationPlayOperations.STOP
AnimationPlayOperations.PAUSE
AnimationPlayOperations.RESUME
AnimationPlayOperations.REVERSE_PLAYBACK
AnimationPlayOperations.STOP_ALL
r/wThe playback mode.
parentButton readonlyThe parent of the AnimationBehavior (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 AnimationBehavior 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 AnimationBehavior.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

AnimationBehavior AnimationBehaviors.nextItem (obj: AnimationBehavior)

AnimationBehavior AnimationBehaviors.previousItem (obj: AnimationBehavior)

Return

Array of AnimationBehavior AnimationBehavior.getElements ()

AnimationBehavior AnimationBehaviors.[] (index: number)

AnimationBehavior AnimationBehaviors.add ([withProperties: Object])

AnimationBehavior AnimationBehaviors.anyItem ()

Array of AnimationBehavior AnimationBehaviors.everyItem ()

AnimationBehavior AnimationBehaviors.firstItem ()

AnimationBehavior AnimationBehaviors.item (index: varies)

AnimationBehavior AnimationBehaviors.itemByID (id: number)

AnimationBehavior AnimationBehaviors.itemByName (name: string)

Array of AnimationBehavior AnimationBehaviors.itemByRange (from: varies, to: varies)

AnimationBehavior AnimationBehaviors.lastItem ()

AnimationBehavior AnimationBehaviors.middleItem ()

AnimationBehavior AnimationBehaviors.nextItem (obj: AnimationBehavior)

AnimationBehavior AnimationBehaviors.previousItem (obj: AnimationBehavior)

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