IGridItemEditor - Adobe ActionScript® 3 (AS3 Flex) API 参考

包	spark.components.gridClasses
接口	public interface IGridItemEditor extends IDataRenderer , IVisualElement , IFocusManagerComponent , IIMESupport , ILayoutElement , ILayoutDirectionElement , IEventDispatcher
实现器	GridItemEditor

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

IGridItemEditor 接口定义 Spark DataGrid 和 Spark Grid 控件的项编辑器必须实现的接口。将 DataGrid 和 Grid 控件引用为项呈示器所有者或项编辑器的主机组件。

项编辑器的所有属性都由所有者在启动编辑器会话期间设置。data 属性是最后一个设置的属性。在设置 data 属性之后，项编辑器应设置编辑器控件的值。然后，调用编辑器的 prepare() 方法。IGridItemEditor 实现应覆盖 prepare() 方法，从而对其属性或其可视元素的任何方面进行任何最终调整。在关闭编辑器时，将调用 discard() 方法。

在关闭编辑器时，可以保存或取消输入的值。如果保存，编辑器将调用 save() 函数以在与已编辑的单元格的行相对应的数据提供程序元素中写入新值。

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		alpha : Number 表示指定对象的 Alpha 透明度值。	IVisualElement
		baseline : Object 从锚点目标到控件的基线位置的垂直距离（以像素为单位）。	ILayoutElement
		baselinePosition : Number [只读] 组件第一行文本的基线的 y 坐标。	ILayoutElement
		bottom : Object 从组件的下边缘到锚点目标的下边缘的垂直距离（以像素为单位）。	ILayoutElement
		column : GridColumn 正在编辑的单元格的列。	IGridItemEditor
		columnIndex : int [只读] 正在编辑的从零开始的列索引。	IGridItemEditor
		data : Object 要呈示或编辑的数据。	IDataRenderer
		dataGrid : DataGrid [只读] 拥有此项编辑器的控件。	IGridItemEditor
		depth : Number 确定容器内各项目的呈示顺序。	IVisualElement
		designLayer : DesignLayer 指定与该可视元素关联的可选 DesignLayer 实例。	IVisualElement
		enableIME : Boolean [只读] 指定当该组件获得焦点时，是否应启用 IME。	IIMESupport
		focusEnabled : Boolean 一个标志，用于指示组件处于选中状态时是否可以获得焦点。	IFocusManagerComponent
		hasFocusableChildren : Boolean 一个标志，指示子对象是否能够获得焦点。	IFocusManagerComponent
		hasLayoutMatrix3D : Boolean [只读] 如果元素具有 3D 矩阵，则为 true。	ILayoutElement
		height : Number 表示显示对象的高度，以像素为单位。	IVisualElement
		horizontalCenter : Object 从组件中心到锚点目标的内容区域中心的水平距离（以像素为单位）。	ILayoutElement
		imeMode : String 组件的 IME 模式。	IIMESupport
		includeInLayout : Boolean 指定此组件是否包含在父容器的布局中。	ILayoutElement
		is3D : Boolean [只读] 当元素为 3D 时，则为 true。	IVisualElement
		layoutDirection : String 指定元素的所需布局方向：LayoutDirection.LTR（从左到右）、LayoutDirection.RTL（从右到左）或 null（继承）。	ILayoutDirectionElement
		left : Object 从组件的左边缘到锚点目标的左边缘的水平距离（以像素为单位）。	ILayoutElement
		mouseFocusEnabled : Boolean [只读] 一个标志，用于当使用鼠标选中组件时组件是否可以获得焦点。	IFocusManagerComponent
		owner : DisplayObjectContainer 此 IVisualElement 对象的所有者。	IVisualElement
		parent : DisplayObjectContainer [只读] 此组件的父容器或组件。	IVisualElement
		percentHeight : Number 以组件父代大小百分比的方式指定组件高度。	ILayoutElement
		percentWidth : Number 以组件父代大小百分比的方式指定组件宽度。	ILayoutElement
		postLayoutTransformOffsets : mx.geom:TransformOffsets 定义能够应用于对象转换且在一定程度上对其父布局不可视的一组调整。	IVisualElement
		right : Object 从组件的右边缘到锚点目标的右边缘的水平距离（以像素为单位）。	ILayoutElement
		rowIndex : int 正在编辑的单元格的从零开始的行索引。	IGridItemEditor
		tabFocusEnabled : Boolean [只读] 一个标志，指示通过按 Tab 键最终是否能够将焦点移动到此组件。	IFocusManagerComponent
		tabIndex : int 如果 tabFocusEnabled 为 true，则为组件获得焦点的顺序。	IFocusManagerComponent
		top : Object 从组件的上边缘到锚点目标的上边缘的垂直距离（以像素为单位）。	ILayoutElement
		verticalCenter : Object 从组件中心到锚点目标的内容区域中心的垂直距离（以像素为单位）。	ILayoutElement
		visible : Boolean 控制此可视元素的可见性。	IVisualElement
		width : Number 表示显示对象的宽度，以像素为单位。	IVisualElement
		x : Number 表示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 x 坐标。	IVisualElement
		y : Number 表示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 y 坐标。	IVisualElement

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	IEventDispatcher
		discard():void 恰好在关闭编辑器之前调用。	IGridItemEditor
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	IEventDispatcher
		drawFocus(isFocused:Boolean):void 当组件获得焦点时，由 FocusManager 调用。	IFocusManagerComponent
		getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number 按指定的元素大小，返回元素边界的 x 坐标。	ILayoutElement
		getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number 按指定的元素大小，返回元素边界的 y 坐标。	ILayoutElement
		getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number 返回元素的布局高度。	ILayoutElement
		getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number 返回元素的布局宽度。	ILayoutElement
		getLayoutBoundsX(postLayoutTransform:Boolean = true):Number 返回元素在屏幕上进行绘制时所用的 x 坐标。	ILayoutElement
		getLayoutBoundsY(postLayoutTransform:Boolean = true):Number 返回元素在屏幕上进行绘制时所用的 y 坐标。	ILayoutElement
		getLayoutMatrix():Matrix 返回用于相对于其同级组件计算组件的布局的转换矩阵。	ILayoutElement
		getLayoutMatrix3D():Matrix3D 返回此元素的布局转换 Matrix3D。	ILayoutElement
		getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number 返回元素的最大高度。	ILayoutElement
		getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number 返回元素的最大宽度。	ILayoutElement
		getMinBoundsHeight(postLayoutTransform:Boolean = true):Number 返回元素的最小高度。	ILayoutElement
		getMinBoundsWidth(postLayoutTransform:Boolean = true):Number 返回元素的最小宽度。	ILayoutElement
		getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number 返回元素的首选高度。	ILayoutElement
		getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number 返回元素的首选宽度。	ILayoutElement
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	IEventDispatcher
		invalidateLayoutDirection():void 当某元素的 layoutDirection 更改或其父代的 layoutDirection 更改时，该元素必须调用该方法。	ILayoutDirectionElement
		prepare():void 在已创建编辑器并设置其大小之后，而编辑器可见之前调用。	IGridItemEditor
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	IEventDispatcher
		save():Boolean 将编辑器中的值保存到项呈示器所有者的数据提供程序中。	IGridItemEditor
		setFocus():void 当组件获得焦点时，由 FocusManager 调用。	IFocusManagerComponent
		setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void 设置元素在屏幕上进行绘制时所用的坐标。	ILayoutElement
		setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void 设置元素的布局大小。	ILayoutElement
		setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void 设置用于相对于其同级组件计算组件的布局大小和位置的转换 Matrix。	ILayoutElement
		setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void 设置用于计算组件相对于其同级组件的布局大小和位置的转换 Matrix3D。	ILayoutElement
		transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void 用于更新转换的旋转、缩放和平移的一种实用程序方法，同时保留某个特定点，该点是在组件自己的坐标空间中指定的，且在父项的坐标空间中是固定的。	ILayoutElement
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	IEventDispatcher

属性详细信息

column

属性

column:GridColumn

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

正在编辑的单元格的列。

实现
public function get column():GridColumn
public function set column(value:GridColumn):void

columnIndex

属性

columnIndex:int [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

正在编辑的从零开始的列索引。

实现
public function get columnIndex():int

dataGrid

属性

dataGrid:DataGrid [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

拥有此项编辑器的控件。

实现
public function get dataGrid():DataGrid

rowIndex

属性

rowIndex:int

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

正在编辑的单元格的从零开始的行索引。

实现
public function get rowIndex():int
public function set rowIndex(value:int):void

方法详细信息

discard

()

方法

public function discard():void

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

恰好在关闭编辑器之前调用。使用此方法执行任何最后清理，如清理在 prepare() 方法中设置的任何内容。

无需直接调用此方法。应仅由承载项编辑器的控件来调用。

prepare

()

方法

public function prepare():void

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

在已创建编辑器并设置其大小之后，而编辑器可见之前调用。在编辑器可见之前，使用此方法调整编辑器的外观、添加事件侦听器或执行任何其它初始化。

无需直接调用此方法。应仅由承载项编辑器的控件来调用。

save

()

方法

public function save():Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

将编辑器中的值保存到项呈示器所有者的数据提供程序中。此方法更新与已编辑的单元格的行相对应的数据提供程序元素。此函数调用 GridItemEditor.validate() 以验证是否可以保存数据。如果数据无效，则不保存数据，且不关闭编辑器。

无需直接调用此方法。应仅由承载项编辑器的控件来调用。要保存并关闭编辑器，请调用项呈示器所有者的 endItemEditorSession() 方法。

Boolean — 如果保存操作成功，则为 true，否则为 false。

IGridItemEditor - AS3 Flex

包x

语言元素

附录

包 spark.components.gridClasses

column

columnIndex

dataGrid

rowIndex

discard

prepare

save