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

The IGridItemRenderer interface must be implemented by DataGrid item renderers. The DataGrid uses this API to provide the item renderer with the information needed to render one grid or header cell.

All of the renderer's properties are set during the execution of its parent's updateDisplayList() method. After the properties have been set, the item renderer's prepare() method is called. An IGridItemRenderer implementation should override the prepare() method to make any final adjustments to its properties or any aspect of its visual elements. Typically, the prepare() is used to configure the renderer's visual elements based on the data property.

When an item renderer is no longer needed, either because it's going to be added to an internal reusable renderer "free" list, or because it's never going to be used again, the IGridItemRenderer discard() method is called.

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		alpha : Number 指出所指定物件的 Alpha 透明度值。	IVisualElement
		baseline : Object The vertical distance in pixels from the anchor target to the control's baseline position.	ILayoutElement
		baselinePosition : Number [唯讀] The y-coordinate of the baseline of the first line of text of the component.	ILayoutElement
		bottom : Object The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.	ILayoutElement
		column : GridColumn The GridColumn object representing the column associated with this item renderer.	IGridItemRenderer
		columnIndex : int [唯讀] The column index for this item renderer's cell.	IGridItemRenderer
		data : Object The data to render or edit.	IDataRenderer
		depth : Number Determines the order in which items inside of containers are rendered.	IVisualElement
		designLayer : DesignLayer Specifies the optional DesignLayer instance associated with this visual element.	IVisualElement
		down : Boolean This property is set to true when one of two input gestures occurs within a grid cell: either the mouse button or the touch screen is pressed.	IGridItemRenderer
		dragging : Boolean Contains true if the item renderer is being dragged, typically as part of a drag and drop operation.	IGridItemRenderer
		grid : Grid [唯讀] The Grid associated with this item renderer, typically just the value of column.grid.	IGridItemRenderer
		hasLayoutMatrix3D : Boolean [唯讀] Contains true if the element has 3D Matrix.	ILayoutElement
		height : Number 會指出顯示物件的高度，以像素為單位。	IVisualElement
		horizontalCenter : Object The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.	ILayoutElement
		hovered : Boolean Contains true if the item renderer is under the mouse and the Grid's selectionMode is GridSelectionMode.SINGLE_CELL or GridSelectionMode.MULTIPLE_CELLS, or if the mouse is within the row the item renderer belongs to and the Grid's selectionMode is GridSelectionMode.SINGLE_ROW or GridSelectionMode.MULTIPLE_ROWS.	IGridItemRenderer
		includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container.	ILayoutElement
		is3D : Boolean [唯讀] Contains true when the element is in 3D.	IVisualElement
		label : String The String to display in the item renderer.	IGridItemRenderer
		layoutDirection : String Specifies the desired layout direction for an element: one of LayoutDirection.LTR (left to right), LayoutDirection.RTL (right to left), or null (inherit).	ILayoutDirectionElement
		left : Object The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.	ILayoutElement
		owner : DisplayObjectContainer The owner of this IVisualElement object.	IVisualElement
		parent : DisplayObjectContainer [唯讀] The parent container or component for this component.	IVisualElement
		percentHeight : Number Specifies the height of a component as a percentage of its parent's size.	ILayoutElement
		percentWidth : Number Specifies the width of a component as a percentage of its parent's size.	ILayoutElement
		postLayoutTransformOffsets : mx.geom:TransformOffsets Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.	IVisualElement
		right : Object The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.	ILayoutElement
		rowIndex : int The zero-based index of the row of the cell being rendered.	IGridItemRenderer
		selected : Boolean Contains true if the item renderer's cell is part of the current selection.	IGridItemRenderer
		showsCaret : Boolean Contains true if the item renderer's cell is indicated by the caret.	IGridItemRenderer
		top : Object The vertical distance in pixels from the top edge of the component to the anchor target's top edge.	ILayoutElement
		verticalCenter : Object The vertical distance in pixels from the center of the component to the center of the anchor target's content area.	ILayoutElement
		visible : Boolean Controls the visibility of this visual element.	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 Called from the item renderer parent's updateDisplayList() method when it has been determined that this renderer will no longer be visible.	IGridItemRenderer
		dispatchEvent(event:Event):Boolean 會將事件傳送到事件流程。	IEventDispatcher
		getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size.	ILayoutElement
		getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size.	ILayoutElement
		getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height.	ILayoutElement
		getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width.	ILayoutElement
		getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen.	ILayoutElement
		getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen.	ILayoutElement
		getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings.	ILayoutElement
		getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element.	ILayoutElement
		getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height.	ILayoutElement
		getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width.	ILayoutElement
		getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height.	ILayoutElement
		getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width.	ILayoutElement
		getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height.	ILayoutElement
		getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width.	ILayoutElement
		hasEventListener(type:String):Boolean 會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。	IEventDispatcher
		invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.	ILayoutDirectionElement
		prepare(hasBeenRecycled:Boolean):void Called from the item renderer parent's updateDisplayList() method after all of the renderer's properties have been set.	IGridItemRenderer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 會從 EventDispatcher 物件移除偵聽程式。	IEventDispatcher
		setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen.	ILayoutElement
		setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element.	ILayoutElement
		setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.	ILayoutElement
		setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.	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 A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.	ILayoutElement
		willTrigger(type:String):Boolean 檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。	IEventDispatcher

屬性詳細資訊

column

屬性

column:GridColumn

語言版本:

ActionScript 3.0

產品版本:

Flex 4.5

執行階段版本:

Flash Player 10, AIR 2.5

The GridColumn object representing the column associated with this item renderer.

實作
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

The column index for this item renderer's cell. This is the same value as column.columnIndex.

實作
public function get columnIndex():int

down

屬性

down:Boolean

語言版本:

ActionScript 3.0

產品版本:

Flex 4.5

執行階段版本:

Flash Player 10, AIR 2.5

This property is set to true when one of two input gestures occurs within a grid cell: either the mouse button or the touch screen is pressed. The down property is reset to false when the mouse button goes up, the user lifts off the touch screen, or the mouse/touch is dragged out of the grid cell.

Unlike a List item renderer, grid item renderers do not have exclusive responsibility for displaying the down indicator. The Grid itself renders the down indicator for the selected row or cell. The item renderer can also change its visual properties to emphasize that it's being pressed.

實作
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

Contains true if the item renderer is being dragged, typically as part of a drag and drop operation. Currently, drag and drop is not supported by the Spark DataGrid control.

實作
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

The Grid associated with this item renderer, typically just the value of column.grid.

實作
public function get grid():Grid

hovered

屬性

hovered:Boolean

語言版本:

ActionScript 3.0

產品版本:

Flex 4.5

執行階段版本:

Flash Player 10, AIR 2.5

Contains true if the item renderer is under the mouse and the Grid's selectionMode is GridSelectionMode.SINGLE_CELL or GridSelectionMode.MULTIPLE_CELLS, or if the mouse is within the row the item renderer belongs to and the Grid's selectionMode is GridSelectionMode.SINGLE_ROW or GridSelectionMode.MULTIPLE_ROWS.

Unlike a List item renderer, grid item renderers do not have exclusive responsibility for displaying something to indicate that the renderer or its row is under the mouse. The Grid itself automatically displays the hoverIndicator skin part for the hovered row or cell. Grid item renderers can also change their properties to emphasize that they're hovered.

實作
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

The String to display in the item renderer.

The GridItemRenderer class automatically copies the value of this property to the text property of its labelDisplay element, if that element was specified. The Grid sets the label to the value returned by the column's itemToLabel() method.

實作
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

The zero-based index of the row of the cell being rendered.

實作
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

Contains true if the item renderer's cell is part of the current selection.

Unlike a List item renderer, grid item renderers do not have exclusive responsibility for displaying something to indicate that they're part of the selection. The Grid itself automatically displays the selectionIndicator skin part for the selected rows or cells. The item renderer can also change its visual properties to emphasize that it's part of the selection.

實作
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

Contains true if the item renderer's cell is indicated by the caret.

Unlike a List item renderer, grid item renderers do not have exclusive responsibility for displaying something to indicate their cell or row has the caret. The Grid itself automatically displays the caretIndicator skin part for the caret row or cell. The item renderer can also change its visual properties to emphasize that it has the caret.

實作
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

Called from the item renderer parent's updateDisplayList() method when it has been determined that this renderer will no longer be visible. If the willBeRecycled parameter is true, then the owner adds this renderer to its internal free list for reuse. Implementations can use this method to clear any renderer properties that are no longer needed.

This method is not intended to be called directly. It is called by the DataGrid implementation.

參數

willBeRecycled:Boolean — true if this renderer is going to be added to the owner's internal free list for reuse.

prepare

()

方法

public function prepare(hasBeenRecycled:Boolean):void

語言版本:

ActionScript 3.0

產品版本:

Flex 4.5

執行階段版本:

Flash Player 10, AIR 2.5

Called from the item renderer parent's updateDisplayList() method after all of the renderer's properties have been set. The hasBeenRecycled parameter is false if this renderer has not been used before, meaning it was not recycled. This method is called when a renderer is about to become visible and each time it's redisplayed because of a change in a renderer property, or because a redisplay was explicitly requested.

This method can be used to configure all of a renderer's visual elements and properties. Using this method can be more efficient than binding data properties to visual element properties. Note: Because the prepare() method is called frequently, make sure that it is coded efficiently.

The prepare() method may be called many times before the discard() method is called.

This method is not intended to be called directly. It is called by the DataGrid implementation.

參數

hasBeenRecycled:Boolean — true if this renderer is being reused.

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

IGridItemRenderer - AS3 Flex

類別 x

column

columnIndex

down

dragging

grid

hovered

label

rowIndex

selected

showsCaret

discard

prepare