mx.events
public class DataGridEvent
继承DataGridEvent Inheritance Event Inheritance Object

DataGridEvent 类代表特定于 DataGrid 控件的事件对象,例如当可编辑的网格项获得焦点时调度的事件。

另请参见

mx.controls.DataGrid


公共属性
 属性定义方
 Inheritedbubbles : Boolean
[只读 (read-only)] 指示事件是否为冒泡事件。
Event
 Inheritedcancelable : Boolean
[只读 (read-only)] 指示是否可以阻止与事件相关联的行为。
Event
  columnIndex : int
与事件关联的列在 DataGrid 对象的 columns 数组中从零开始的索引。
DataGridEvent
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
 InheritedcurrentTarget : Object
[只读 (read-only)] 当前正在使用某个事件侦听器处理 Event 对象的对象。
Event
  dataField : String
与列关联的数据中的字段或属性的名称。
DataGridEvent
 InheritedeventPhase : uint
[只读 (read-only)] 事件流中的当前阶段。
Event
  itemRenderer : IListItemRenderer
用于正在进行编辑的项目的项目渲染器,或者正在单击或拉伸的标题渲染器。
DataGridEvent
  localX : Number
列的 x 位置;用于重播列拉伸事件。
DataGridEvent
 Inheritedprototype : Object
[静态] 对类或函数对象的原型对象的引用。
Object
  reason : String
调度 itemEditEnd 事件的原因。
DataGridEvent
  rowIndex : int
数据提供者中项目的索引(从零开始)。
DataGridEvent
 Inheritedtarget : Object
[只读 (read-only)] 事件目标。
Event
 Inheritedtype : String
[只读 (read-only)] 事件的类型。
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)
构造函数。
DataGridEvent
 Inherited
复制 Event 子类的实例。
Event
 Inherited
formatToString(className:String, ... arguments):String
用于在自定义 ActionScript 3.0 Event 类中实现 toString() 方法的实用程序函数。
Event
 Inherited
指示对象是否已经定义了指定的属性。
Object
 Inherited
检查是否已对事件调用 preventDefault() 方法。
Event
 Inherited
指示 Object 类的实例是否在指定为参数的对象的原型链中。
Object
 Inherited
如果可以取消事件的默认行为,则取消该行为。
Event
 Inherited
指示指定的属性是否存在、是否可枚举。
Object
 Inherited
设置循环操作动态属性的可用性。
Object
 Inherited
防止对事件流中当前节点中和所有后续节点中的事件侦听器进行处理。
Event
 Inherited
防止对事件流中当前节点的后续节点中的所有事件侦听器进行处理。
Event
 Inherited
返回一个字符串,其中包含 Event 对象的所有属性。
Event
 Inherited
返回指定对象的原始值。
Object
公共常量
 常量定义方
 InheritedACTIVATE : String = "activate"
[静态] ACTIVATE 常量定义 activate 事件对象的 type 属性的值。
Event
 InheritedADDED : String = "added"
[静态] Event.ADDED 常量定义 added 事件对象的 type 属性值。
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[静态] Event.ADDED_TO_STAGE 常量定义 addedToStage 事件对象的 type 属性值。
Event
 InheritedCANCEL : String = "cancel"
[静态] Event.CANCEL 常量定义 cancel 事件对象的 type 属性的值。
Event
 InheritedCHANGE : String = "change"
[静态] Event.CHANGE 常量定义 change 事件对象的 type 属性值。
Event
 InheritedCLEAR : String = "clear"
[静态] Event.CLEAR 常量定义 clear 事件对象的 type 属性的值。
Event
 InheritedCLOSE : String = "close"
[静态] Event.CLOSE 常量定义 close 事件对象的 type 属性的值。
Event
 InheritedAIR-only CLOSING : String = "closing"
[静态] Event.CLOSING 常量定义 closing 事件对象的 type 属性值。
Event
  COLUMN_STRETCH : String = "columnStretch"
[静态] DataGridEvent.COLUMN_STRETCH 常数可为 columnStretch 事件定义事件对象的 type 属性的值,指示用户已将列水平展开。
DataGridEvent
 InheritedCOMPLETE : String = "complete"
[静态] Event.COMPLETE 常量定义 complete 事件对象的 type 属性值。
Event
 InheritedCONNECT : String = "connect"
[静态] Event.CONNECT 常量定义 connect 事件对象的 type 属性值。
Event
 InheritedCOPY : String = "copy"
[静态] 定义 copy 事件对象的 type 属性值。
Event
 InheritedCUT : String = "cut"
[静态] 定义 cut 事件对象的 type 属性值。
Event
 InheritedDEACTIVATE : String = "deactivate"
[静态] Event.DEACTIVATE 常量定义 deactivate 事件对象的 type 属性值。
Event
 InheritedDISPLAYING : String = "displaying"
[静态] Event.DISPLAYING 常量定义 displaying 事件对象的 type 属性值。
Event
 InheritedENTER_FRAME : String = "enterFrame"
[静态] Event.ENTER_FRAME 常量定义 enterFrame 事件对象的 type 属性值。
Event
 InheritedEXIT_FRAME : String = "exitFrame"
[静态] Event.EXIT_FRAME 常量定义 exitFrame 事件对象的 type 属性的值。
Event
 InheritedAIR-only EXITING : String = "exiting"
[静态] Event.EXITING 常量定义 exiting 事件对象的 type 属性值。
Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[静态] Event.FRAME_CONSTRUCTED 常量定义 frameConstructed 事件对象的 type 属性的值。
Event
 InheritedFULLSCREEN : String = "fullScreen"
[静态] Event.FULL_SCREEN 常量定义 fullScreen 事件对象的 type 属性值。
Event
  HEADER_RELEASE : String = "headerRelease"
[静态] DataGridEvent.HEADER_RELEASE 常数可为 headerRelease 事件定义事件对象的 type 属性值,指示用户已在列标题上按下和释放鼠标。
DataGridEvent
 InheritedAIR-only HTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[静态] Event.HTML_BOUNDS_CHANGE 常量定义 htmlBoundsChange 事件对象的 type 属性值。
Event
 InheritedAIR-only HTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[静态] Event.HTML_DOM_INITIALIZE 常量定义 htmlDOMInitialize 事件对象的 type 属性值。
Event
 InheritedAIR-only HTML_RENDER : String = "htmlRender"
[静态] Event.HTML_RENDER 常量定义 htmlRender 事件对象的 type 属性值。
Event
 InheritedID3 : String = "id3"
[静态] Event.ID3 常量定义 id3 事件对象的 type 属性值。
Event
 InheritedINIT : String = "init"
[静态] Event.INIT 常量定义 init 事件对象的 type 属性值。
Event
  ITEM_EDIT_BEGIN : String = "itemEditBegin"
[静态] DataGridEvent.ITEM_EDIT_BEGIN 常数可为 itemEditBegin 事件定义事件对象的 type 属性的值,指示项目可进行编辑。
DataGridEvent
  ITEM_EDIT_BEGINNING : String = "itemEditBeginning"
[静态] DataGridEvent.ITEM__EDIT_BEGINNING 常数可为 itemEditBeginning 事件定义事件对象的 type 属性的值,指示用户已准备编辑项目,例如通过在项目上释放鼠标按键。
DataGridEvent
  ITEM_EDIT_END : String = "itemEditEnd"
[静态] DataGridEvent.ITEM_EDIT_END 常数可为 itemEditEnd 事件定义事件对象的 type 属性的值,指示编辑会话结束。
DataGridEvent
  ITEM_FOCUS_IN : String = "itemFocusIn"
[静态] DataGridEvent.ITEM_FOCUS_IN 常数可为 itemFocusIn 事件定义事件对象的 type 属性的值,指示项目已获得焦点。
DataGridEvent
  ITEM_FOCUS_OUT : String = "itemFocusOut"
[静态] DataGridEvent.ITEM_FOCUS_OUT 常数可为 itemFocusOut 事件定义事件对象的 type 属性的值,指示项目已失去焦点。
DataGridEvent
 InheritedAIR-only LOCATION_CHANGE : String = "locationChange"
[静态] Event.LOCATION_CHANGE 常量定义 locationChange 事件对象的 type 属性值。
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[静态] Event.MOUSE_LEAVE 常量定义 mouseLeave 事件对象的 type 属性值。
Event
 InheritedAIR-only NETWORK_CHANGE : String = "networkChange"
[静态] Event.NETWORK_CHANGE 常量定义 networkChange 事件对象的 type 属性值。
Event
 InheritedOPEN : String = "open"
[静态] Event.OPEN 常量用于定义 open 事件对象的 type 属性值。
Event
 InheritedPASTE : String = "paste"
[静态] Event.PASTE 常量定义 paste 事件对象的 type 属性的值。
Event
 InheritedREMOVED : String = "removed"
[静态] Event.REMOVED 常量定义 removed 事件对象的 type 属性值。
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[静态] Event.REMOVED_FROM_STAGE 常量定义 removedFromStage 事件对象的 type 属性值。
Event
 InheritedRENDER : String = "render"
[静态] Event.RENDER 常量定义 render 事件对象的 type 属性的值。
Event
 InheritedRESIZE : String = "resize"
[静态] Event.RESIZE 常量定义 resize 事件对象的 type 属性的值。
Event
 InheritedSCROLL : String = "scroll"
[静态] Event.SCROLL 常量定义 scroll 事件对象的 type 属性值。
Event
 InheritedSELECT : String = "select"
[静态] Event.SELECT 常量定义 select 事件对象的 type 属性的值。
Event
 InheritedSELECT_ALL : String = "selectAll"
[静态] Event.SELECT_ALL 常量定义 selectAll 事件对象的 type 属性的值。
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[静态] Event.SOUND_COMPLETE 常量定义 soundComplete 事件对象的 type 属性值。
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[静态] Event.TAB_CHILDREN_CHANGE 常量定义 tabChildrenChange 事件对象的 type 属性值。
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[静态] Event.TAB_ENABLED_CHANGE 常量定义 tabEnabledChange 事件对象的 type 属性值。
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[静态] Event.TAB_INDEX_CHANGE 常量定义 tabIndexChange 事件对象的 type 属性值。
Event
 InheritedUNLOAD : String = "unload"
[静态] Event.UNLOAD 常量定义 unload 事件对象的 type 属性值。
Event
 InheritedAIR-only USER_IDLE : String = "userIdle"
[静态] Event.USER_IDLE 常量定义 userIdle 事件对象的 type 属性值。
Event
 InheritedAIR-only USER_PRESENT : String = "userPresent"
[静态] Event.USER_PRESENT 常量定义 userPresent 事件对象的 type 属性值。
Event
属性详细信息
columnIndex属性
public var columnIndex:int

与事件关联的列在 DataGrid 对象的 columns 数组中从零开始的索引。

dataField属性 
public var dataField:String

与列关联的数据中的字段或属性的名称。

itemRenderer属性 
public var itemRenderer:IListItemRenderer

用于正在进行编辑的项目的项目渲染器,或者正在单击或拉伸的标题渲染器。您可以使用此属性访问数据提供程序。

localX属性 
public var localX:Number

列的 x 位置;用于重播列拉伸事件。

reason属性 
public var reason:String

调度 itemEditEnd 事件的原因。仅对类型为 ITEM_EDIT_END 的事件有效。DataGridEventReason 类中定义的可能值。

另请参见

rowIndex属性 
public var rowIndex:int

数据提供者中项目的索引(从零开始)。

构造函数详细信息
DataGridEvent()构造函数
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)

构造函数。通常由 DataGrid 对象调用;不用于应用程序代码。

参数
type:String — 事件类型;指示引发事件的动作。
 
bubbles:Boolean (default = false) — 指定该事件是否可以在显示列表层次结构得到冒泡处理。
 
cancelable:Boolean (default = false) — 指定是否可以防止与事件相关联的行为。
 
columnIndex:int (default = -1) — 发生事件的列的索引(从零开始)。
 
dataField:String (default = null) — 与列关联的数据中的字段或属性的名称。
 
rowIndex:int (default = -1) — 数据提供程序中项目的索引(从零开始)。
 
reason:String (default = null) — 发生 itemEditEnd 事件的原因。
 
itemRenderer:IListItemRenderer (default = null) — 所编辑的项目渲染器或被单击的标题渲染器。
 
localX:Number (default = NaN) — 用于重放 columnStretch 事件的列 x 位置。
常量详细信息
COLUMN_STRETCH常量
public static const COLUMN_STRETCH:String = "columnStretch"

DataGridEvent.COLUMN_STRETCH 常数可为 columnStretch 事件定义事件对象的 type 属性的值,指示用户已将列水平展开。

事件对象的属性有下列值:

属性
bubbles false
cancelable false
columnIndex DataGrid 对象的 columns 数组中项目列的从零开始的索引。
currentTarget 用于定义处理该事件的事件侦听器的 Object。例如,如果您使用 myButton.addEventListener() 注册某个事件侦听器,则 myButton 为 currentTarget 的值。
dataField 与列关联的数据中的字段或属性的名称。
itemRenderer null
localX 鼠标的 X 位置
reason null
rowIndex 数据提供者中项目的索引(从零开始)。
target 调度该事件的 Object;它不一定是侦听该事件的 Object。使用 currentTarget 属性始终可以访问侦听事件的 Object。
type DataGridEvent.COLUMN_STRETCH

HEADER_RELEASE常量 
public static const HEADER_RELEASE:String = "headerRelease"

DataGridEvent.HEADER_RELEASE 常数可为 headerRelease 事件定义事件对象的 type 属性值,指示用户已在列标题上按下和释放鼠标。

事件对象的属性有下列值:

属性
bubbles false
cancelable true
columnIndex DataGrid 对象的 columns 数组中项目列的从零开始的索引。
currentTarget 用于定义处理该事件的事件侦听器的 Object。例如,如果您使用 myButton.addEventListener() 注册某个事件侦听器,则 myButton 为 currentTarget 的值。
dataField 与列关联的数据中的字段或属性的名称。
itemRenderer 要释放的标题渲染器。
localX NaN
reason null
rowIndex null
target 调度该事件的 Object;它不一定是侦听该事件的 Object。使用 currentTarget 属性始终可以访问侦听事件的 Object。
type DataGridEvent.HEADER_RELEASE

ITEM_EDIT_BEGIN常量 
public static const ITEM_EDIT_BEGIN:String = "itemEditBegin"

DataGridEvent.ITEM_EDIT_BEGIN 常数可为 itemEditBegin 事件定义事件对象的 type 属性的值,指示项目可进行编辑。

此事件的默认侦听器执行下列操作:

您可以为此事件编写事件侦听器以修改传递到项目编辑器的数据。例如,您可以修改项目编辑器使用的数据、数据格式或其它信息。

您还可以创建事件侦听器以指定用于编辑项目的项目编辑器。例如,您可能有两个不同的项目编辑器。在事件侦听器中,您可以通过执行下列操作检查要编辑的数据或其它信息,并打开相应的项目编辑器:

  1. 调用 preventDefault() 以阻止 Flex 在默认事件侦听器中调用 createItemEditor() 方法。
  2. itemEditor 属性设置为相应编辑器。
  3. 调用 createItemEditor() 方法。

事件对象的属性有下列值:

属性
bubbles false
cancelable true
columnIndex DataGrid 对象的 columns 数组中项目列的从零开始的索引。
currentTarget 用于定义处理该事件的事件侦听器的 Object。例如,如果您使用 myButton.addEventListener() 注册某个事件侦听器,则 myButton 为 currentTarget 的值。
dataField null
itemRenderer 所编辑的项目的项目渲染器。
localX NaN
reason null
rowIndex 数据提供者中项目的索引(从零开始)。
target 调度该事件的 Object;它不一定是侦听该事件的 Object。使用 currentTarget 属性始终可以访问侦听事件的 Object。
type DataGridEvent.ITEM_EDIT_BEGIN

ITEM_EDIT_BEGINNING常量 
public static const ITEM_EDIT_BEGINNING:String = "itemEditBeginning"

DataGridEvent.ITEM__EDIT_BEGINNING 常数可为 itemEditBeginning 事件定义事件对象的 type 属性的值,指示用户已准备编辑项目,例如通过在项目上释放鼠标按键。

此事件的默认侦听器将 DataGrid.editedItemPosition 属性设置为具有焦点的项目,该项目开始项目编辑会话。

您通常可以为此事件编写自己的事件侦听器,以禁止编辑特定项目。在为此事件自己编写的事件侦听器内调用 preventDefault() 方法可以阻止默认侦听器执行。

事件对象的属性有下列值:

属性
bubbles false
cancelable true
columnIndex DataGrid 对象的 columns 数组中项目列的从零开始的索引。
currentTarget 用于定义处理该事件的事件侦听器的 Object。例如,如果您使用 myButton.addEventListener() 注册某个事件侦听器,则 myButton 为 currentTarget 的值。
dataField 与项目的列关联的数据中的字段或属性的名称。
itemRenderer 要编辑的项目的项目渲染器。如果此事件由键盘生成,则此属性为 null,因为要编辑的项目可能未在屏幕范围内显示。
localX NaN
reason null
rowIndex 数据提供者中项目的索引(从零开始)。
target 调度该事件的 Object;它不一定是侦听该事件的 Object。使用 currentTarget 属性始终可以访问侦听事件的 Object。
type DataGridEvent.ITEM_EDIT_BEGINNING

ITEM_EDIT_END常量 
public static const ITEM_EDIT_END:String = "itemEditEnd"

DataGridEvent.ITEM_EDIT_END 常数可为 itemEditEnd 事件定义事件对象的 type 属性的值,指示编辑会话结束。

列表组件具有针对此事件的默认处理函数,此程序将数据从项目编辑器复制到 list 控件的数据提供程序。默认事件侦听器执行下列操作:

通常,您可以为此事件编写事件侦听器,以执行下列操作:

事件对象的属性有下列值:

属性
bubbles false
cancelable true
columnIndex DataGrid 对象的 columns 数组中项目列的从零开始的索引。
currentTarget 用于定义处理该事件的事件侦听器的 Object。例如,如果您使用 myButton.addEventListener() 注册某个事件侦听器,则 myButton 为 currentTarget 的值。
dataField 与项目的列关联的数据中的字段或属性的名称。
itemRenderer 所编辑的项目的项目渲染器。
localX NaN
reason 定义事件原因的常量。该值必须是 DataGridEventReason 类的成员。
rowIndex 数据提供者中项目的索引(从零开始)。
target 调度该事件的 Object;它不一定是侦听该事件的 Object。使用 currentTarget 属性始终可以访问侦听事件的 Object。
type DataGridEvent.ITEM_EDIT_END

ITEM_FOCUS_IN常量 
public static const ITEM_FOCUS_IN:String = "itemFocusIn"

DataGridEvent.ITEM_FOCUS_IN 常数可为 itemFocusIn 事件定义事件对象的 type 属性的值,指示项目已获得焦点。

事件对象的属性有下列值:

属性
bubbles false
cancelable false
columnIndex DataGrid 对象的 columns 数组中项目列的从零开始的索引。
currentTarget 用于定义处理该事件的事件侦听器的 Object。例如,如果您使用 myButton.addEventListener() 注册某个事件侦听器,则 myButton 为 currentTarget 的值。
dataField null
itemRenderer 所编辑的项目的项目编辑器实例。
localX NaN
reason null
rowIndex 数据提供者中项目的索引(从零开始)。
target 调度该事件的 Object;它不一定是侦听该事件的 Object。使用 currentTarget 属性始终可以访问侦听事件的 Object。
type DataGridEvent.ITEM_FOCUS_IN

ITEM_FOCUS_OUT常量 
public static const ITEM_FOCUS_OUT:String = "itemFocusOut"

DataGridEvent.ITEM_FOCUS_OUT 常数可为 itemFocusOut 事件定义事件对象的 type 属性的值,指示项目已失去焦点。

事件对象的属性有下列值:

属性
bubbles false
cancelable false
columnIndex DataGrid 对象的 columns 数组中项目列的从零开始的索引。
currentTarget 用于定义处理该事件的事件侦听器的 Object。例如,如果您使用 myButton.addEventListener() 注册某个事件侦听器,则 myButton 为 currentTarget 的值。
dataField null
itemRenderer 所编辑的项目的项目编辑器实例。
localX NaN
reason null
rowIndex 数据提供者中项目的索引(从零开始)。
target 调度该事件的 Object;它不一定是侦听该事件的 Object。使用 currentTarget 属性始终可以访问侦听事件的 Object。
type DataGridEvent.ITEM_FOCUS_OUT