Packagespark.events
Classpublic class GridItemEditorEvent
InheritanceGridItemEditorEvent Inheritance flash.events.Event

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

The GridItemEditorEvent class represents events that are dispatched over the life cycle of an item editor.

The life cycle starts with the dispatch of an GRID_ITEM_EDITOR_SESSION_STARTING event. You can cancel the event to stop the editing session by calling the preventDefault() method in the event listener.

After the item editor opens, the GRID_ITEM_EDITOR_SESSION_START is dispatched to notify listeners that the editor has been opened.

The editing session can be saved or canceled. If the session is saved, then the GRID_ITEM_EDITOR_SESSION_SAVE event is dispatched. If the editor is canceled, a GRID_ITEM_EDITOR_SESSION_CANCEL event is dispatched.

See also

spark.components.DataGrid
spark.components.gridClasses.IGridItemEditor
spark.components.gridClasses.GridColumn
spark.components.gridClasses.GridColumn.itemEditor


Public Properties
 PropertyDefined By
  column : GridColumn
The column of the cell that is being edited.
GridItemEditorEvent
  columnIndex : int
The zero-based index of the column that is being edited.
GridItemEditorEvent
  rowIndex : int
The index of the row that is being edited.
GridItemEditorEvent
Public Methods
 MethodDefined By
  
GridItemEditorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, rowIndex:uint, columnIndex:uint, column:GridColumn = null)
Constructor.
GridItemEditorEvent
Public Constants
 ConstantDefined By
  GRID_ITEM_EDITOR_SESSION_CANCEL : String = gridItemEditorSessionCancel
[static] The GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_CANCEL constant defines the value of the type property of the event object for a cancelridItemEditor event.
GridItemEditorEvent
  GRID_ITEM_EDITOR_SESSION_SAVE : String = gridItemEditorSessionSave
[static] The GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_SAVE constant defines the value of the type property of the event object for a saveGridItemEditor event.
GridItemEditorEvent
  GRID_ITEM_EDITOR_SESSION_START : String = gridItemEditorSessionStart
[static] The GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_START constant defines the value of the type property of the event object for a openGridItemEditor event.
GridItemEditorEvent
  GRID_ITEM_EDITOR_SESSION_STARTING : String = gridItemEditorSessionStarting
[static] The GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_STARTING constant defines the value of the type property of the event object for a startGridItemEditorSession event.
GridItemEditorEvent
Property Detail
columnproperty
public var column:GridColumn

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

The column of the cell that is being edited.

columnIndexproperty 
public var columnIndex:int

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

The zero-based index of the column that is being edited.

rowIndexproperty 
public var rowIndex:int

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

The index of the row that is being edited.

Constructor Detail
GridItemEditorEvent()Constructor
public function GridItemEditorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, rowIndex:uint, columnIndex:uint, column:GridColumn = null)

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

Constructor.

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.
 
rowIndex:uint (default = NaN) — The zero-based index of the column that is being edited.
 
columnIndex:uint (default = NaN) — The zero-based index of the column that is being edited.
 
column:GridColumn (default = null) — The column that is being edited.

See also

Constant Detail
GRID_ITEM_EDITOR_SESSION_CANCELConstant
public static const GRID_ITEM_EDITOR_SESSION_CANCEL:String = gridItemEditorSessionCancel

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

The GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_CANCEL constant defines the value of the type property of the event object for a cancelridItemEditor event. Dispatched after the item editor has been closed without saving its data.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
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.
columnIndexThe zero-based column index of the item that was edited but not modified.
rowIndexThe zero-based row index of the item that was edited but not modified.
columnThe column of the cell that was edited.
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.
type GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_CANCEL

See also

GRID_ITEM_EDITOR_SESSION_SAVEConstant 
public static const GRID_ITEM_EDITOR_SESSION_SAVE:String = gridItemEditorSessionSave

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

The GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_SAVE constant defines the value of the type property of the event object for a saveGridItemEditor event. Dispatched after the data in item editor has been saved into the data provider and the editor has been closed.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
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.
columnIndexThe zero-based column index of the item that was modified.
rowIndexThe zero-based row index of the item that was modified.
columnThe column of the cell that was edited.
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.
type GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_SAVE

See also

GRID_ITEM_EDITOR_SESSION_STARTConstant 
public static const GRID_ITEM_EDITOR_SESSION_START:String = gridItemEditorSessionStart

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

The GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_START constant defines the value of the type property of the event object for a openGridItemEditor event. Dispatched immediately after an item editor has been opened.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
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.
columnIndexThe zero-based column index of the item editor.
rowIndexThe zero-based row index of the item editor.
columnThe column of the cell that is being edited.
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.
type GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_START

See also

GRID_ITEM_EDITOR_SESSION_STARTINGConstant 
public static const GRID_ITEM_EDITOR_SESSION_STARTING:String = gridItemEditorSessionStarting

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

The GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_STARTING constant defines the value of the type property of the event object for a startGridItemEditorSession event. Dispatched when a new item editor session has been requested. A listener can dynamically determine if a cell is editable and cancel the edit by calling the preventDefault() method if it is not. A listener can also dynamically change the editor used by assigning a different item editor to a grid column.

If this event is canceled the item editor will not be created.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
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.
columnIndexThe zero-based column index of the requested item editor.
rowIndexThe zero-based row index of the requested item editor.
columnThe column of the cell associated with the edit request.
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.
type GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_STARTING

See also