Packagecom.flextras.dataSorter
Classpublic class DataSorterEvent
InheritanceDataSorterEvent Inheritance ListEvent Inheritance flash.events.Event
ImplementsIDataRenderer

DataSorterEvent Overview

The DataSorterEvent class is the container for events in the DataSorter component

See also

com.flextras.dataSorter.DataSorter

Public Properties
 PropertyDefined by
  data : Object
The data property contains the element of your dataProvider that the event was performed on
DataSorterEvent
 InheriteditemRenderer : IListItemRenderer
The item renderer where the event occurred.
ListEvent
 InheritedrowIndex : 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
  
DataSorterEvent(type:String, argData:Object, bubbles:Boolean = false, cancelable:Boolean = false, rowIndex:int = -1, itemRenderer:IListItemRenderer = null)
Constructor.
DataSorterEvent
Public Constants
 ConstantDefined by
 InheritedCHANGE : 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
 InheritedITEM_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_DELETE : String = "itemDelete"
[static] The DataSorterEvent.ITEM_DELETE constant defines the value of the type property of the DataSorterEvent object for an ITEM_DELETE event, which indicates that the user clicked the delete button.
DataSorterEvent
 InheritedITEM_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
 InheritedITEM_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
 InheritedITEM_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
 InheritedITEM_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
 InheritedITEM_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
 InheritedITEM_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_MOVEDOWN : String = "itemMoveDown"
[static] The DataSorterEvent.ITEM_MOVEDOWN constant defines the value of the type property of the DataSorterEvent object for an ITEM_MOVEDOWN event, which indicates that the user clicked the move down button.
DataSorterEvent
  ITEM_MOVETOBOTTOM : String = "itemMoveToBottom"
[static] The DataSorterEvent.ITEM_MOVETOBOTTOM constant defines the value of the type property of the DataSorterEvent object for an ITEM_MOVETOBOTTOM event, which indicates that the user clicked the move to bottom button.
DataSorterEvent
  ITEM_MOVETOTOP : String = "itemMoveToTop"
[static] The DataSorterEvent.ITEM_MOVETOTOP constant defines the value of the type property of the DataSorterEvent object for an ITEM_MOVETOTOP event, which indicates that the user clicked the move to top button.
DataSorterEvent
  ITEM_MOVEUP : String = "itemMoveUp"
[static] The DataSorterEvent.ITEM_MOVEUP constant defines the value of the type property of the DataSorterEvent object for an ITEM_MOVEUP event, which indicates that the user clicked the move up button.
DataSorterEvent
 InheritedITEM_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
 InheritedITEM_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
dataproperty
data:Object  [read-write]

The data property contains the element of your dataProvider that the event was performed on

Implementation
    public function get data():Object
    public function set data(value:Object):void
Constructor detail
DataSorterEvent()constructor
public function DataSorterEvent(type:String, argData:Object, bubbles:Boolean = false, cancelable:Boolean = false, rowIndex:int = -1, itemRenderer:IListItemRenderer = null)

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.
 
argData:Object — The event data; indicates the item from the dataProvider that this event was operated upon; you could also get to this using itemRenderer.data ; but this makes it easier .
 
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.
 
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
 
itemRenderer:IListItemRenderer (default = null) — The item renderer for the data provider item.
Constant detail
ITEM_DELETEconstant
public static const ITEM_DELETE:String = "itemDelete"

The DataSorterEvent.ITEM_DELETE constant defines the value of the type property of the DataSorterEvent object for an ITEM_DELETE event, which indicates that the user clicked the delete button.

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.
TypeDataSorterEvent.ITEM_DELETE
ITEM_MOVEDOWNconstant 
public static const ITEM_MOVEDOWN:String = "itemMoveDown"

The DataSorterEvent.ITEM_MOVEDOWN constant defines the value of the type property of the DataSorterEvent object for an ITEM_MOVEDOWN event, which indicates that the user clicked the move down button.

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.
TypeDataSorterEvent.ITEM_MOVEDOWN
ITEM_MOVETOBOTTOMconstant 
public static const ITEM_MOVETOBOTTOM:String = "itemMoveToBottom"

The DataSorterEvent.ITEM_MOVETOBOTTOM constant defines the value of the type property of the DataSorterEvent object for an ITEM_MOVETOBOTTOM event, which indicates that the user clicked the move to bottom button.

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.
TypeDataSorterEvent.ITEM_MOVETOBOTTOM
ITEM_MOVETOTOPconstant 
public static const ITEM_MOVETOTOP:String = "itemMoveToTop"

The DataSorterEvent.ITEM_MOVETOTOP constant defines the value of the type property of the DataSorterEvent object for an ITEM_MOVETOTOP event, which indicates that the user clicked the move to top button.

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.
TypeDataSorterEvent.ITEM_MOVETOTOP
ITEM_MOVEUPconstant 
public static const ITEM_MOVEUP:String = "itemMoveUp"

The DataSorterEvent.ITEM_MOVEUP constant defines the value of the type property of the DataSorterEvent object for an ITEM_MOVEUP event, which indicates that the user clicked the move up button.

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.
TypeDataSorterEvent.ITEM_MOVEUP