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

IGridItemRenderer インターフェイスは DataGrid アイテムレンダラーで実装する必要があります。DataGrid では、この API を使用して、1 つのグリッドまたはヘッダーのセルをレンダリングするために必要な情報をアイテムレンダラーに提供します。

レンダラーのプロパティはすべて、親の updateDisplayList() メソッドの実行時に設定されます。プロパティが設定された後に、アイテムレンダラーの prepare() メソッドが呼び出されます。IGridItemRenderer の実装で、prepare() メソッドをオーバーライドして、プロパティやビジュアルエレメントの縦横比を最終調整する必要があります。一般に、prepare() は、data プロパティに基づいて、レンダラーのビジュアルエレメントを設定するために使用します。

再利用可能レンダラーの内部「フリー」リストに追加する場合や再利用される可能性がない場合など、アイテムレンダラーが不要になったら、IGridItemRenderer の discard() メソッドが呼び出されます。

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		alpha : Number 指定されたオブジェクトのアルファ透明度値を示します。	IVisualElement
		baseline : Object アンカーターゲットからコントロールのベースライン位置までの垂直距離（ピクセル単位）です。	ILayoutElement
		baselinePosition : Number [読み取り専用] コンポーネントのテキストにおける 1 行目のベースラインの y 座標です。	ILayoutElement
		bottom : Object コンポーネントの下端からアンカーターゲットの下端までの垂直距離（ピクセル単位）です。	ILayoutElement
		column : GridColumn このアイテムレンダラーに関連付けられている列を表す GridColumn オブジェクトです。	IGridItemRenderer
		columnIndex : int [読み取り専用] このアイテムレンダラーのセルの列インデックスです。	IGridItemRenderer
		data : Object レンダリングまたは編集するデータです。	IDataRenderer
		depth : Number コンテナ内のアイテムのレンダリング順序を決定します。	IVisualElement
		designLayer : DesignLayer このビジュアルエレメントに関連付けるオプションの DesignLayer インスタンスを指定します。	IVisualElement
		down : Boolean グリッドセル内で、2 つの入力ジェスチャのうちの 1 つが行われると、つまりマウスボタンまたはタッチスクリーンのどちらかが押されると、このプロパティが 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 アイテムレンダラーで表示するストリングです。	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 レンダリングされているセルの行の 0 で始まるインデックスです。	IGridItemRenderer
		selected : Boolean アイテムレンダラーのセルが現在の選択範囲に含まれている場合は true が含まれます。	IGridItemRenderer
		showsCaret : Boolean アイテムレンダラーのセルがキャレットで示される場合は true が含まれます。	IGridItemRenderer
		top : Object コンポーネントの上端からアンカーターゲットの上端までの垂直距離（ピクセル単位）です。	ILayoutElement
		verticalCenter : Object コンポーネントの中心からアンカーターゲットのコンテンツ領域の中心までの垂直距離（ピクセル単位）です。	ILayoutElement
		visible : Boolean このビジュアルエレメントの可視性を制御します。	IVisualElement
		width : Number 表示オブジェクトの幅を示します（ピクセル単位）。	IVisualElement
		x : Number 親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの x 座標を示します。	IVisualElement
		y : Number 親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの 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

グリッドセル内で、2 つの入力ジェスチャのうちの 1 つが行われると、つまりマウスボタンまたはタッチスクリーンのどちらかが押されると、このプロパティが true に設定されます。マウスボタンが放されるか、ユーザーがタッチ画面に触れなくなるか、またはマウスやタッチがグリッドセルの外にドラッグされると、down プロパティは false にリセットされます。

List アイテムレンダラーとは異なり、Grid アイテムレンダラーには、ダウンインジケーターを表示する排他的な役割はありません。Grid 自体は、選択された行またはセルのダウンインジケーターをレンダリングします。アイテムレンダラーは、そのビジュアルプロパティを変更して、押下されていることを強調することもできます。

実装
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

アイテムレンダラーで表示するストリングです。

GridItemRenderer クラスは、labelDisplay エレメントが指定されている場合、そのエレメントの 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

レンダリングされているセルの行の 0 で始まるインデックスです。

実装
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 スキンパーツを自動的に表示します。また、アイテムレンダラーは、選択範囲の一部であることを強調するためにビジュアルプロパティを変更できます。

実装
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 スキンパーツを自動的に表示します。また、アイテムレンダラーは、キャレットがあることを強調するためにビジュアルプロパティを変更できます。

実装
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() メソッドは頻繁に呼び出されるため、効率的なコードを書いてください。

prepare() メソッドは、discard() メソッドの呼び出し前に何度も呼び出されることがあります。

このメソッドが直接呼び出されることは意図されていません。このメソッドは、DataGrid の実装によって呼び出されます。

パラメーター

hasBeenRecycled:Boolean — このレンダラーが再利用中である場合は true です。

法律上の注意 | プライバシーポリシー

IGridItemRenderer - AS3 Flex

パッケージx

言語エレメント

付録

パッケージ spark.components.gridClasses

column

columnIndex

down

dragging

grid

hovered

label

rowIndex

selected

showsCaret

discard

prepare