| Package | fl.events |
| Class | public class ListEvent |
| Inheritance | ListEvent  Event Object |
| Subclasses | DataGridEvent |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.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.
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| 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 | |
Public Methods
| 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 | ||
[override]
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 custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method 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 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 | ||
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| ACTIVATE : String = "activate" [static]
The ACTIVATE constant defines the value of the type property of an activate event object. | Event | |
| ADDED : String = "added" [static]
The Event.ADDED constant defines the value of the type property of
an added event object. | Event | |
| ADDED_TO_STAGE : String = "addedToStage" [static]
The Event.ADDED_TO_STAGE constant defines the value of the type
property of an addedToStage event object. | Event | |
| CANCEL : String = "cancel" [static]
The Event.CANCEL constant defines the value of the type property of a cancel event object. | Event | |
| CHANGE : String = "change" [static]
The Event.CHANGE constant defines the value of the type property of a change event object. | Event | |
| CLEAR : String = "clear" [static]
The Event.CLEAR constant defines the value of the type property
of a clear event object. | Event | |
| CLOSE : String = "close" [static]
The Event.CLOSE constant defines the value of the type property of a close event object. | Event | |
| CLOSING : String = "closing" [static]
The Event.CLOSING constant defines the value of the
type property of a closing event object. | Event | |
| COMPLETE : String = "complete" [static]
The Event.COMPLETE constant defines the value of the type property of a complete event object. | Event | |
| CONNECT : String = "connect" [static]
The Event.CONNECT constant defines the value of the type property of a connect event object. | Event | |
| CONTEXT3D_CREATE : String = "context3DCreate" [static]
The Event.CONTEXT3D_CREATE constant defines the value of the type
property of a context3Dcreate event object. | Event | |
| COPY : String = "copy" [static]
Defines the value of the type property of a copy event object. | Event | |
| CUT : String = "cut" [static]
Defines the value of the type property of a cut event object. | Event | |
| DEACTIVATE : String = "deactivate" [static]
The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. | Event | |
| DISPLAYING : String = "displaying" [static]
The Event.DISPLAYING constant defines the value of the type property of a displaying event object. | Event | |
| ENTER_FRAME : String = "enterFrame" [static]
The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object. | Event | |
| EXIT_FRAME : String = "exitFrame" [static]
The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object. | Event | |
| EXITING : String = "exiting" [static]
The Event.EXITING constant defines the value of the type property of an exiting event object. | Event | |
| FRAME_CONSTRUCTED : String = "frameConstructed" [static]
The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object. | Event | |
| FULLSCREEN : String = "fullScreen" [static]
The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. | Event | |
| HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static]
The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object. | Event | |
| HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static]
The Event.HTML_DOM_INITIALIZE constant defines the value of the type property
of an htmlDOMInitialize event object. | Event | |
| HTML_RENDER : String = "htmlRender" [static]
The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object. | Event | |
| ID3 : String = "id3" [static]
The Event.ID3 constant defines the value of the type property of an id3 event object. | Event | |
| INIT : String = "init" [static]
The Event.INIT constant 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 | ||
| LOCATION_CHANGE : String = "locationChange" [static]
The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object. | Event | |
| MOUSE_LEAVE : String = "mouseLeave" [static]
The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object. | Event | |
| NETWORK_CHANGE : String = "networkChange" [static]
The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object. | Event | |
| OPEN : String = "open" [static]
The Event.OPEN constant defines the value of the type property of an open event object. | Event | |
| PASTE : String = "paste" [static]
The Event.PASTE constant defines the value of the type property of a paste event object. | Event | |
| PREPARING : String = "preparing" [static]
The Event.PREPARING constant defines the value of the type property of a preparing event object. | Event | |
| REMOVED : String = "removed" [static]
The Event.REMOVED constant defines the value of the type property of
a removed event object. | Event | |
| REMOVED_FROM_STAGE : String = "removedFromStage" [static]
The Event.REMOVED_FROM_STAGE constant defines the value of the type
property of a removedFromStage event object. | Event | |
| RENDER : String = "render" [static]
The Event.RENDER constant defines the value of the type property of a render event object. | Event | |
| RESIZE : String = "resize" [static]
The Event.RESIZE constant defines the value of the type property of a resize event object. | Event | |
| SCROLL : String = "scroll" [static]
The Event.SCROLL constant defines the value of the type property of a scroll event object. | Event | |
| SELECT : String = "select" [static]
The Event.SELECT constant defines the value of the type property of a select event object. | Event | |
| SELECT_ALL : String = "selectAll" [static]
The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object. | Event | |
| SOUND_COMPLETE : String = "soundComplete" [static]
The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object. | Event | |
| STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static]
The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object. | Event | |
| STANDARD_INPUT_CLOSE : String = "standardInputClose" [static]
The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object. | Event | |
| STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static]
The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object. | Event | |
| TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object. | Event | |
| TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
The Event.TAB_ENABLED_CHANGE constant defines the value of the type
property of a tabEnabledChange event object. | Event | |
| TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
The Event.TAB_INDEX_CHANGE constant defines the value of the
type property of a tabIndexChange event object. | Event | |
| TEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange" [static]
The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of an interaction mode event object. | Event | |
| UNLOAD : String = "unload" [static]
The Event.UNLOAD constant defines the value of the type property of an unload event object. | Event | |
| USER_IDLE : String = "userIdle" [static]
The Event.USER_IDLE constant defines the value of the type property of a userIdle event object. | Event | |
| USER_PRESENT : String = "userPresent" [static]
The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object. | Event | |
Property Detail
columnIndex | property |
index | property |
item | property |
rowIndex | property |
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.
Parameterstype:String — The event type; this value identifies the action that caused the event.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
columnIndex:int (default = -1) | |
rowIndex:int (default = -1) | |
index:int (default = -1) | |
item:Object (default = null) |
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.
ReturnsEvent — 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]
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:
| 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 |
| 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:
| 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 |
| 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:
| 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. |
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:
| 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. |
Related API Elements
Examples How to use this example
ListEventExample.as
This example demonstrates how to use the ListEvent class to determine the row and column of an item within a data grid.
- Add the DataGrid component to the library.
- Save this code as ListEventExample.as in the same directory as your FLA.
- 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);
}
}
}
Mon Nov 28 2011, 06:48 AM -08:00