Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
ElementExistenceEvent

Package | spark.events
Class | public class ElementExistenceEvent
Inheritance | ElementExistenceEvent flash.events.Event

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The ElementExistenceEvent class represents events that are dispatched when an element of a Group is created or destroyed.

See also

spark.components.Group

Public Properties

| Property | Defined By
--- | --- | ---
|  | element : IVisualElement Reference to the visual element that was added or removed. | ElementExistenceEvent
|  | index : int The index where the element was added or removed. | ElementExistenceEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | ElementExistenceEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, element:IVisualElement = null, index:int = -1) Constructor. | ElementExistenceEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | ELEMENT_ADD : String = elementAdd [static] The ElementExistenceEvent.ELEMENT_ADD constant defines the value of the type property of the event object for an elementAdd event. | ElementExistenceEvent
|  | ELEMENT_REMOVE : String = elementRemove [static] The ElementExistenceEvent.ELEMENT_REMOVE constant defines the value of the type property of the event object for an elementRemove event. | ElementExistenceEvent

Property Detail

element | property

`public var element:IVisualElement`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Reference to the visual element that was added or removed.

index | property |

`public var index:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The index where the element was added or removed.

Constructor Detail

ElementExistenceEvent | () | Constructor

`public function ElementExistenceEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, element:IVisualElement = null, index:int = -1)`

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.
| `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.
| `element:IVisualElement` (default = `null`)`` — Reference to the element that was added or removed.
| `index:int` (default = `-1`)`` — The index where the element was added or removed.

Constant Detail

ELEMENT_ADD | Constant

`public static const ELEMENT_ADD:String = elementAdd`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The `ElementExistenceEvent.ELEMENT_ADD` constant defines the value of the `type` property of the event object for an `elementAdd` 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`.
`element` | Contains a reference to the visual element that was added.
`index` | The index where the visual element that was added.
`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.

ELEMENT_REMOVE | Constant |

`public static const ELEMENT_REMOVE:String = elementRemove`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The `ElementExistenceEvent.ELEMENT_REMOVE` constant defines the value of the `type` property of the event object for an `elementRemove` 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`.
`element` | A reference to the visual element that is about to be removed.
`index` | The index of visual element that is being removed.
`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.

Sun Mar 5 2017, 03:42 PM +11:00