| Package | spark.events |
| Class | public class GridItemEditorEvent |
| Inheritance | GridItemEditorEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
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.
More examples
Learn more
Related API Elements
spark.components.gridClasses.IGridItemEditor
spark.components.gridClasses.GridColumn
spark.components.gridClasses.GridColumn.itemEditor
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 | |
| 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 | ||
| 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 | |
| rowIndex : int
The index of the row that is being edited. | GridItemEditorEvent | ||
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
| Method | Defined By | ||
|---|---|---|---|
GridItemEditorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, rowIndex:uint = -1, columnIndex:uint = -1, column:GridColumn = null)
Constructor. | GridItemEditorEvent | ||
|
Duplicates an instance of an Event subclass. | Event | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
| Constant | Defined 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 | ||
column | property |
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.
columnIndex | property |
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.
rowIndex | property |
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.
GridItemEditorEvent | () | Constructor |
public function GridItemEditorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, rowIndex:uint = -1, columnIndex:uint = -1, column:GridColumn = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
Constructor.
Parameterstype:String — The event type; indicates the action that caused the event.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
rowIndex:uint (default = -1) | |
columnIndex:uint (default = -1) | |
column:GridColumn (default = null) |
Related API Elements
GRID_ITEM_EDITOR_SESSION_CANCEL | Constant |
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
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. |
columnIndex | The zero-based column index of the item that was edited but not modified. |
rowIndex | The zero-based row index of the item that was edited but not modified. |
column | The column of the cell that was edited. |
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 | GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_CANCEL |
Related API Elements
GRID_ITEM_EDITOR_SESSION_SAVE | Constant |
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
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. |
columnIndex | The zero-based column index of the item that was modified. |
rowIndex | The zero-based row index of the item that was modified. |
column | The column of the cell that was edited. |
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 | GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_SAVE |
Related API Elements
GRID_ITEM_EDITOR_SESSION_START | Constant |
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
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. |
columnIndex | The zero-based column index of the item editor. |
rowIndex | The zero-based row index of the item editor. |
column | The column of the cell that is being edited. |
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 | GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_START |
Related API Elements
GRID_ITEM_EDITOR_SESSION_STARTING | Constant |
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
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. |
columnIndex | The zero-based column index of the requested item editor. |
rowIndex | The zero-based row index of the requested item editor. |
column | The column of the cell associated with the edit request. |
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 | GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_STARTING |
Related API Elements
Mon Apr 10 2017, 12:28 PM -07:00