The DataGridEvent class represents event objects that are specific to
the DataGrid control, such as the event that is dispatched when an
editable grid item gets the focus.
[static]
The DataGridEvent.COLUMN_STRETCH constant defines the value of the
type property of the event object for a
columnStretch event, which indicates that a
user expanded a column horizontally.
[static]
The DataGridEvent.HEADER_RELEASE constant defines the value of the
type property of the event object for a
headerRelease event, which indicates that the
user pressed and released the mouse on a column header.
[static]
The DataGridEvent.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.
[static]
The DataGridEvent.ITEM__EDIT_BEGINNING constant defines the value of the
type property of the event 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.
[static]
The DataGridEvent.ITEM_EDIT_END constant defines the value of the
type property of the event object for a
itemEditEnd event, which indicates that an edit
session is ending.
[static]
The DataGridEvent.ITEM_EDITOR_CREATE constant defines the value of the
type property of the event object for a
itemEditorCreate event, which indicates that the datagrid has
completed the creation of the item editor.
[static]
The DataGridEvent.ITEM_FOCUS_IN constant defines the value of the
type property of the event object for a
itemFocusIn event, which indicates that an
item has received the focus.
[static]
The DataGridEvent.ITEM_FOCUS_OUT constant defines the value of the
type property of the event object for a
itemFocusOut event, which indicates that an
item has lost the focus.
DataGridEvent
Property Detail
columnIndex
property
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 in the DataGrid object's columns array
of the column associated with the event.
dataField
property
public var dataField:String
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The name of the field or property in the data associated with the column.
The item renderer for the item that is being edited or the header
render that is being clicked or stretched.
You can access the data provider item using this property.
localX
property
public var localX:Number
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The column's x-position; used for replaying column stretch events.
reason
property
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 DataGridEventReason class.
public static const COLUMN_STRETCH:String = columnStretch
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The DataGridEvent.COLUMN_STRETCH constant defines the value of the
type property of the event object for a
columnStretch event, which indicates that a
user expanded a column horizontally.
The properties of the event object have the following values:
Property
Value
bubbles
false
cancelable
false
columnIndex
The zero-based index of the
item's column in the DataGrid object's columns array.
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.
dataField
The name of the field or property in the
data associated with the column.
itemRenderer
null
localX
the x position of the mouse
reason
null
rowIndex
The zero-based index of the
item in the data provider.
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
DataGridEvent.COLUMN_STRETCH
HEADER_RELEASE
Constant
public static const HEADER_RELEASE:String = headerRelease
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The DataGridEvent.HEADER_RELEASE constant defines the value of the
type property of the event object for a
headerRelease event, which indicates that the
user pressed and released the mouse on a column header.
The properties of the event object have the following values:
Property
Value
bubbles
false
cancelable
true
columnIndex
The zero-based index of the
item's column in the DataGrid object's columns array.
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.
dataField
The name of the field or property in the
data associated with the column.
itemRenderer
The header renderer that is
being released.
localX
NaN
reason
null
rowIndex
null
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
DataGridEvent.HEADER_RELEASE
ITEM_EDIT_BEGIN
Constant
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 DataGridEvent.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:
Creates an item editor object by using a call to the
createItemEditor() method.
Copies the data property
from the item to the editor. By default, the item editor object is an instance
of the TextInput control. You use the itemEditor property of the
list control to specify a custom item editor class.
Set the itemEditorInstance property of the list control
to reference the item editor instance.
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:
Call preventDefault() to stop Flex from calling
the createItemEditor() method as part
of the default event listener.
Set the itemEditor property to the appropriate editor.
Call the createItemEditor() method.
The properties of the event object have the following values:
Property
Value
bubbles
false
cancelable
true
columnIndex
The zero-based index of the
item's column in the DataGrid object's columns array.
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.
dataField
null
itemRenderer
The item renderer for the item
that is being edited.
localX
NaN
reason
null
rowIndex
The zero-based index of the
item in the data provider.
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
DataGridEvent.ITEM_EDIT_BEGIN
ITEM_EDIT_BEGINNING
Constant
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 DataGridEvent.ITEM__EDIT_BEGINNING constant defines the value of the
type property of the event 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 DataGrid.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:
Property
Value
bubbles
false
cancelable
true
columnIndex
The zero-based index of the
item's column in the DataGrid object's columns array.
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.
dataField
The name of the field or property in the
data associated with the item's column.
itemRenderer
The 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.
localX
NaN
reason
null
rowIndex
The zero-based index of the
item in the data provider.
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
DataGridEvent.ITEM_EDIT_BEGINNING
ITEM_EDIT_END
Constant
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 DataGridEvent.ITEM_EDIT_END constant defines the value of the
type property of the event 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:
Uses the editorDataField property of the DataGridColumn
associated with this event to
determine the property of the item editor containing the new data and updates
the data provider item with that new data.
Since the default item editor is the TextInput control, the default value of the
editorDataField property
is "text", to specify that the text property of the
TextInput contains the new item data.
Calls the destroyItemEditor() method to close the item editor.
You typically write an event listener for this event to perform the following actions:
In your event listener, you can modify the data returned by the editor
to the list component. For example, you can reformat the data before returning
it to the list control. By default, an item editor can only return a single value.
You must write an event listener for the itemEditEnd event
if you want to return multiple values.
In your event listener, you can examine the data entered into the item editor.
If the data is incorrect, you can call the preventDefault() method
to stop Flex from passing the new data back to the list control and from closing
the editor.
The properties of the event object have the following values:
Property
Value
bubbles
false
cancelable
true
columnIndex
The zero-based index of the
item's column in the DataGrid object's columns array.
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.
dataField
The name of the field or property in the
data associated with the item's column.
itemRenderer
The item renderer for the item
that is being edited.
localX
NaN
reason
A constant defining the reason for the event.
The value must be a member of the DataGridEventReason class.
rowIndex
The zero-based index of the
item in the data provider.
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
DataGridEvent.ITEM_EDIT_END
ITEM_EDITOR_CREATE
Constant
public static const ITEM_EDITOR_CREATE:String = itemEditorCreate
The DataGridEvent.ITEM_EDITOR_CREATE constant defines the value of the
type property of the event object for a
itemEditorCreate event, which indicates that the datagrid has
completed the creation of the item editor.
There is no default listener for this event.
You typically write your own event listener for this event to allow
custom modifications to the itemEditor before the user can
begin editing.
The properties of the event object have the following values:
Property
Value
bubbles
false
cancelable
true
columnIndex
The zero-based index of the
item's column in the DataGrid object's columns array.
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.
dataField
null
itemRenderer
null
localX
NaN
reason
null
rowIndex
The zero-based index of the
item in the data provider.
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
DataGridEvent.ITEM_EDITOR_CREATE
ITEM_FOCUS_IN
Constant
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 DataGridEvent.ITEM_FOCUS_IN constant defines the value of the
type property of the event object for a
itemFocusIn event, which indicates that an
item has received the focus.
The properties of the event object have the following values:
Property
Value
bubbles
false
cancelable
false
columnIndex
The zero-based index of the
item's column in the DataGrid object's columns array.
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.
dataField
null
itemRenderer
The item editor instance for the item
that is being edited.
localX
NaN
reason
null
rowIndex
The zero-based index of the
item in the data provider.
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
DataGridEvent.ITEM_FOCUS_IN
ITEM_FOCUS_OUT
Constant
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 DataGridEvent.ITEM_FOCUS_OUT constant defines the value of the
type property of the event object for a
itemFocusOut event, which indicates that an
item has lost the focus.
The properties of the event object have the following values:
Property
Value
bubbles
false
cancelable
false
columnIndex
The zero-based index of the
item's column in the DataGrid object's columns array.
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.
dataField
null
itemRenderer
The item editor instance for the item
that is being edited.
localX
NaN
reason
null
rowIndex
The zero-based index of the
item in the data provider.
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.