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

包	spark.components.gridClasses
接口	public interface IGridItemRenderer extends IDataRenderer , IVisualElement , ILayoutElement , ILayoutDirectionElement , IEventDispatcher
实现器	DefaultGridItemRenderer, GridItemRenderer, UITextFieldGridItemRenderer

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

DataGrid 项呈示器必须实现 IGridItemRenderer 接口。DataGrid 使用此 API 为项呈示器提供呈示一个网格或标题单元格所需的信息。

呈示器的所有属性都在执行父代的 updateDisplayList() 方法期间设置。设置完属性后，将调用项呈示器的 prepare() 方法。IGridItemRenderer 实现应覆盖 prepare() 方法，从而对其属性或其可视元素的任何方面进行任何最终调整。通常 prepare() 用来基于 data 属性配置呈示器的可视元素。

如果不再需要项呈示器（由于要将它添加到内部可重用呈示器“空闲”列表中或不再需要它），则调用 IGridItemRenderer discard() 方法。

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		alpha : Number 表示指定对象的 Alpha 透明度值。	IVisualElement
		baseline : Object 从锚点目标到控件的基线位置的垂直距离（以像素为单位）。	ILayoutElement
		baselinePosition : Number [只读] 组件第一行文本的基线的 y 坐标。	ILayoutElement
		bottom : Object 从组件的下边缘到锚点目标的下边缘的垂直距离（以像素为单位）。	ILayoutElement
		column : GridColumn 表示与此项呈示器相关联的列的 GridColumn 对象。	IGridItemRenderer
		columnIndex : int [只读] 此项呈示器的单元格的列索引。	IGridItemRenderer
		data : Object 要呈示或编辑的数据。	IDataRenderer
		depth : Number 确定容器内各项目的呈示顺序。	IVisualElement
		designLayer : DesignLayer 指定与该可视元素关联的可选 DesignLayer 实例。	IVisualElement
		down : Boolean 在网格单元格中发生以下两个输入动作之一时，该属性设置为 true：按鼠标按键或按触摸屏。	IGridItemRenderer
		dragging : Boolean 如果正在拖动项呈示器（通常作为拖放操作的一部分），则包含 true。	IGridItemRenderer
		grid : Grid [只读] 与此项呈示器相关联的 Grid，通常是 column.grid 的值。	IGridItemRenderer
		hasLayoutMatrix3D : Boolean [只读] 如果元素具有 3D 矩阵，则为 true。	ILayoutElement
		height : Number 表示显示对象的高度，以像素为单位。	IVisualElement
		horizontalCenter : Object 从组件中心到锚点目标的内容区域中心的水平距离（以像素为单位）。	ILayoutElement
		hovered : Boolean 如果项呈示器位于鼠标下，而 Grid 的 selectionMode 为 GridSelectionMode.SINGLE_CELL 或 GridSelectionMode.MULTIPLE_CELLS，或者如果鼠标在项呈示器所属的行中，而 Grid 的 selectionMode 为 GridSelectionMode.SINGLE_ROW 或 GridSelectionMode.MULTIPLE_ROWS，则包含 true。	IGridItemRenderer
		includeInLayout : Boolean 指定此组件是否包含在父容器的布局中。	ILayoutElement
		is3D : Boolean [只读] 当元素为 3D 时，则为 true。	IVisualElement
		label : String 要在项呈示器中显示的 String。	IGridItemRenderer
		layoutDirection : String 指定元素的所需布局方向：LayoutDirection.LTR（从左到右）、LayoutDirection.RTL（从右到左）或 null（继承）。	ILayoutDirectionElement
		left : Object 从组件的左边缘到锚点目标的左边缘的水平距离（以像素为单位）。	ILayoutElement
		owner : DisplayObjectContainer 此 IVisualElement 对象的所有者。	IVisualElement
		parent : DisplayObjectContainer [只读] 此组件的父容器或组件。	IVisualElement
		percentHeight : Number 以组件父代大小百分比的方式指定组件高度。	ILayoutElement
		percentWidth : Number 以组件父代大小百分比的方式指定组件宽度。	ILayoutElement
		postLayoutTransformOffsets : mx.geom:TransformOffsets 定义能够应用于对象转换且在一定程度上对其父布局不可视的一组调整。	IVisualElement
		right : Object 从组件的右边缘到锚点目标的右边缘的水平距离（以像素为单位）。	ILayoutElement
		rowIndex : int 正在呈示的单元格的从零开始的行索引。	IGridItemRenderer
		selected : Boolean 如果项呈示器的单元格属于当前选定内容，则包含 true。	IGridItemRenderer
		showsCaret : Boolean 如果插入标记指明项呈示器的单元格，则包含 true。	IGridItemRenderer
		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(willBeRecycled:Boolean):void 在已确定此呈示器将不再可见时，从项呈示器父代的 updateDisplayList() 方法调用。	IGridItemRenderer
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	IEventDispatcher
		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(hasBeenRecycled:Boolean):void 在设置了呈示器的所有属性后，从项呈示器父代的 updateDisplayList() 方法调用。	IGridItemRenderer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	IEventDispatcher
		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

表示与此项呈示器相关联的列的 GridColumn 对象。

实现
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

此项呈示器的单元格的列索引。这是与 column.columnIndex 相同的值。

实现
public function get columnIndex():int

down

属性

down:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

在网格单元格中发生以下两个输入动作之一时，该属性设置为 true：按鼠标按键或按触摸屏。当释放鼠标按键、用户的手指离开触摸屏或将鼠标/触摸拖离网格单元格时，down 属性重置为 false。

与 List 项呈示器不同，Grid 项呈示器不专门负责显示按下指示符。Grid 本身为所选行或单元格呈示按下指示符。项呈示器还可以更改其 visual 属性以强调正在按此项呈示器。

实现
public function get down():Boolean
public function set down(value:Boolean):void

dragging

属性

dragging:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

如果正在拖动项呈示器（通常作为拖放操作的一部分），则包含 true。目前，Spark DataGrid 控件不支持拖放操作。

实现
public function get dragging():Boolean
public function set dragging(value:Boolean):void

grid

属性

grid:Grid [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

与此项呈示器相关联的 Grid，通常是 column.grid 的值。

实现
public function get grid():Grid

hovered

属性

hovered:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

如果项呈示器位于鼠标下，而 Grid 的 selectionMode 为 GridSelectionMode.SINGLE_CELL 或 GridSelectionMode.MULTIPLE_CELLS，或者如果鼠标在项呈示器所属的行中，而 Grid 的 selectionMode 为 GridSelectionMode.SINGLE_ROW 或 GridSelectionMode.MULTIPLE_ROWS，则包含 true。

与 List 项呈示器不同，Grid 项呈示器不专门负责显示内容以指明呈示器或其行位于鼠标下。Grid 本身为悬浮行或单元格自动显示 hoverIndicator 外观部件。Grid 项呈示器还可以更改其属性以强调在此项呈示器上悬浮。

实现
public function get hovered():Boolean
public function set hovered(value:Boolean):void

label

属性

label:String

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

要在项呈示器中显示的 String。

如果 labelDisplay 元素已指定，GridItemRenderer 类会自动将该属性的值复制到该元素的 text 属性。Grid 将 label 设置为由列的 itemToLabel() 方法返回的值。

实现
public function get label():String
public function set label(value:String):void

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

selected

属性

selected:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

如果项呈示器的单元格属于当前选定内容，则包含 true。

与 List 项呈示器不同，Grid 项呈示器不专门负责显示内容以指明它们是选定内容的一部分。Grid 本身为选定行或单元格自动显示 selectionIndicator 外观部件。项呈示器还可以更改其 visual 属性以强调它属于选定内容。

实现
public function get selected():Boolean
public function set selected(value:Boolean):void

showsCaret

属性

showsCaret:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

如果插入标记指明项呈示器的单元格，则包含 true。

与 List 项呈示器不同，Grid 项呈示器不专门负责显示内容以指明它们的单元格或行含有插入标记。Grid 本身为插入标记行或单元格自动显示 caretIndicator 外观部件。项呈示器还可以更改其 visual 属性以强调它含有插入标记。

实现
public function get showsCaret():Boolean
public function set showsCaret(value:Boolean):void

方法详细信息

discard

()

方法

public function discard(willBeRecycled:Boolean):void

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

在已确定此呈示器将不再可见时，从项呈示器父代的 updateDisplayList() 方法调用。如果 willBeRecycled 参数设置为 true，则所有者将此呈示器添加到其内部空闲列表以重用。实现可使用此方法清除任何不再需要的呈示器属性。

不可直接调用此方法。它将被 DataGrid 实现调用。

参数

willBeRecycled:Boolean — 如果要将此呈示器添加到所有者的内部空闲列表以重用，则为 true。

prepare

()

方法

public function prepare(hasBeenRecycled:Boolean):void

语言版本:

ActionScript 3.0

产品版本:

Flex 4.5

运行时版本:

Flash Player 10, AIR 2.5

在设置了呈示器的所有属性后，从项呈示器父代的 updateDisplayList() 方法调用。如果以前从未使用过此呈示器，则 hasBeenRecycled 参数为 false，表示此呈示器不可再生。当呈示器将要可见时，每次因呈示器属性更改而重新显示呈示器时，或显式请求重新显示时，调用此方法。

此方法可以用来配置呈示器的所有可视元素和属性。使用此方法与将 data 属性绑定到可视元素属性相比，效率会更高。注意：由于 prepare() 方法经常被调用，因此请确保已对其进行高效编码。

在调用 discard() 方法之前，可能会多次调用 prepare() 方法。

不可直接调用此方法。它将被 DataGrid 实现调用。

参数

hasBeenRecycled:Boolean — 如果正在重用此呈示器，则为 true。

法律声明 | 在线隐私策略

IGridItemRenderer - AS3 Flex

包x

语言元素

附录

包 spark.components.gridClasses

column

columnIndex

down

dragging

grid

hovered

label

rowIndex

selected

showsCaret

discard

prepare