mx.events

# ListEvent - AS3 Flex

Package | mx.events
Class | public class ListEvent
Inheritance | ListEvent Event Object
Subclasses | MenuEvent

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The ListEvent class represents events associated with items in list-based controls such as List, Tree, Menu, and DataGrid.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

mx.controls.List
mx.controls.listClasses.ListBase

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 The zero-based index of the column that contains the item renderer where the event occurred. | 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
|  | itemRenderer : IListItemRenderer The item renderer where the event occurred. | ListEvent
|  | reason : String The reason the itemEditEnd event was dispatched. | ListEvent
|  | rowIndex : int In the zero-based index of the row that contains the item renderer where the event occured, or for editing events, the index of the item in the data provider that is being edited. | ListEvent
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ListEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, columnIndex:int = -1, rowIndex:int = -1, reason:String = null, itemRenderer:IListItemRenderer = null) Constructor. | ListEvent
|  | clone():Event Duplicates an instance of an Event subclass. | Event
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns a string containing all the properties of the Event object. | Event
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | CHANGE : String = "change" [static] The ListEvent.CHANGE constant defines the value of the type property of the ListEvent object for a change event, which indicates that selection changed as a result of user interaction. | ListEvent
|  | ITEM_CLICK : String = "itemClick" [static] The ListEvent.ITEM_CLICK constant defines the value of the type property of the ListEvent object for an itemClick event, which indicates that the user clicked the mouse over a visual item in the control. | ListEvent
|  | ITEM_DOUBLE_CLICK : String = "itemDoubleClick" [static] The ListEvent.ITEM_DOUBLE_CLICK constant defines the value of the type property of the ListEvent object for an itemDoubleClick event, which indicates that the user double clicked the mouse over a visual item in the control. | ListEvent
|  | ITEM_EDIT_BEGIN : String = "itemEditBegin" [static] The ListEvent.ITEM_EDIT_BEGIN constant defines the value of the type property of the event object for a itemEditBegin event, which indicates that an item is ready to be edited. | ListEvent
|  | ITEM_EDIT_BEGINNING : String = "itemEditBeginning" [static] The ListEvent.ITEM_EDIT_BEGINNING constant defines the value of the type property of the ListEvent object for a itemEditBeginning event, which indicates that the user has prepared to edit an item, for example, by releasing the mouse button over the item. | ListEvent
|  | ITEM_EDIT_END : String = "itemEditEnd" [static] The ListEvent.ITEM_EDIT_END constant defines the value of the type property of the ListEvent object for a itemEditEnd event, which indicates that an edit session is ending. | ListEvent
|  | ITEM_FOCUS_IN : String = "itemFocusIn" [static] The ListEvent.ITEM_FOCUS_IN constant defines the value of the type property of the ListEvent object for an itemFocusIn event, which indicates that an item has received the focus. | ListEvent
|  | ITEM_FOCUS_OUT : String = "itemFocusOut" [static] The ListEvent.ITEM_FOCUS_OUT constant defines the value of the type property of the ListEvent object for an itemFocusOut event, which indicates that an item has lost the focus. | ListEvent
|  | 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

### columnIndex

property

`public var columnIndex:int`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The zero-based index of the column that contains the item renderer where the event occurred.

### itemRenderer

property

`public var itemRenderer:IListItemRenderer`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The item renderer where the event occurred. You can access the data provider item using this property.

### reason

property

`public var reason:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The reason the `itemEditEnd` event was dispatched. Valid only for events with type `ITEM_EDIT_END`. The possible values are defined in the ListEventReason class.

Related API Elements

ListEventReason

### rowIndex

property

`public var rowIndex:int`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

In the zero-based index of the row that contains the item renderer where the event occured, or for editing events, the index of the item in the data provider that is being edited.

Constructor Detail

### ListEvent

()
Constructor

`public function ListEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, columnIndex:int = -1, rowIndex:int = -1, reason:String = null, itemRenderer:IListItemRenderer = null)`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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.
| `columnIndex:int` (default = `-1`)`` — The zero-based index of the column that contains the renderer.
| `rowIndex:int` (default = `-1`)`` — The zero-based index of the row that contains the renderer, or for editing events, the index of the item in the data provider that is being edited
| `reason:String` (default = `null`)`` — The reason for an `itemEditEnd` event.
| `itemRenderer:IListItemRenderer` (default = `null`)`` — The item renderer for the data provider item.

Constant Detail

### CHANGE

Constant

`public static const CHANGE:String = "change"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The ListEvent.CHANGE constant defines the value of the `type` property of the ListEvent object for a `change` event, which indicates that selection changed as a result of user interaction.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`columnIndex` | The zero-based index of the column associated with the event.
`currentTarget` | The 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`.
`itemRenderer` | The item renderer that was clicked.
`reason` | null
`rowIndex` | The zero-based index of the item associated with the event.
`target` | The 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.
`Type` | ListEvent.CHANGE

### ITEM_CLICK

Constant

`public static const ITEM_CLICK:String = "itemClick"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The ListEvent.ITEM_CLICK constant defines the value of the `type` property of the ListEvent object for an `itemClick` event, which indicates that the user clicked the mouse over a visual item in the control.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`columnIndex` | The zero-based index of the column associated with the event.
`currentTarget` | The 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`.
`itemRenderer` | The item renderer that was clicked.
`reason` | null
`rowIndex` | The zero-based index of the item associated with the event.
`target` | The 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.
`Type` | ListEvent.ITEM_CLICK

### ITEM_DOUBLE_CLICK

Constant

`public static const ITEM_DOUBLE_CLICK:String = "itemDoubleClick"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The ListEvent.ITEM_DOUBLE_CLICK constant defines the value of the `type` property of the ListEvent object for an `itemDoubleClick` event, which indicates that the user double clicked the mouse over a visual item in the control.

To receive itemDoubleClick events, you must set the component's `doubleClickEnabled` property to `true`.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`columnIndex` | The zero-based index of the column associated with the event.
`currentTarget` | The 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`.
`itemRenderer` | The item renderer that was double clicked.
`reason` | null
`rowIndex` | The zero-based index of the item associated with the event.
`target` | The 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.
`Type` | ListEvent.ITEM_DOUBLE_CLICK

### ITEM_EDIT_BEGIN

Constant

`public static const ITEM_EDIT_BEGIN:String = "itemEditBegin"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The ListEvent.ITEM_EDIT_BEGIN constant defines the value of the `type` property of the event object for a `itemEditBegin` event, which indicates that an item is ready to be edited.

The default listener for this event performs the following actions:

- Creates an item editor object via a call to the `createItemEditor()` method.
- Copies the `data` property from the item to the editor. By default, the item editor object is an instance of the TextInput control. You use the `itemEditor` property of the list control to specify a custom item editor class.
- Set the `itemEditorInstance` property of the list control to reference the item editor instance.

You can write an event listener for this event to modify the data passed to the item editor. For example, you might modify the data, its format, or other information used by the item editor.

You can also create an event listener to specify the item editor used to edit the item. For example, you might have two different item editors. Within the event listener you can examine the data to be edited or other information, and open the appropriate item editor by doing the following:

1. Call `preventDefault()` to stop Flex from calling the `createItemEditor()` method as part of the default event listener.
2. Set the `itemEditor` property to the appropriate editor.
3. Call the `createItemEditor()` method.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | true
`columnIndex` | The zero-based index of the column associated with the event.
`currentTarget` | The 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`.
`itemRenderer` | The item renderer for the item that is being edited.
`reason` | null
`rowIndex` | The zero-based index of the item associated with the event.
`target` | The 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.
`Type` | ListEvent.ITEM_EDIT_BEGIN

### ITEM_EDIT_BEGINNING

Constant

`public static const ITEM_EDIT_BEGINNING:String = "itemEditBeginning"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The ListEvent.ITEM_EDIT_BEGINNING constant defines the value of the `type` property of the ListEvent object for a `itemEditBeginning` event, which indicates that the user has prepared to edit an item, for example, by releasing the mouse button over the item.

The default listener for this event sets the `List.editedItemPosition` property to the item that has focus, which starts the item editing session.

You typically write your own event listener for this event to disallow editing of a specific item or items. Calling the `preventDefault()` method from within your own event listener for this event prevents the default listener from executing.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | true
`columnIndex` | The zero-based index of the column associated with the event.
`currentTarget` | The 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`.
`itemRenderer` | The item renderer for the item that will be edited. This property is null if this event is generated by keyboard, as the item to be edited may be off-screen.
`reason` | null
`rowIndex` | The zero-based index of the item associated with the event.
`target` | The 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.
`Type` | ListEvent.ITEM_EDIT_BEGIN

### ITEM_EDIT_END

Constant

`public static const ITEM_EDIT_END:String = "itemEditEnd"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The ListEvent.ITEM_EDIT_END constant defines the value of the `type` property of the ListEvent object for a `itemEditEnd` event, which indicates that an edit session is ending.

The list components have a default handler for this event that copies the data from the item editor to the data provider of the list control. The default event listener performs the following actions:

- Uses the `editorDataField` property of the list control to determine the property of the item editor containing the new data and updates the data provider item with that new data. Since the default item editor is the TextInput control, the default value of the `editorDataField` property is `"text"`, to specify that the `text` property of the TextInput contains the new item data.
- Calls the `destroyItemEditor()` method to close the item editor.

You typically write an event listener for this event to perform the following actions:

- In your event listener, you can modify the data returned by the editor to the list component. For example, you can reformat the data before returning it to the list control. By default, an item editor can only return a single value. You must write an event listener for the `itemEditEnd` event if you want to return multiple values.
- In your event listener, you can examine the data entered into the item editor. If the data is incorrect, you can call the `preventDefault()` method to stop Flex from passing the new data back to the list control and from closing the editor.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | true
`columnIndex` | The zero-based index of the column associated with the event.
`currentTarget` | The 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`.
`itemRenderer` | The item renderer for the item that was edited.
`reason` | A constant defining the reason for the event. The value must be a member of the `ListEventReson` class.
`rowIndex` | The zero-based index of the item associated with the event.
`target` | The 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.
`Type` | ListEvent.ITEM_EDIT_END

### ITEM_FOCUS_IN

Constant

`public static const ITEM_FOCUS_IN:String = "itemFocusIn"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The ListEvent.ITEM_FOCUS_IN constant defines the value of the `type` property of the ListEvent object for an `itemFocusIn` event, which indicates that an item has received the focus.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | true
`columnIndex` | The zero-based index of the column associated with the event.
`currentTarget` | The 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`.
`itemRenderer` | The item editor instance for the item that is being edited.
`reason` | null
`rowIndex` | The zero-based index of the item associated with the event.
`target` | The 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.
`Type` | ListEvent.ITEM_FOCUS_IN

### ITEM_FOCUS_OUT

Constant

`public static const ITEM_FOCUS_OUT:String = "itemFocusOut"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The ListEvent.ITEM_FOCUS_OUT constant defines the value of the `type` property of the ListEvent object for an `itemFocusOut` event, which indicates that an item has lost the focus.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`columnIndex` | The zero-based index of the column associated with the event.
`currentTarget` | The 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`.
`itemRenderer` | The item editor instance for the item that was being edited.
`reason` | null
`rowIndex` | The zero-based index of the item associated with the event.
`target` | The 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.
`Type` | ListEvent.ITEM_FOCUS_OUT

### ITEM_ROLL_OUT

Constant

`public static const ITEM_ROLL_OUT:String = "itemRollOut"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`columnIndex` | The zero-based index of the column associated with the event.
`currentTarget` | The 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`.
`itemRenderer` | The item renderer that was rolled out.
`reason` | null
`rowIndex` | The zero-based index of the item associated with the event.
`target` | The 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.
`Type` | ListEvent.ITEM_ROLL_OUT

### ITEM_ROLL_OVER

Constant

`public static const ITEM_ROLL_OVER:String = "itemRollOver"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`columnIndex` | The zero-based index of the column associated with the event.
`currentTarget` | The 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`.
`itemRenderer` | The item renderer that was rolled over.
`reason` | null
`rowIndex` | The zero-based index of the item associated with the event.
`target` | The 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.
`Type` | ListEvent.ITEM_ROLL_OVER

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00