Packagecom.adobe.indesign
Classpublic class DocumentEvent
InheritanceDocumentEvent Inheritance Event Inheritance CSHostObject Inheritance flash.utils.Proxy

Event



Public Properties
 PropertyDefined By
 InheritedAFTER_ACTIVATE : String
[static] [read-only] Dispatched after the Event becomes active.
Event
  AFTER_CLOSE : String
[static] [read-only] Dispatched after a Document is closed.
DocumentEvent
 InheritedAFTER_CONTEXT_CHANGED : String
[static] [read-only] Dispatched after the active context changes.
Event
 InheritedAFTER_DELETE : String
[static] [read-only] Dispatched after a Event is deleted.
Event
 InheritedAFTER_EMBED : String
[static] [read-only] Dispatched after a Event is embedded.
Event
 InheritedAFTER_INVOKE : String
[static] [read-only] Dispatched after the Event is invoked.
Event
 InheritedAFTER_LINKS_CHANGED : String
[static] [read-only] Dispatched after one or more links in the Event have been added, deleted, or modified.
Event
 InheritedAFTER_MOVE : String
[static] [read-only] Dispatched after a Event is relocated from one object to another.
Event
  AFTER_NEW : String
[static] [read-only] Dispatched after a Document is created.
DocumentEvent
  AFTER_OPEN : String
[static] [read-only] Dispatched after a Document is opened.
DocumentEvent
 InheritedAFTER_PLACE : String
[static] [read-only] Dispatched after a Event is placed.
Event
 InheritedAFTER_QUIT : String
[static] [read-only] Dispatched when the Event is quitting.
Event
  AFTER_REVERT : String
[static] [read-only] Dispatched after a Document is reverted.
DocumentEvent
  AFTER_SAVE : String
[static] [read-only] Dispatched after a Document is saved.
DocumentEvent
  AFTER_SAVE_A_COPY : String
[static] [read-only] Dispatched after a copy of a Document is saved.
DocumentEvent
  AFTER_SAVE_AS : String
[static] [read-only] Dispatched after a Document is saved under a new name.
DocumentEvent
 InheritedAFTER_SELECTION_ATTRIBUTE_CHANGED : String
[static] [read-only] Dispatched after an attribute on the active selection changes.
Event
 InheritedAFTER_SELECTION_CHANGED : String
[static] [read-only] Dispatched after the active selection changes.
Event
 InheritedAFTER_UNEMBED : String
[static] [read-only] Dispatched after a Event is unembedded.
Event
 InheritedAFTER_UPDATE : String
[static] [read-only] Dispatched after a Event is updated.
Event
  BEFORE_CLOSE : String
[static] [read-only] Dispatched before a Document is closed.
DocumentEvent
 InheritedBEFORE_DEACTIVATE : String
[static] [read-only] Dispatched before the Event becomes inactive.
Event
 InheritedBEFORE_DELETE : String
[static] [read-only] Dispatched before a Event is deleted.
Event
 InheritedBEFORE_DISPLAY : String
[static] [read-only] Dispatched before the Event is displayed.
Event
 InheritedBEFORE_EMBED : String
[static] [read-only] Dispatched before a Event is embedded.
Event
 InheritedBEFORE_INVOKE : String
[static] [read-only] Dispatched before the Event is invoked.
Event
 InheritedBEFORE_MOVE : String
[static] [read-only] Dispatched before a Event is relocated from one object to another.
Event
  BEFORE_NEW : String
[static] [read-only] Dispatched before a Document is created.
DocumentEvent
  BEFORE_OPEN : String
[static] [read-only] Dispatched before a Document is opened.
DocumentEvent
 InheritedBEFORE_PLACE : String
[static] [read-only] Dispatched before a Event is placed.
Event
 InheritedBEFORE_QUIT : String
[static] [read-only] Dispatched before the Event is quit.
Event
  BEFORE_REVERT : String
[static] [read-only] Dispatched before a Document is reverted.
DocumentEvent
  BEFORE_SAVE : String
[static] [read-only] Dispatched before a Document is saved.
DocumentEvent
  BEFORE_SAVE_A_COPY : String
[static] [read-only] Dispatched before a copy of a Document is saved.
DocumentEvent
  BEFORE_SAVE_AS : String
[static] [read-only] Dispatched before a Document is saved under a new name.
DocumentEvent
 InheritedBEFORE_UNEMBED : String
[static] [read-only] Dispatched before a Event is unembedded.
Event
 InheritedBEFORE_UPDATE : String
[static] [read-only] Dispatched before a Event is updated.
Event
  bubbles : Boolean
[override] [read-only] If true, the event supports the bubbling phase of propagation.
DocumentEvent
  cancelable : Boolean
[override] [read-only] If true, the default behavior of the event on its target can be canceled.
DocumentEvent
  currentTarget : Object
[override] [read-only] The current propagation target of the event.
DocumentEvent
  defaultPrevented : Boolean
[override] [read-only] If true, the default behavior of the event on its target has been canceled.
DocumentEvent
  eventPhase : EventPhases
[override] [read-only] The current propagation phase of the event.
DocumentEvent
  eventType : String
[override] [read-only] The name of the event.
DocumentEvent
  fullName : File
[read-only] The full path to the DocumentEvent, including the name of the DocumentEvent.
DocumentEvent
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[override] [read-only] The unique ID of the DocumentEvent.
DocumentEvent
  index : Number
[override] [read-only] The index of the DocumentEvent within its containing object.
DocumentEvent
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
DocumentEvent
 InheritedON_INVOKE : String
[static] [read-only] Dispatched when the Event is invoked.
Event
  parent : Object
[override] [read-only] The parent of the DocumentEvent (a Application or Document).
DocumentEvent
  propagationStopped : Boolean
[override] [read-only] If true, propagation of the event beyond the current target has been stopped.
DocumentEvent
  properties : Object
[override] A property that allows setting of several properties at the same time.
DocumentEvent
  target : Object
[override] [read-only] The target of the event.
DocumentEvent
  timeStamp : Date
[override] [read-only] The time the event was initialized.
DocumentEvent
  userInteractionLevel : UserInteractionLevels
Controls the display of dialogs and alerts during script processing.
DocumentEvent
Public Methods
 MethodDefined By
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
[override] Resolves the object specifier, creating an array of object references.
DocumentEvent
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
[override] Cancels the default behavior of the event on its target.
DocumentEvent
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
[override] Stops propagation of the event beyond the current target.
DocumentEvent
  
toSpecifier():String
[override] Retrieves the object specifier.
DocumentEvent
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
AFTER_CLOSEproperty
AFTER_CLOSE:String  [read-only]

Dispatched after a Document is closed. This event bubbles. This event is not cancelable.


Implementation
    public static function get AFTER_CLOSE():String
AFTER_NEWproperty 
AFTER_NEW:String  [read-only]

Dispatched after a Document is created. This event bubbles. This event is not cancelable.


Implementation
    public static function get AFTER_NEW():String
AFTER_OPENproperty 
AFTER_OPEN:String  [read-only]

Dispatched after a Document is opened. This event bubbles. This event is not cancelable.


Implementation
    public static function get AFTER_OPEN():String
AFTER_REVERTproperty 
AFTER_REVERT:String  [read-only]

Dispatched after a Document is reverted. This event bubbles. This event is not cancelable.


Implementation
    public static function get AFTER_REVERT():String
AFTER_SAVEproperty 
AFTER_SAVE:String  [read-only]

Dispatched after a Document is saved. This event bubbles. This event is not cancelable.


Implementation
    public static function get AFTER_SAVE():String
AFTER_SAVE_A_COPYproperty 
AFTER_SAVE_A_COPY:String  [read-only]

Dispatched after a copy of a Document is saved. This event bubbles. This event is not cancelable.


Implementation
    public static function get AFTER_SAVE_A_COPY():String
AFTER_SAVE_ASproperty 
AFTER_SAVE_AS:String  [read-only]

Dispatched after a Document is saved under a new name. This event bubbles. This event is not cancelable.


Implementation
    public static function get AFTER_SAVE_AS():String
BEFORE_CLOSEproperty 
BEFORE_CLOSE:String  [read-only]

Dispatched before a Document is closed. This event bubbles. This event is not cancelable.


Implementation
    public static function get BEFORE_CLOSE():String
BEFORE_NEWproperty 
BEFORE_NEW:String  [read-only]

Dispatched before a Document is created. This event bubbles. This event is cancelable.


Implementation
    public static function get BEFORE_NEW():String
BEFORE_OPENproperty 
BEFORE_OPEN:String  [read-only]

Dispatched before a Document is opened. This event bubbles. This event is cancelable.


Implementation
    public static function get BEFORE_OPEN():String
BEFORE_REVERTproperty 
BEFORE_REVERT:String  [read-only]

Dispatched before a Document is reverted. This event bubbles. This event is cancelable.


Implementation
    public static function get BEFORE_REVERT():String
BEFORE_SAVEproperty 
BEFORE_SAVE:String  [read-only]

Dispatched before a Document is saved. This event bubbles. This event is cancelable.


Implementation
    public static function get BEFORE_SAVE():String
BEFORE_SAVE_A_COPYproperty 
BEFORE_SAVE_A_COPY:String  [read-only]

Dispatched before a copy of a Document is saved. This event bubbles. This event is cancelable.


Implementation
    public static function get BEFORE_SAVE_A_COPY():String
BEFORE_SAVE_ASproperty 
BEFORE_SAVE_AS:String  [read-only]

Dispatched before a Document is saved under a new name. This event bubbles. This event is cancelable.


Implementation
    public static function get BEFORE_SAVE_AS():String
bubblesproperty 
bubbles:Boolean  [read-only] [override]

If true, the event supports the bubbling phase of propagation.


Implementation
    public function get bubbles():Boolean
cancelableproperty 
cancelable:Boolean  [read-only] [override]

If true, the default behavior of the event on its target can be canceled.


Implementation
    public function get cancelable():Boolean
currentTargetproperty 
currentTarget:Object  [read-only] [override]

The current propagation target of the event.


Implementation
    public function get currentTarget():Object
defaultPreventedproperty 
defaultPrevented:Boolean  [read-only] [override]

If true, the default behavior of the event on its target has been canceled.


Implementation
    public function get defaultPrevented():Boolean
eventPhaseproperty 
eventPhase:EventPhases  [read-only] [override]

The current propagation phase of the event.


Implementation
    public function get eventPhase():EventPhases
eventTypeproperty 
eventType:String  [read-only] [override]

The name of the event.


Implementation
    public function get eventType():String
fullNameproperty 
fullName:File  [read-only]

The full path to the DocumentEvent, including the name of the DocumentEvent.


Implementation
    public function get fullName():File
idproperty 
id:Number  [read-only] [override]

The unique ID of the DocumentEvent.


Implementation
    public function get id():Number
indexproperty 
index:Number  [read-only] [override]

The index of the DocumentEvent within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
parentproperty 
parent:Object  [read-only] [override]

The parent of the DocumentEvent (a Application or Document).


Implementation
    public function get parent():Object
propagationStoppedproperty 
propagationStopped:Boolean  [read-only] [override]

If true, propagation of the event beyond the current target has been stopped.


Implementation
    public function get propagationStopped():Boolean
propertiesproperty 
properties:Object[override]

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
targetproperty 
target:Object  [read-only] [override]

The target of the event.


Implementation
    public function get target():Object
timeStampproperty 
timeStamp:Date  [read-only] [override]

The time the event was initialized.


Implementation
    public function get timeStamp():Date
userInteractionLevelproperty 
userInteractionLevel:UserInteractionLevels

Controls the display of dialogs and alerts during script processing.


Implementation
    public function get userInteractionLevel():UserInteractionLevels
    public function set userInteractionLevel(value:UserInteractionLevels):void
Method Detail
getElements()method
override public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
preventDefault()method 
override public function preventDefault():void

Cancels the default behavior of the event on its target.

stopPropagation()method 
override public function stopPropagation():void

Stops propagation of the event beyond the current target.

toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String