Paquete | mx.events |
Clase | public class DataGridEvent |
Herencia | DataGridEvent ![]() ![]() |
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Elementos de API relacionados
Propiedad | Definido por | ||
---|---|---|---|
![]() | bubbles : Boolean [solo lectura]
Indica si un evento es un evento de propagación. | Event | |
![]() | cancelable : Boolean [solo lectura]
Indica si se puede evitar el comportamiento asociado al evento. | Event | |
columnIndex : int
The zero-based index in the DataGrid object's columns array
of the column associated with the event. | DataGridEvent | ||
![]() | constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | Object | |
![]() | currentTarget : Object [solo lectura]
Objeto que procesa de forma activa el objeto de evento con un detector de eventos. | Event | |
dataField : String
The name of the field or property in the data associated with the column. | DataGridEvent | ||
![]() | eventPhase : uint [solo lectura]
La fase actual en el flujo del evento. | Event | |
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 | ||
![]() | target : Object [solo lectura]
El destino del evento. | Event | |
![]() | type : String [solo lectura]
El tipo de evento. | Event |
Método | Definido por | ||
---|---|---|---|
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 = NaN)
Constructor. | DataGridEvent | ||
![]() |
Duplica una instancia de la subclase Event. | Event | |
![]() |
Una función de utilidad para implementar el método toString() en las clases Event personalizadas de ActionScript 3.0. | Event | |
![]() |
Indica si un objeto tiene definida una propiedad especificada. | Object | |
![]() |
Comprueba si se ha llamado a preventDefault() en el evento. | Event | |
![]() |
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | |
![]() |
Cancela el comportamiento predeterminado de un evento si es posible cancelarlo. | Event | |
![]() |
Indica si existe la propiedad especificada y si es enumerable. | Object | |
![]() |
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | |
![]() |
Impide el proceso de cualquier detector de eventos en el nodo actual y los nodos siguientes en el flujo del evento. | Event | |
![]() |
Impide el proceso de cualquier detector de eventos en nodos siguientes al nodo actual. | Event | |
![]() |
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | |
![]() |
Devuelve una cadena que contiene todas las propiedades del objeto de evento. | Event | |
![]() |
Devuelve el valor simple del objeto especificado. | Object |
Constante | Definido por | ||
---|---|---|---|
COLUMN_STRETCH : String = "columnStretch" [estática]
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" [estática]
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" [estática]
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" [estática]
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" [estática]
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" [estática]
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" [estática]
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" [estática]
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 |
columnIndex | propiedad |
public var columnIndex:int
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | 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 | propiedad |
public var dataField:String
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
The name of the field or property in the data associated with the column.
itemRenderer | propiedad |
public var itemRenderer:IListItemRenderer
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | 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.
localX | propiedad |
public var localX:Number
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
The column's x-position; used for replaying column stretch events.
reason | propiedad |
public var reason:String
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | 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.
Elementos de API relacionados
rowIndex | propiedad |
public var rowIndex:int
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
The zero-based index of the item in the data provider.
DataGridEvent | () | Información sobre |
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 = NaN)
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Constructor. Normally called by the DataGrid object; not used in application code.
Parámetrostype: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.
|
COLUMN_STRETCH | Constante |
public static const COLUMN_STRETCH:String = "columnStretch"
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | 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 | Constante |
public static const HEADER_RELEASE:String = "headerRelease"
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | 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 | Constante |
public static const ITEM_EDIT_BEGIN:String = "itemEditBegin"
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | 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 theitemEditor
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 thecreateItemEditor()
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 | Constante |
public static const ITEM_EDIT_BEGINNING:String = "itemEditBeginning"
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | 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 | Constante |
public static const ITEM_EDIT_END:String = "itemEditEnd"
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | 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 theeditorDataField
property is"text"
, to specify that thetext
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 | Constante |
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 | Constante |
public static const ITEM_FOCUS_IN:String = "itemFocusIn"
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | 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 | Constante |
public static const ITEM_FOCUS_OUT:String = "itemFocusOut"
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | 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. |
type | DataGridEvent.ITEM_FOCUS_OUT |
Tue Jun 12 2018, 02:12 PM Z