Packagecom.adobe.indesign
Classpublic class EventListeners
InheritanceEventListeners Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  length : Number
[read-only] The number of objects in the collection.
EventListeners
Public Methods
 MethodDefined By
  
add(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false, withPropertiesParam:Object = null):EventListener
Adds an event listener.
EventListeners
  
Returns any EventListener in the collection.
EventListeners
  
count():Number
Displays the number of elements in the EventListener.
EventListeners
  
everyItem():Object
Returns every EventListener in the collection.
EventListeners
 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
  
Returns the first EventListener in the collection.
EventListeners
 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
 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
  
item(indexParam:Object = null):EventListener
Returns the EventListener with the specified index or name.
EventListeners
  
itemByID(idParam:Number):EventListener
Returns the EventListener with the specified ID.
EventListeners
  
itemByName(nameParam:String = null):EventListener
Returns the EventListener with the specified name.
EventListeners
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the EventListeners within the specified range.
EventListeners
  
Returns the last EventListener in the collection.
EventListeners
  
Returns the middle EventListener in the collection.
EventListeners
  
Returns the EventListener whose index follows the specified EventListener in the collection.
EventListeners
  
Returns the EventListener with the index previous to the specified index.
EventListeners
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 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
  
nextNameIndex(idx:int):int
[override] Overriding this allows us to support for each...in
EventListeners
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
EventListeners
Property Detail
lengthproperty
length:Number  [read-only]

The number of objects in the collection.


Implementation
    public function get length():Number
Method Detail
add()method
public function add(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false, withPropertiesParam:Object = null):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new EventListener (Optional)

Returns
EventListener
anyItem()method 
public function anyItem():EventListener

Returns any EventListener in the collection.

Returns
EventListener
count()method 
public function count():Number

Displays the number of elements in the EventListener.

Returns
Number
everyItem()method 
public function everyItem():Object

Returns every EventListener in the collection.

Returns
Object
firstItem()method 
public function firstItem():EventListener

Returns the first EventListener in the collection.

Returns
EventListener
item()method 
public function item(indexParam:Object = null):EventListener

Returns the EventListener with the specified index or name.

Parameters

indexParam:Object (default = null) — (Object) The index or name. Can accept: Long Integer or String.

Returns
EventListener
itemByID()method 
public function itemByID(idParam:Number):EventListener

Returns the EventListener with the specified ID.

Parameters

idParam:Number (default = NaN) — (Number) The ID.

Returns
EventListener
itemByName()method 
public function itemByName(nameParam:String = null):EventListener

Returns the EventListener with the specified name.

Parameters

nameParam:String (default = null) — (String) The name.

Returns
EventListener
itemByRange()method 
public function itemByRange(fromParam:Object = null, toParam:Object = null):Object

Returns the EventListeners within the specified range.

Parameters

fromParam:Object (default = null) — (Object) The EventListener, index, or name at the beginning of the range. Can accept: EventListener, Long Integer or String.
 
toParam:Object (default = null) — (Object) The EventListener, index, or name at the end of the range. Can accept: EventListener, Long Integer or String.

Returns
Object
lastItem()method 
public function lastItem():EventListener

Returns the last EventListener in the collection.

Returns
EventListener
middleItem()method 
public function middleItem():EventListener

Returns the middle EventListener in the collection.

Returns
EventListener
nextItem()method 
public function nextItem(objParam:EventListener = null):EventListener

Returns the EventListener whose index follows the specified EventListener in the collection.

Parameters

objParam:EventListener (default = null) — (EventListener) The EventListener whose index comes before the desired EventListener.

Returns
EventListener
nextNameIndex()method 
override flash_proxy function nextNameIndex(idx:int):int

Overriding this allows us to support for each...in

Parameters

idx:int

Returns
int
nextValue()method 
override flash_proxy function nextValue(index:int):*

Overriding this allows us to support for each...in

Parameters

index:int

Returns
*
previousItem()method 
public function previousItem(objParam:EventListener = null):EventListener

Returns the EventListener with the index previous to the specified index.

Parameters

objParam:EventListener (default = null) — (EventListener) The index of the EventListener that follows the desired EventListener.

Returns
EventListener