Packagefl.events
Classpublic class ListEvent
InheritanceListEvent Inheritance flash.events.Event

The ListEvent class defines events for list-based components including the List, DataGrid, TileList, and ComboBox components. These events include the following:

See also

List
SelectableList


Public Properties
 PropertyDefined by
  columnIndex : int
[read-only] Gets the column index of the item that is associated with this event.
ListEvent
  index : int
[read-only] Gets the zero-based index of the cell that contains the renderer.
ListEvent
  item : Object
[read-only] Gets the data that belongs to the current cell renderer.
ListEvent
  rowIndex : Object
[read-only] Gets the row index of the item that is associated with this event.
ListEvent
Public Methods
 MethodDefined by
  
ListEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, columnIndex:int = -1, rowIndex:int = -1, index:int = -1, item:Object = null)
Creates a new ListEvent object with the specified parameters.
ListEvent
  
clone():Event
Creates a copy of the ListEvent object and sets the value of each parameter to match the original.
ListEvent
  
toString():String
Returns a string that contains all the properties of the ListEvent object.
ListEvent
Public Constants
 ConstantDefined by
  ITEM_CLICK : String = "itemClick"
[static] Defines the value of the type property of an itemClick event object.
ListEvent
  ITEM_DOUBLE_CLICK : String = "itemDoubleClick"
[static] Defines the value of the type property of an itemDoubleClick event object.
ListEvent
  ITEM_ROLL_OUT : String = "itemRollOut"
[static] Defines the value of the type property of an itemRollOut event object.
ListEvent
  ITEM_ROLL_OVER : String = "itemRollOver"
[static] Defines the value of the type property of an itemRollOver event object.
ListEvent
Property detail
columnIndexproperty
columnIndex:int  [read-only]

Gets the column index of the item that is associated with this event.

Implementation
    public function get columnIndex():int

See also

indexproperty 
index:int  [read-only]

Gets the zero-based index of the cell that contains the renderer.

Implementation
    public function get index():int
itemproperty 
item:Object  [read-only]

Gets the data that belongs to the current cell renderer.

Implementation
    public function get item():Object
rowIndexproperty 
rowIndex:Object  [read-only]

Gets the row index of the item that is associated with this event.

Implementation
    public function get rowIndex():Object

See also

Constructor detail
ListEvent()constructor
public function ListEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, columnIndex:int = -1, rowIndex:int = -1, index:int = -1, item:Object = null)

Creates a new ListEvent object with the specified parameters.

Parameters
type:String — The event type; this value identifies the action that caused the event.
 
bubbles:Boolean (default = false) — Indicates whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Indicates whether the behavior associated with the event can be prevented.
 
columnIndex:int (default = -1) — The zero-based index of the column that contains the renderer or visual representation of the data in the column.
 
rowIndex:int (default = -1) — The zero-based index of the row that contains the renderer or visual representation of the data in the row.
 
index:int (default = -1) — The zero-based index of the item in the DataProvider.
 
item:Object (default = null) — A reference to the data that belongs to the renderer.
Method detail
clone()method
public override function clone():Event

Creates a copy of the ListEvent object and sets the value of each parameter to match the original.

Returns
Event — A new ListEvent object with parameter values that match those of the original.
toString()method 
public override function toString():String

Returns a string that contains all the properties of the ListEvent object. The string is in the following format:

[ListEvent type=value bubbles=value cancelable=value columnIndex=value rowIndex=value]

Returns
String — A string representation of the ListEvent object.
Constant detail
ITEM_CLICKconstant
public static const ITEM_CLICK:String = "itemClick"

Defines the value of the type property of an itemClick event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelabletrue
columnIndexThe zero-based index of the column that contains the renderer.
currentTargetThe object that is actively processing the event object with an event listener.
indexThe zero-based index in the DataProvider that contains the renderer.
itemA reference to the data that belongs to the renderer.
rowIndexThe zero-based index of the row that contains the renderer.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.
ITEM_DOUBLE_CLICKconstant 
public static const ITEM_DOUBLE_CLICK:String = "itemDoubleClick"

Defines the value of the type property of an itemDoubleClick event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelabletrue
columnIndexThe zero-based index of the column that contains the renderer.
currentTargetThe object that is actively processing the event object with an event listener.
indexThe zero-based index in the DataProvider that contains the renderer.
itemA reference to the data that belongs to the renderer.
rowIndexThe zero-based index of the row that contains the renderer.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.
ITEM_ROLL_OUTconstant 
public static const ITEM_ROLL_OUT:String = "itemRollOut"

Defines the value of the type property of an itemRollOut event object.

This event has the following properties:

Property Value
bubbles false
cancelablefalse; there is no default behavior to cancel.
columnIndexThe zero-based index of the column that contains the renderer.
currentTargetThe object that is actively processing the event object with an event listener.
indexThe zero-based index in the DataProvider that contains the renderer.
itemA reference to the data that belongs to the renderer.
rowIndexThe zero-based index of the row that contains the renderer.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.

See also

ITEM_ROLL_OVERconstant 
public static const ITEM_ROLL_OVER:String = "itemRollOver"

Defines the value of the type property of an itemRollOver event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
columnIndexThe zero-based index of the column that contains the renderer.
currentTargetThe object that is actively processing the event object with an event listener.
indexThe zero-based index in the DataProvider that contains the renderer.
itemA reference to the data that belongs to the renderer.
rowIndexThe zero-based index of the row that contains the renderer.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.

See also