spark.events

# RendererExistenceEvent - AS3 Flex

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

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.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

spark.components.DataGroup

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
|  | data : Object The data item of the renderer. | RendererExistenceEvent
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | 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
|  | 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
--- | --- | ---
|  | RendererExistenceEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, renderer:IVisualElement = null, index:int = -1, data:Object = null) Constructor. | RendererExistenceEvent
|  | 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
--- | --- | ---
|  | 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.

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