// Copyright 2007. Adobe Systems Incorporated. All Rights Reserved.
package fl.events {
import flash.events.Event;
/**
* 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.
*
* @see fl.controls.List List
* @see fl.controls.SelectableList SelectableList
*
* @includeExample examples/ListEventExample.as
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
public class ListEvent extends Event {
/**
* 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. |
*
*
* @eventType itemRollOut
*
* @see #ITEM_ROLL_OVER
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
public static const ITEM_ROLL_OUT:String = "itemRollOut";
/**
* 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. |
*
*
* @eventType itemRollOver
*
* @see #ITEM_ROLL_OUT
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
public static const ITEM_ROLL_OVER:String = "itemRollOver";
/**
* 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. |
*
*
* @eventType itemClick
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
public static const ITEM_CLICK:String = "itemClick";
/**
* 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. |
*
*
* @eventType itemDoubleClick
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
public static const ITEM_DOUBLE_CLICK:String = "itemDoubleClick";
/**
* @private (protected)
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
protected var _rowIndex:int;
/**
* @private (protected)
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
protected var _columnIndex:int;
/**
* @private (protected)
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
protected var _index:int;
/**
* @private (protected)
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
protected var _item:Object;
/**
* Creates a new ListEvent object with the specified parameters.
*
* @param type The event type; this value identifies the action that caused the event.
*
* @param bubbles Indicates whether the event can bubble up the display list hierarchy.
*
* @param cancelable Indicates whether the behavior associated with the event can be
* prevented.
*
* @param columnIndex The zero-based index of the column that contains the renderer or visual
* representation of the data in the column.
*
* @param rowIndex The zero-based index of the row that contains the renderer or visual
* representation of the data in the row.
*
* @param index The zero-based index of the item in the DataProvider.
*
* @param item A reference to the data that belongs to the renderer.
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
public function ListEvent(type:String, bubbles:Boolean=false, cancelable:Boolean=false, columnIndex:int=-1, rowIndex:int=-1, index:int=-1, item:Object=null) {
super(type, bubbles, cancelable);
_rowIndex = rowIndex;
_columnIndex = columnIndex;
_index = index;
_item = item;
}
/**
* Gets the row index of the item that is associated with this event.
*
* @see #columnIndex
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
public function get rowIndex():Object {
return _rowIndex;
}
/**
* Gets the column index of the item that is associated with this event.
*
* @see #rowIndex
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
public function get columnIndex():int {
return _columnIndex;
}
/**
* Gets the zero-based index of the cell that contains the renderer.
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
public function get index():int {
return _index;
}
/**
* Gets the data that belongs to the current cell renderer.
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
public function get item():Object {
return _item;
}
/**
* 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]
*
* @return A string representation of the ListEvent object.
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
override public function toString():String {
return formatToString("ListEvent", "type", "bubbles", "cancelable", "columnIndex", "rowIndex", "index", "item");
}
/**
* Creates a copy of the ListEvent object and sets the value of each parameter to match
* the original.
*
* @return A new ListEvent object with parameter values that match those of the original.
*
* @langversion 3.0
* @playerversion Flash 9.0.28.0
*/
override public function clone():Event {
return new ListEvent(type, bubbles, cancelable, _columnIndex, _rowIndex);
}
}
}