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

InDesign Server CS5

Class

MovieBehavior

 A movie behavior object. Base Class: Behavior

QuickLinks

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

Hierarchy

Button
Behavior
MovieBehavior
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 MovieBehavior.
indexnumber readonlyThe index of the MovieBehavior 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.
movieItemMovie r/wThe movie page item.
namestring readonlyThe name of the MovieBehavior.
navigationPointIDnumber r/wThe id of the navigation point to play from. This property is ignored for all operations other than Play From Navigation Point.
operationMoviePlayOperations:
MoviePlayOperations.PLAY
MoviePlayOperations.PLAY_FROM_NAVIGATION_POINT
MoviePlayOperations.STOP
MoviePlayOperations.PAUSE
MoviePlayOperations.RESUME
MoviePlayOperations.STOP_ALL
r/wThe playback mode.
parentButton readonlyThe parent of the MovieBehavior (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 MovieBehavior 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 MovieBehavior.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

MovieBehavior MovieBehaviors.nextItem (obj: MovieBehavior)

MovieBehavior MovieBehaviors.previousItem (obj: MovieBehavior)

Return

Array of MovieBehavior MovieBehavior.getElements ()

MovieBehavior MovieBehaviors.[] (index: number)

MovieBehavior MovieBehaviors.add ([withProperties: Object])

MovieBehavior MovieBehaviors.anyItem ()

Array of MovieBehavior MovieBehaviors.everyItem ()

MovieBehavior MovieBehaviors.firstItem ()

MovieBehavior MovieBehaviors.item (index: varies)

MovieBehavior MovieBehaviors.itemByID (id: number)

MovieBehavior MovieBehaviors.itemByName (name: string)

Array of MovieBehavior MovieBehaviors.itemByRange (from: varies, to: varies)

MovieBehavior MovieBehaviors.lastItem ()

MovieBehavior MovieBehaviors.middleItem ()

MovieBehavior MovieBehaviors.nextItem (obj: MovieBehavior)

MovieBehavior MovieBehaviors.previousItem (obj: MovieBehavior)

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