Packagemx.events
Classpublic class DataGridEvent
InheritanceDataGridEvent Inheritance flash.events.Event

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

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.

See also

mx.controls.DataGrid


Public Properties
 PropertyDefined By
  columnIndex : int
The zero-based index in the DataGrid object's columns array of the column associated with the event.
DataGridEvent
  dataField : String
The name of the field or property in the data associated with the column.
DataGridEvent
  itemRenderer : IListItemRenderer
The item renderer for the item that is being edited or the header render that is being clicked or stretched.
DataGridEvent
  localX : Number
The column's x-position; used for replaying column stretch events.
DataGridEvent
  reason : String
The reason the itemEditEnd event was dispatched.
DataGridEvent
  rowIndex : int
The zero-based index of the item in the data provider.
DataGridEvent
Public Methods
 MethodDefined By
  
DataGridEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, columnIndex:int = -1, dataField:String = null, rowIndex:int = -1, reason:String = null, itemRenderer:IListItemRenderer = null, localX:Number)
Constructor.
DataGridEvent
Public Constants
 ConstantDefined By
  COLUMN_STRETCH : String = columnStretch
[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.
DataGridEvent
  HEADER_RELEASE : String = headerRelease
[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.
DataGridEvent
  ITEM_EDIT_BEGIN : String = itemEditBegin
[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.
DataGridEvent
  ITEM_EDIT_BEGINNING : String = itemEditBeginning
[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.
DataGridEvent
  ITEM_EDIT_END : String = itemEditEnd
[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.
DataGridEvent
  ITEM_EDITOR_CREATE : String = itemEditorCreate
[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.
DataGridEvent
  ITEM_FOCUS_IN : String = itemFocusIn
[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.
DataGridEvent
  ITEM_FOCUS_OUT : String = itemFocusOut
[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
columnIndexproperty
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.

dataFieldproperty 
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.

itemRendererproperty 
public var itemRenderer:IListItemRenderer

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

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.

localXproperty 
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.

reasonproperty 
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.

See also

rowIndexproperty 
public var rowIndex:int

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The zero-based index of the item in the data provider.

Constructor Detail
DataGridEvent()Constructor
public function DataGridEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, columnIndex:int = -1, dataField:String = null, rowIndex:int = -1, reason:String = null, itemRenderer:IListItemRenderer = null, localX:Number)

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Constructor. Normally called by the DataGrid object; not used in application code.

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.
 
columnIndex:int (default = -1) — The zero-based index of the column where the event occurred.
 
dataField:String (default = null) — The name of the field or property in the data associated with the column.
 
rowIndex:int (default = -1) — The zero-based index of the item in the in the data provider.
 
reason:String (default = null) — The reason for an itemEditEnd event.
 
itemRenderer:IListItemRenderer (default = null) — The item renderer that is being edited or the header renderer that was clicked..
 
localX:Number (default = NaN) — Column x-position for replaying columnStretch events.
Constant Detail
COLUMN_STRETCHConstant
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:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
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.
dataFieldThe name of the field or property in the data associated with the column.
itemRenderernull
localXthe x position of the mouse
reasonnull
rowIndexThe zero-based index of the item in the data provider.
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.
typeDataGridEvent.COLUMN_STRETCH

HEADER_RELEASEConstant 
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:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
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.
dataFieldThe name of the field or property in the data associated with the column.
itemRendererThe header renderer that is being released.
localXNaN
reasonnull
rowIndexnull
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.
typeDataGridEvent.HEADER_RELEASE

ITEM_EDIT_BEGINConstant 
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:

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:

  1. Call preventDefault() to stop Flex from calling the createItemEditor() method as part of the default event listener.
  2. Set the itemEditor property to the appropriate editor.
  3. Call the createItemEditor() method.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
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.
dataFieldnull
itemRendererThe item renderer for the item that is being edited.
localXNaN
reasonnull
rowIndexThe zero-based index of the item in the data provider.
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.
typeDataGridEvent.ITEM_EDIT_BEGIN

ITEM_EDIT_BEGINNINGConstant 
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:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
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.
dataFieldThe name of the field or property in the data associated with the item's column.
itemRendererThe 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.
localXNaN
reasonnull
rowIndexThe zero-based index of the item in the data provider.
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.
typeDataGridEvent.ITEM_EDIT_BEGINNING

ITEM_EDIT_ENDConstant 
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:

You typically write an event listener for this event to perform the following actions:

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
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.
dataFieldThe name of the field or property in the data associated with the item's column.
itemRendererThe item renderer for the item that is being edited.
localXNaN
reasonA constant defining the reason for the event. The value must be a member of the DataGridEventReason class.
rowIndexThe zero-based index of the item in the data provider.
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.
typeDataGridEvent.ITEM_EDIT_END

ITEM_EDITOR_CREATEConstant 
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:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
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.
dataFieldnull
itemRenderernull
localXNaN
reasonnull
rowIndexThe zero-based index of the item in the data provider.
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.
typeDataGridEvent.ITEM_EDITOR_CREATE

ITEM_FOCUS_INConstant 
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:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
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.
dataFieldnull
itemRendererThe item editor instance for the item that is being edited.
localXNaN
reasonnull
rowIndexThe zero-based index of the item in the data provider.
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.
typeDataGridEvent.ITEM_FOCUS_IN

ITEM_FOCUS_OUTConstant 
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:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
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.
dataFieldnull
itemRendererThe item editor instance for the item that is being edited.
localXNaN
reasonnull
rowIndexThe zero-based index of the item in the data provider.
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.
typeDataGridEvent.ITEM_FOCUS_OUT