DataGridEvent

套件	mx.events
類別	public class DataGridEvent
繼承	DataGridEvent Event Object

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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.

相關 API 元素

mx.controls.DataGrid

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		bubbles : Boolean [唯讀] 指出事件是否為反昇事件。	Event
		cancelable : Boolean [唯讀] 指出是否可避免與事件相關聯的行為指令。	Event
		columnIndex : int The zero-based index in the DataGrid object's columns array of the column associated with the event.	DataGridEvent
		constructor : Object 類別物件的參照或是特定物件實體的建構函數。	Object
		currentTarget : Object [唯讀] 正主動使用事件偵聽程式處理 Event 物件的物件。	Event
		dataField : String The name of the field or property in the data associated with the column.	DataGridEvent
		eventPhase : uint [唯讀] 事件流程中的目前階段。	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 [唯讀] 事件目標。	Event
		type : String [唯讀] 事件類型。	Event

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		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
		clone():Event 複製 Event 子類別的實體。	Event
		formatToString(className:String, ... arguments):String 公用程式函數，可用來實作自訂 ActionScript 3.0 Event 類別中的 toString() 方法。	Event
		hasOwnProperty(name:String):Boolean 指出物件是否有已定義的指定屬性。	Object
		isDefaultPrevented():Boolean 檢查是否已經對事件呼叫 preventDefault() 方法。	Event
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		preventDefault():void 如果可以取消事件的預設行為指令，則取消該行為指令。	Event
		propertyIsEnumerable(name:String):Boolean 指出指定的屬性是否存在，以及是否可列舉。	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		stopImmediatePropagation():void 避免處理事件流程中，目前節點以及任何後續節點中的任何事件偵聽程式。	Event
		stopPropagation():void 避免處理接續在事件流程中的目前節點之後，後續節點中的任何事件偵聽程式。	Event
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String 傳回包含 Event 物件所有屬性的字串。	Event
		valueOf():Object 會傳回指定之物件的基本值。	Object

公用常數

隱藏繼承公用常數

顯示繼承公用常數

	常數		定義自
		COLUMN_STRETCH : String = "columnStretch" [靜態] 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" [靜態] 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" [靜態] 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" [靜態] 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" [靜態] 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" [靜態] 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" [靜態] 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" [靜態] 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

屬性

public var columnIndex:int

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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

屬性

public var dataField:String

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

The name of the field or property in the data associated with the column.

itemRenderer

屬性

public var itemRenderer:IListItemRenderer

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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

屬性

public var localX:Number

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

The column's x-position; used for replaying column stretch events.

reason

屬性

public var reason:String

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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.

相關 API 元素

DataGridEventReason

rowIndex

屬性

public var rowIndex:int

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

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

建構函式詳細資料

()

建構函式

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)

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

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

參數

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

常數詳細資訊

COLUMN_STRETCH

常數

public static const COLUMN_STRETCH:String = "columnStretch"

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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

常數

public static const HEADER_RELEASE:String = "headerRelease"

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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

常數

public static const ITEM_EDIT_BEGIN:String = "itemEditBegin"

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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

常數

public static const ITEM_EDIT_BEGINNING:String = "itemEditBeginning"

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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

常數

public static const ITEM_EDIT_END:String = "itemEditEnd"

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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

常數

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

常數

public static const ITEM_FOCUS_IN:String = "itemFocusIn"

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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

常數

public static const ITEM_FOCUS_OUT:String = "itemFocusOut"

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

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

法律聲明 | 線上隱私權政策

DataGridEvent - AS3 Flex

類別 x

columnIndex

dataField

itemRenderer

localX

reason

rowIndex

DataGridEvent

COLUMN_STRETCH

HEADER_RELEASE

ITEM_EDIT_BEGIN

ITEM_EDIT_BEGINNING

ITEM_EDIT_END

ITEM_EDITOR_CREATE

ITEM_FOCUS_IN

ITEM_FOCUS_OUT