Adobe InDesign CS5 (7.0) Object Model JS: OpenFileBehavior

InDesign CS5

Class

OpenFileBehavior

 An open file behavior object. Base Class: Behavior

QuickLinks

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

Hierarchy

Button
Behavior
OpenFileBehavior
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.
filePathFile
string
r/wThe file path (colon delimited on the Mac OS). Can also accept: File.
idnumber readonlyThe unique ID of the OpenFileBehavior.
indexnumber readonlyThe index of the OpenFileBehavior 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 OpenFileBehavior.
parentButton readonlyThe parent of the OpenFileBehavior (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 OpenFileBehavior 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 OpenFileBehavior.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

OpenFileBehavior OpenFileBehaviors.nextItem (obj: OpenFileBehavior)

OpenFileBehavior OpenFileBehaviors.previousItem (obj: OpenFileBehavior)

Return

Array of OpenFileBehavior OpenFileBehavior.getElements ()

OpenFileBehavior OpenFileBehaviors.[] (index: number)

OpenFileBehavior OpenFileBehaviors.add ([withProperties: Object])

OpenFileBehavior OpenFileBehaviors.anyItem ()

Array of OpenFileBehavior OpenFileBehaviors.everyItem ()

OpenFileBehavior OpenFileBehaviors.firstItem ()

OpenFileBehavior OpenFileBehaviors.item (index: varies)

OpenFileBehavior OpenFileBehaviors.itemByID (id: number)

OpenFileBehavior OpenFileBehaviors.itemByName (name: string)

Array of OpenFileBehavior OpenFileBehaviors.itemByRange (from: varies, to: varies)

OpenFileBehavior OpenFileBehaviors.lastItem ()

OpenFileBehavior OpenFileBehaviors.middleItem ()

OpenFileBehavior OpenFileBehaviors.nextItem (obj: OpenFileBehavior)

OpenFileBehavior OpenFileBehaviors.previousItem (obj: OpenFileBehavior)

Jongware, 20-Jun-2010 v3.0.3dContents :: Index