Packagespark.events
Classpublic class RendererExistenceEvent
InheritanceRendererExistenceEvent Inheritance 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
 PropertyDefined 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
 MethodDefined By
  
RendererExistenceEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, renderer:IVisualElement = null, index:int = -1, data:Object = null)
Constructor.
RendererExistenceEvent
Public Constants
 ConstantDefined 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
dataproperty
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.

indexproperty 
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.

rendererproperty 
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_ADDConstant
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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
dataThe data item that the renderer is visualizing.
indexThe data provider index for the renderer that was added.
rendererContains a reference to the renderer that was added
targetThe 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_REMOVEConstant 
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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
dataThe data item that the renderer was visualizing.
indexThe data provider index for the renderer that is being removed.
rendererContains a reference to the renderer that is about to be removed.
targetThe 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.





Mon Dec 24 2012, 01:18 PM +11:00