mx.events

# AIREvent - AS3 Flex

Package | mx.events
Class | public class AIREvent
Inheritance | AIREvent Event Object

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

The AIREvent class represents the event object passed to the event listener for several AIR-specific events dispatched by the Window and WindowedApplication components.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

mx.core.Window
mx.core.WindowedApplication

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | AIREvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false) Constructor. | AIREvent
|  | clone():Event Duplicates an instance of an Event subclass. | Event
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns a string containing all the properties of the Event object. | Event
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | APPLICATION_ACTIVATE : String = "applicationActivate" [static] The AIREvent.APPLICATION_ACTIVATE constant defines the value of the type property of the event object for an applicationActivate event. | AIREvent
|  | APPLICATION_DEACTIVATE : String = "applicationDeactivate" [static] The AIREvent.APPLICATION_DEACTIVATE constant defines the value of the type property of the event object for an applicationDeactivate event. | AIREvent
|  | WINDOW_ACTIVATE : String = "windowActivate" [static] The AIREvent.WINDOW_ACTIVATE constant defines the value of the type property of the event object for a windowActivate event. | AIREvent
|  | WINDOW_COMPLETE : String = "windowComplete" [static] The AIREvent.WINDOW_COMPLETE constant defines the value of the type property of the event object for an windowComplete event. | AIREvent
|  | WINDOW_DEACTIVATE : String = "windowDeactivate" [static] The AIREvent.WINDOW_DEACTIVATE constant defines the value of the type property of the event object for a windowDeactivate event. | AIREvent

Constructor Detail

### AIREvent

()
Constructor

`public function AIREvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

Constructor.

Parameters

| `type:String` — The event type; indicates the action that caused the event.
| `bubbles:Boolean` (default = `false`)`` — Specifies whether the event can bubble up the display list hierarchy.
| `cancelable:Boolean` (default = `false`)`` — Specifies whether the behavior associated with the event can be prevented.

Constant Detail

### APPLICATION_ACTIVATE

Constant

`public static const APPLICATION_ACTIVATE:String = "applicationActivate"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

The AIREvent.APPLICATION_ACTIVATE constant defines the value of the `type` property of the event object for an `applicationActivate` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`file` | The File object associated with this event.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`type` | AIREvent.APPLICATION_ACTIVATE

### APPLICATION_DEACTIVATE

Constant

`public static const APPLICATION_DEACTIVATE:String = "applicationDeactivate"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

The AIREvent.APPLICATION_DEACTIVATE constant defines the value of the `type` property of the event object for an `applicationDeactivate` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`file` | The File object associated with this event.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`type` | AIREvent.APPLICATION_DEACTIVATE

### WINDOW_ACTIVATE

Constant

`public static const WINDOW_ACTIVATE:String = "windowActivate"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

The AIREvent.WINDOW_ACTIVATE constant defines the value of the `type` property of the event object for a `windowActivate` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`file` | The File object associated with this event.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`type` | AIREvent.WINDOW_ACTIVATE

### WINDOW_COMPLETE

Constant

`public static const WINDOW_COMPLETE:String = "windowComplete"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

The AIREvent.WINDOW_COMPLETE constant defines the value of the `type` property of the event object for an `windowComplete` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`file` | The File object associated with this event.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`type` | AIREvent.WINDOW_COMPLETE

### WINDOW_DEACTIVATE

Constant

`public static const WINDOW_DEACTIVATE:String = "windowDeactivate"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

The AIREvent.WINDOW_DEACTIVATE constant defines the value of the `type` property of the event object for a `windowDeactivate` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`file` | The File object associated with this event.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`type` | AIREvent.WINDOW_DEACTIVATE

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00