Packagemx.events
Classpublic class ListEvent
InheritanceListEvent Inheritance flash.events.Event
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.

See also

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


Public Properties
 PropertyDefined By
  columnIndex : int
The zero-based index of the column that contains the item renderer where the event occurred.
ListEvent
  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
Public Methods
 MethodDefined By
  
ListEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, columnIndex:int = -1, rowIndex:int = -1, reason:String = null, itemRenderer:IListItemRenderer = null)
Constructor.
ListEvent
Public Constants
 ConstantDefined 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
columnIndexproperty
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.

itemRendererproperty 
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.

reasonproperty 
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.

See also

rowIndexproperty 
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
CHANGEConstant
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:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe 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.
itemRendererThe item renderer that was clicked.
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe 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.
TypeListEvent.CHANGE

ITEM_CLICKConstant 
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:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe 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.
itemRendererThe item renderer that was clicked.
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe 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.
TypeListEvent.ITEM_CLICK

ITEM_DOUBLE_CLICKConstant 
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:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe 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.
itemRendererThe item renderer that was double clicked.
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe 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.
TypeListEvent.ITEM_DOUBLE_CLICK

ITEM_EDIT_BEGINConstant 
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:

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:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the column associated with the event.
currentTargetThe 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.
itemRendererThe item renderer for the item that is being edited.
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe 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.
TypeListEvent.ITEM_EDIT_BEGIN

ITEM_EDIT_BEGINNINGConstant 
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:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the column associated with the event.
currentTargetThe 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.
itemRendererThe 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.
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe 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.
TypeListEvent.ITEM_EDIT_BEGIN

ITEM_EDIT_ENDConstant 
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:

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

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the column associated with the event.
currentTargetThe 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.
itemRendererThe item renderer for the item that was edited.
reasonA constant defining the reason for the event. The value must be a member of the ListEventReson class.
rowIndexThe zero-based index of the item associated with the event.
targetThe 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.
TypeListEvent.ITEM_EDIT_END

ITEM_FOCUS_INConstant 
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:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the column associated with the event.
currentTargetThe 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.
itemRendererThe item editor instance for the item that is being edited.
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe 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.
TypeListEvent.ITEM_FOCUS_IN

ITEM_FOCUS_OUTConstant 
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:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe 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.
itemRendererThe item editor instance for the item that was being edited.
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe 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.
TypeListEvent.ITEM_FOCUS_OUT

ITEM_ROLL_OUTConstant 
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:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe 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.
itemRendererThe item renderer that was rolled out.
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe 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.
TypeListEvent.ITEM_ROLL_OUT

ITEM_ROLL_OVERConstant 
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:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the column associated with the event.
currentTargetThe 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.
itemRendererThe item renderer that was rolled over.
reasonnull
rowIndexThe zero-based index of the item associated with the event.
targetThe 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.
TypeListEvent.ITEM_ROLL_OVER