Adobe InCopy CS5.5 (7.5) Object Model JS: SoundBehavior

InCopy CS5.5

Class

SoundBehavior

 A sound behavior object. Base Class: Behavior

QuickLinks

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

Hierarchy

Button
Behavior
SoundBehavior
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
behaviorEventBehaviorEvents:
BehaviorEvents.MOUSE_UP
BehaviorEvents.MOUSE_DOWN
BehaviorEvents.MOUSE_ENTER
BehaviorEvents.MOUSE_EXIT
BehaviorEvents.ON_FOCUS
BehaviorEvents.ON_BLUR
readonlyThe event which triggers the behavior.
enableBehaviorbool readonlyIf true, the behavior is enabled.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the SoundBehavior.
indexnumber readonlyThe index of the SoundBehavior 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 SoundBehavior.
operationPlayOperations:
PlayOperations.PLAY
PlayOperations.STOP
PlayOperations.PAUSE
PlayOperations.RESUME
PlayOperations.STOP_ALL
readonlyThe playback mode.
parentButton readonlyThe parent of the SoundBehavior (a Button).
propertiesObject r/wA property that allows setting of several properties at the same time.
soundItemSound readonlyThe sound page item.

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

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

SoundBehavior SoundBehaviors.nextItem (obj: SoundBehavior)

SoundBehavior SoundBehaviors.previousItem (obj: SoundBehavior)

Return

Array of SoundBehavior SoundBehavior.getElements ()

SoundBehavior SoundBehaviors.[] (index: number)

SoundBehavior SoundBehaviors.anyItem ()

Array of SoundBehavior SoundBehaviors.everyItem ()

SoundBehavior SoundBehaviors.firstItem ()

SoundBehavior SoundBehaviors.item (index: varies)

SoundBehavior SoundBehaviors.itemByID (id: number)

SoundBehavior SoundBehaviors.itemByName (name: string)

Array of SoundBehavior SoundBehaviors.itemByRange (from: varies, to: varies)

SoundBehavior SoundBehaviors.lastItem ()

SoundBehavior SoundBehaviors.middleItem ()

SoundBehavior SoundBehaviors.nextItem (obj: SoundBehavior)

SoundBehavior SoundBehaviors.previousItem (obj: SoundBehavior)

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