ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.automation.events 

EventDetails  - AS3 Flex

Packagemx.automation.events
Classpublic class EventDetails
InheritanceEventDetails Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Holds the details of an event like its type, handler etc...

Learn more



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  eventType : String
Type of the event
EventDetails
  handlerFunction : Function
Handler function that processes the event
EventDetails
  priority : int
The priority level of the event listener.
EventDetails
  useCapture : Boolean
Determines whether the listener works in the capture phase or the target and bubbling phases.
EventDetails
  useWeekRef : Boolean
Determines whether the reference to the listener is strong or weak.
EventDetails
Public Methods
 MethodDefined By
  
EventDetails(type:String, handler:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false)
Constructor
EventDetails
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

eventType

property
public var eventType:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Type of the event

handlerFunction

property 
public var handlerFunction:Function

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Handler function that processes the event

priority

property 
public var priority:int

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The priority level of the event listener.

The default value is 0.

useCapture

property 
public var useCapture:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Determines whether the listener works in the capture phase or the target and bubbling phases.

The default value is false.

useWeekRef

property 
public var useWeekRef:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Determines whether the reference to the listener is strong or weak. strong reference (the default) prevents your listener from being garbage-collected. weak reference does not.

The default value is false.

Constructor Detail

EventDetails

()Constructor
public function EventDetails(type:String, handler:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false)

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Constructor

Parameters
type:String — The event type; indicates the action that caused the event.
 
handler:Function — Handler function that processes the event.
 
useCapture:Boolean (default = false) — Determines whether the listener works in the capture phase or the target and bubbling phases.
 
priority:int (default = 0) — The priority level of the event listener.
 
useWeakReference:Boolean (default = false) — Determines whether the reference to the listener is strong or weak. strong reference (the default) prevents your listener from being garbage-collected. weak reference does not.