Adobe InDesign CS4 (6.0) Object Model JS: Event

InDesign CS4

Class

Event

 

An event.

Superclass of DocumentEvent, ImportExportEvent, and PrintEvent

QuickLinks

getElements, preventDefault, stopPropagation, toSource, toSpecifier

Hierarchy

Application | Document | Menu | MenuAction | ScriptMenuAction | Submenu
Event
DocumentEvent | ImportExportEvent | PrintEvent

Properties

PropertyTypeAccessDescription
bubblesbool readonlyIf true, the event supports the bubbling phase of propagation.
cancelablebool readonlyIf true, the default behavior of the event on its target can be canceled.
capturesbool readonlyIf true, the event supports the capturing phase of propagation.
currentTargetObject readonlyThe current propagation target of the event.
defaultPreventedbool readonlyIf true, the default behavior of the event on its target has been canceled.
eventPhaseEventPhases:
EventPhases.NOT_DISPATCHING
EventPhases.CAPTURING_PHASE
EventPhases.AT_TARGET
EventPhases.BUBBLING_PHASE
EventPhases.DONE
readonlyThe current propagation phase of the event.
eventTypestring readonlyThe name of the event.
idnumber readonlyThe unique ID of the Event.
indexnumber readonlyThe index of the Event within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplication
Document
Menu
MenuAction
ScriptMenuAction
Submenu
readonlyThe parent of the Event (a Document, Application, MenuAction, ScriptMenuAction, Menu or Submenu).
propagationStoppedbool readonlyIf true, propagation of the event beyond the current target has been stopped.
propertiesObject r/wA property that allows setting of several properties at the same time.
targetObject readonlyThe target of the event.
timeStampDate readonlyThe time the event was initialized.

Methods

Instances

Array of Event getElements ()
Resolves the object specifier, creating an array of object references.

void preventDefault ()
Cancels the default behavior of the event on its target.

void stopPropagation ()
Stops propagation of the event beyond the current target.

string toSource ()
Generates a string which, if executed, will return the Event.

string toSpecifier ()
Retrieves the object specifier.

Used in:

array of Event Events.itemByRange (from: any, to: any)

Event Events.nextItem (obj: Event)

Event Events.previousItem (obj: Event)

Return

Event Button (SUI).dispatchEvent ()

Event Checkbox.dispatchEvent ()

Event DropDownList.dispatchEvent ()

Event EditText.dispatchEvent ()

Array of Event Event.getElements ()

Event Events.[] (index: number)

Event Events.anyItem ()

Array of Event Events.everyItem ()

Event Events.firstItem ()

Event Events.item (index: any)

Event Events.itemByID (id: number)

Event Events.itemByName (name: string)

Array of Event Events.itemByRange (from: any, to: any)

Event Events.lastItem ()

Event Events.middleItem ()

Event Events.nextItem (obj: Event)

Event Events.previousItem (obj: Event)

Event FlashPlayer.dispatchEvent ()

Event Group (SUI).dispatchEvent ()

Event IconButton.dispatchEvent ()

Event Image (SUI).dispatchEvent ()

Event ListBox.dispatchEvent ()

Event Panel (SUI).dispatchEvent ()

Event Progressbar.dispatchEvent ()

Event RadioButton.dispatchEvent ()

Event Scrollbar.dispatchEvent ()

Event Slider.dispatchEvent ()

Event StaticText (SUI).dispatchEvent ()

Event TreeView.dispatchEvent ()

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