Packagespark.events
Classpublic class ListEvent
InheritanceListEvent Inheritance flash.events.MouseEvent

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.2, AIR 2.5

ListEvents dispatched by ListBase components like ButtonBar and List in response to MouseEvents are constructed with the incoming mouse event's properties. The list event's x,y location, i.e. the value of its localX and localY properties, is defined relative to the entire component, not just the part of the component that has been scrolled into view. Similarly, the event's row and column indices may correspond to a cell that has not been scrolled into view.


Public Properties
 PropertyDefined By
  item : Object
The data provider item the item renderer is displaying.
ListEvent
  itemIndex : int
The index of the data item the item renderer is displaying.
ListEvent
  itemRenderer : IItemRenderer
The item renderer that is displaying the item.
ListEvent
Public Methods
 MethodDefined By
  
ListEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, localX:Number, localY:Number, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0, itemIndex:int = -1, item:Object = null, itemRenderer:IItemRenderer = null)
Constructor.
ListEvent
Public Constants
 ConstantDefined By
  ITEM_ROLL_OUT : String = itemRollOut
[static] The ListEvent.ITEM_ROLL_OUT constant defines the value of the type property of the ListEvent object for an itemRollOut event, which indicates that the user rolled the mouse pointer out of a visual item in the control.
ListEvent
  ITEM_ROLL_OVER : String = itemRollOver
[static] The ListEvent.ITEM_ROLL_OVER constant defines the value of the type property of the ListEvent object for an itemRollOver event, which indicates that the user rolled the mouse pointer over a visual item in the control.
ListEvent
Property Detail
itemproperty
public var item:Object

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.2, AIR 2.5

The data provider item the item renderer is displaying.

itemIndexproperty 
public var itemIndex:int

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.2, AIR 2.5

The index of the data item the item renderer is displaying. You can access the data provider item using this property.

itemRendererproperty 
public var itemRenderer:IItemRenderer

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.2, AIR 2.5

The item renderer that is displaying the item.

Constructor Detail
ListEvent()Constructor
public function ListEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, localX:Number, localY:Number, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0, itemIndex:int = -1, item:Object = null, itemRenderer:IItemRenderer = null)

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.2, AIR 2.5

Constructor. Normally called by the Flex control and not used in application code.

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.
 
localX:Number (default = NaN) — Distinguishes the mouse gesture that caused this event to be dispatched.
 
localY:Number (default = NaN) — Specifies whether the event can bubble up the display list hierarchy.
 
relatedObject:InteractiveObject (default = null) — Specifies whether the behavior associated with the event can be prevented.
 
ctrlKey:Boolean (default = false) — The event's x coordinate relative to the List.
 
altKey:Boolean (default = false) — The event's y coordinate relative to the List.
 
shiftKey:Boolean (default = false) — The relatedObject property of the MouseEvent that triggered this ListEvent.
 
buttonDown:Boolean (default = false) — Whether the Control key is down.
 
delta:int (default = 0) — Whether the Alt key is down.
 
itemIndex:int (default = -1) — Whether the Shift key is down.
 
item:Object (default = null) — Whether the Control key is down.
 
itemRenderer:IItemRenderer (default = null) — Not used.
Constant Detail
ITEM_ROLL_OUTConstant
public static const ITEM_ROLL_OUT:String = itemRollOut

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.2, AIR 2.5

The ListEvent.ITEM_ROLL_OUT constant defines the value of the type property of the ListEvent object for an itemRollOut event, which indicates that the user rolled the mouse pointer out of a visual item in the control.

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.
itemIndexThe data provider index of the item displayed by the item renderer where the event occurred.
itemThe data provider item for the item renderer.
itemRendererThe The item renderer that displayed this item.
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.
TypeListEvent.ITEM_ROLL_OUT

ITEM_ROLL_OVERConstant 
public static const ITEM_ROLL_OVER:String = itemRollOver

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.2, AIR 2.5

The ListEvent.ITEM_ROLL_OVER constant defines the value of the type property of the ListEvent object for an itemRollOver event, which indicates that the user rolled the mouse pointer over a visual item in the control.

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.
itemIndexThe data provider index of the item displayed by the item renderer where the event occurred.
itemThe data provider item for the item renderer.
itemRendererThe The item renderer that displayed this item.
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.
TypeListEvent.ITEM_ROLL_OVER




The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00