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

ListEvent  - AS3 Flash

Packagefl.events
Classpublic class ListEvent
InheritanceListEvent Inheritance Event Inheritance Object
Subclasses DataGridEvent

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

The ListEvent class defines events for list-based components including the List, DataGrid, TileList, and ComboBox components. These events include the following:
  • ListEvent.ITEM_CLICK: dispatched after the user clicks the mouse over an item in the component.
  • ListEvent.ITEM_DOUBLE_CLICK: dispatched after the user clicks the mouse twice in rapid succession over an item in the component.
  • ListEvent.ITEM_ROLL_OUT: dispatched after the user rolls the mouse pointer out of an item in the component.
  • ListEvent.ITEM_ROLL_OVER: dispatched after the user rolls the mouse pointer over an item in the component.

View the examples

Related API Elements



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
  columnIndex : int
[read-only] Gets the column index of the item that is associated with this event.
ListEvent
 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
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  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
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
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
  
[override] Creates a copy of the ListEvent object and sets the value of each parameter to match the original.
ListEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
  
[override] Returns a string that contains all the properties of the ListEvent object.
ListEvent
 Inherited
Returns the primitive value of the specified object.
Object
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

columnIndex

property
columnIndex:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

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



Implementation
    public function get columnIndex():int

Related API Elements

index

property 
index:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

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



Implementation
    public function get index():int

item

property 
item:Object  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets the data that belongs to the current cell renderer.



Implementation
    public function get item():Object

rowIndex

property 
rowIndex:Object  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

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



Implementation
    public function get rowIndex():Object

Related API Elements

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)

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

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
override public function clone():Event

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

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 
override public function toString():String

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

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_CLICK

Constant
public static const ITEM_CLICK:String = "itemClick"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

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_CLICK

Constant 
public static const ITEM_DOUBLE_CLICK:String = "itemDoubleClick"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

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_OUT

Constant 
public static const ITEM_ROLL_OUT:String = "itemRollOut"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Defines the value of the type property of an itemRollOut 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.

Related API Elements

ITEM_ROLL_OVER

Constant 
public static const ITEM_ROLL_OVER:String = "itemRollOver"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

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.

Related API Elements

ListEventExample.as

This example demonstrates how to use the ListEvent class to determine the row and column of an item within a data grid.
  1. Add the DataGrid component to the library.
  2. Save this code as ListEventExample.as in the same directory as your FLA.
  3. Set the DocumentClass in the FLA to ListEventExample.
package
{
    import flash.display.Sprite;
    import fl.data.DataProvider;
    import fl.controls.DataGrid;
    import fl.events.ListEvent;
    
    public class ListEventExample extends Sprite
    {
        private var dg:DataGrid;
        
        public function ListEventExample() {
            createDataGrid();
        }
        private function createDataGrid():void {
            dg = new DataGrid();
            addChild(dg);
            dg.setSize(200,300);
            
            var dp:DataProvider = new DataProvider();
            var i:uint;
            var totalRows:uint = 42;
            for(i=0; i<totalRows; i++) {
                dp.addItem( {     col1:getRandomNumber(),
                                   col2:getRandomNumber(),
                                col3:getRandomNumber() } );
            }
            dg.dataProvider = dp;
            dg.addEventListener(ListEvent.ITEM_ROLL_OVER, declarePosition);
        }
        private function declarePosition(e:ListEvent):void {
            trace("You are above row: " + e.rowIndex + " column: " + e.columnIndex);    
        }
        private function getRandomNumber():uint {
            return Math.round(Math.random()*100);
        }
    }
}