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

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

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The RendererExistenceEvent class represents events that are dispatched when a renderer of a Spark DataGroup is added or removed.

See also

spark.components.DataGroup

Public Properties

| Property | Defined By
--- | --- | ---
|  | data : Object The data item of the renderer. | RendererExistenceEvent
|  | index : int The index where the item renderer was added or removed. | RendererExistenceEvent
|  | renderer : IVisualElement Reference to the item render that was added or removed. | RendererExistenceEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | RendererExistenceEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, renderer:IVisualElement = null, index:int = -1, data:Object = null) Constructor. | RendererExistenceEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | RENDERER_ADD : String = rendererAdd [static] The RendererExistenceEvent.RENDERER_ADD constant defines the value of the type property of the event object for an rendererAdd event. | RendererExistenceEvent
|  | RENDERER_REMOVE : String = rendererRemove [static] The RendererExistenceEvent.RENDERER_REMOVE constant defines the value of the type property of the event object for an rendererRemove event. | RendererExistenceEvent

Property Detail

data | property

`public var data:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The data item of the renderer.

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 item renderer was added or removed.

renderer | property |

`public var renderer:IVisualElement`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Reference to the item render that was added or removed.

Constructor Detail

RendererExistenceEvent | () | Constructor

`public function RendererExistenceEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, renderer:IVisualElement = null, index:int = -1, data:Object = null)`

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.
| `renderer:IVisualElement` (default = `null`)`` — Reference to the item renderer that was added or removed.
| `index:int` (default = `-1`)`` — The index in the data provider where the renderer was added or removed.
| `data:Object` (default = `null`)`` — The data item that the renderer is visualizing.

Constant Detail

RENDERER_ADD | Constant

`public static const RENDERER_ADD:String = rendererAdd`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The `RendererExistenceEvent.RENDERER_ADD` constant defines the value of the `type` property of the event object for an `rendererAdd` 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`.
`data` | The data item that the renderer is visualizing.
`index` | The data provider index for the renderer that was added.
`renderer` | Contains a reference to the renderer 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.

RENDERER_REMOVE | Constant |

`public static const RENDERER_REMOVE:String = rendererRemove`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The `RendererExistenceEvent.RENDERER_REMOVE` constant defines the value of the `type` property of the event object for an `rendererRemove` 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`.
`data` | The data item that the renderer was visualizing.
`index` | The data provider index for the renderer that is being removed.
`renderer` | Contains a reference to the renderer that is about to be 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