ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
spark.events 

RendererExistenceEvent  - AS3 Flex
Packagespark.events
Classpublic class RendererExistenceEvent
InheritanceRendererExistenceEvent Inheritance Event Inheritance 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
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : 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
 InheritedeventPhase : 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
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
RendererExistenceEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, renderer:IVisualElement = null, index:int = -1, data:Object = null)
Constructor.
RendererExistenceEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
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

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:

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_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:

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.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy