| Package | fl.events |
| Class | public class ListEvent |
| Inheritance | ListEvent Event Object |
| Subclasses | DataGridEvent |
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9.0.28.0 |
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.See also
| Property | Defined By | ||
|---|---|---|---|
![]() | bubbles : Boolean
[read-only]
Indicates whether an event is a bubbling event.
| Event | |
![]() | cancelable : 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 | ||
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
![]() | currentTarget : Object
[read-only]
The object that is actively processing the Event object with an event listener.
| Event | |
![]() | eventPhase : 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 | ||
![]() | prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| rowIndex : Object
[read-only]
Gets the row index of the item that is associated with this event.
| ListEvent | ||
![]() | target : Object
[read-only]
The event target.
| Event | |
![]() | type : String
[read-only]
The type of event.
| Event | |
| Method | Defined 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 | ||
|
Creates a copy of the ListEvent object and sets the value of each parameter to match
the original.
| ListEvent | ||
![]() |
A utility function for implementing the
toString() method in your custom Event class.
| Event | |
![]() |
Indicates whether an object has a specified property defined.
| Object | |
![]() |
Checks whether preventDefault() has been called on the event.
| Event | |
![]() |
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
![]() |
Cancels an event's default behavior if that behavior can be canceled.
| Event | |
![]() |
Indicates whether the specified property exists and is enumerable.
| Object | |
![]() |
Sets the availability of a dynamic property for loop operations.
| Object | |
![]() |
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow.
| Event | |
![]() |
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow.
| Event | |
|
Returns a string that contains all the properties of the ListEvent object.
| ListEvent | ||
![]() |
Returns the primitive value of the specified object.
| Object | |
| Constant | Defined By | ||
|---|---|---|---|
![]() | ACTIVATE : String = "activate" [static]
Defines the value of the type property of an activate event object.
| Event | |
![]() | ADDED : String = "added" [static]
Defines the value of the type property of an added event object.
| Event | |
![]() | ADDED_TO_STAGE : String = "addedToStage" [static]
Defines the value of the type property of an addedToStage event object.
| Event | |
![]() | CANCEL : String = "cancel" [static]
Defines the value of the type property of a cancel event object.
| Event | |
![]() | CHANGE : String = "change" [static]
Defines the value of the type property of a change event object.
| Event | |
![]() | CLOSE : String = "close" [static]
Defines the value of the type property of a close event object.
| Event | |
![]() | COMPLETE : String = "complete" [static]
Defines the value of the type property of a complete event object.
| Event | |
![]() | CONNECT : String = "connect" [static]
Defines the value of the type property of a connect event object.
| Event | |
![]() | DEACTIVATE : String = "deactivate" [static]
Defines the value of the type property of a deactivate event object.
| Event | |
![]() | ENTER_FRAME : String = "enterFrame" [static]
Defines the value of the type property of an enterFrame event object.
| Event | |
![]() | FULLSCREEN : String = "fullScreen" [static]
Defines the value of the type property of a fullScreen event object.
| Event | |
![]() | ID3 : String = "id3" [static]
Defines the value of the type property of an id3 event object.
| Event | |
![]() | INIT : String = "init" [static]
Defines the value of the type property of an init event object.
| Event | |
| 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 | ||
![]() | MOUSE_LEAVE : String = "mouseLeave" [static]
Defines the value of the type property of a mouseLeave event object.
| Event | |
![]() | OPEN : String = "open" [static]
Defines the value of the type property of an open event object.
| Event | |
![]() | REMOVED : String = "removed" [static]
Defines the value of the type property of a removed event object.
| Event | |
![]() | REMOVED_FROM_STAGE : String = "removedFromStage" [static]
Defines the value of the type property of a removedFromStage event object.
| Event | |
![]() | RENDER : String = "render" [static]
Defines the value of the type property of a render event object.
| Event | |
![]() | RESIZE : String = "resize" [static]
Defines the value of the type property of a resize event object.
| Event | |
![]() | SCROLL : String = "scroll" [static]
Defines the value of the type property of a scroll event object.
| Event | |
![]() | SELECT : String = "select" [static]
Defines the value of the type property of a select event object.
| Event | |
![]() | SOUND_COMPLETE : String = "soundComplete" [static]
Defines the value of the type property of a soundComplete event object.
| Event | |
![]() | TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
Defines the value of the type property of a tabChildrenChange event object.
| Event | |
![]() | TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
Defines the value of the type property of a tabEnabledChange event object.
| Event | |
![]() | TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
Defines the value of the type property of a tabIndexChange event object.
| Event | |
![]() | UNLOAD : String = "unload" [static]
Defines the value of the type property of an unload event object.
| Event | |
| columnIndex | property |
columnIndex:int [read-only]
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9.0.28.0 |
Gets the column index of the item that is associated with this event.
public function get columnIndex():int
See also
| index | property |
index:int [read-only]
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9.0.28.0 |
Gets the zero-based index of the cell that contains the renderer.
public function get index():int
| item | property |
item:Object [read-only]
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9.0.28.0 |
Gets the data that belongs to the current cell renderer.
public function get item():Object
| rowIndex | property |
rowIndex:Object [read-only]
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9.0.28.0 |
Gets the row index of the item that is associated with this event.
public function get rowIndex():Object
See also
| 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 |
| Player Version : | Flash Player 9.0.28.0 |
Creates a new ListEvent object with the specified parameters.
Parameterstype: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.
|
| clone | () | method |
public override function clone():Event
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9.0.28.0 |
Creates a copy of the ListEvent object and sets the value of each parameter to match the original.
ReturnsEvent — A new ListEvent object with parameter values that match those of the original.
|
| toString | () | method |
public override function toString():String
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9.0.28.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]
String — A string representation of the ListEvent object.
|
| ITEM_CLICK | Constant |
public static const ITEM_CLICK:String = "itemClick"
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9.0.28.0 |
Defines the value of the type property of an itemClick
event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the column that contains the renderer. |
currentTarget | The object that is actively processing the event object with an event listener. |
index | The zero-based index in the DataProvider that contains the renderer. |
item | A reference to the data that belongs to the renderer. |
rowIndex | The zero-based index of the row that contains the renderer. |
target | The 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 |
| Player Version : | Flash Player 9.0.28.0 |
Defines the value of the type property of an itemDoubleClick
event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the column that contains the renderer. |
currentTarget | The object that is actively processing the event object with an event listener. |
index | The zero-based index in the DataProvider that contains the renderer. |
item | A reference to the data that belongs to the renderer. |
rowIndex | The zero-based index of the row that contains the renderer. |
target | The 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 |
| Player Version : | Flash Player 9.0.28.0 |
Defines the value of the type property of an
itemRollOut event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is
no default behavior to cancel. |
columnIndex | The zero-based index of the column that contains the renderer. |
currentTarget | The object that is actively processing the event object with an event listener. |
index | The zero-based index in the DataProvider that contains the renderer. |
item | A reference to the data that belongs to the renderer. |
rowIndex | The zero-based index of the row that contains the renderer. |
target | The 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_OVER | Constant |
public static const ITEM_ROLL_OVER:String = "itemRollOver"
| Language Version : | ActionScript 3.0 |
| Player Version : | Flash Player 9.0.28.0 |
Defines the value of the type property of an itemRollOver
event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is
no default behavior to cancel. |
columnIndex | The zero-based index of the column that contains the renderer. |
currentTarget | The object that is actively processing the event object with an event listener. |
index | The zero-based index in the DataProvider that contains the renderer. |
item | A reference to the data that belongs to the renderer. |
rowIndex | The zero-based index of the row that contains the renderer. |
target | The 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
To run the example, follow these steps:
package
{
import fl.controls.DataGrid;
import fl.data.DataProvider;
import fl.events.ListEvent;
import flash.display.Sprite;
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);
}
}
}