GridColumn

パッケージ	spark.components.gridClasses
クラス	public class GridColumn
継承	GridColumn EventDispatcher Object

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

GridColumn クラスは、Spark DataGrid または Grid コントロールなどの Spark グリッドコントロールの列を定義します。コントロールの各データプロバイダーアイテムは、グリッドの 1 行に対応します。 GridColumn クラスは、列に値が表示されるデータプロバイダーアイテムのフィールドを指定します。また、このクラスでは、その値を表示するために使用されるアイテムレンダラー、値を変更するために使用されるアイテムエディター、および列の他のプロパティも指定します。

MXML シンタックス expanded

MXML シンタックスを隠す

The <s:GridColumn> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

  <s:GridColumn
    Properties
    dataField="null"
    dataTipField="null"
    dataTipFormatter="null"
    dataTipFunction="null"
    editable="true"
    formatter="null"
    headerRenderer="null"
    headerText="value of dataField"
    imeMode="null"
    itemEditor="null"
    itemRenderer="null"
    itemRendererFunction="null"
    labelFunction="null"
    maxWidth="NaN"
    minWidth="20"
    rendererIsEditable="false"
    resizeable="true"
    showDataTips="undefined"
    sortable="true"
    sortCompareFunction="null"
    sortDescending="false"
    visible="true"
    width="NaN"
  />

例を表示

パブリックプロパティ

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

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

	プロパティ		定義元
		columnIndex : int [読み取り専用] グリッドの列リストにおけるこの列の場所、またはこの列のグリッドが null である場合は -1 です。	GridColumn
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		dataField : String 列に関連付けられているデータプロバイダーアイテム内のフィールドまたはプロパティの名前です。	GridColumn
		dataTipField : String データヒントとして表示するデータプロバイダー内のフィールドの名前です。	GridColumn
		dataTipFormatter : IFormatter データプロバイダーアイテムをストリングに変換するために、列の itemToDataTip() メソッドで使用されるフォーマッターを指定します。	GridColumn
		dataTipFunction : Function データヒントを決定するためにデータプロバイダーの各アイテムで実行するコールバック関数を指定します。	GridColumn
		editable : Boolean 列のアイテムが編集可能かどうかを示します。	GridColumn
		formatter : IFormatter データプロバイダーアイテムをストリングに変換するために、列の itemToLabel() メソッドで使用されるフォーマッターを指定します。	GridColumn
		grid : Grid [読み取り専用] この列に関連付けられている Grid オブジェクトです。	GridColumn
		headerRenderer : IFactory この列のヘッダーとして使用される IGridItemRenderer クラスのクラスファクトリです。	GridColumn
		headerText : String この列のヘッダーのテキストです。	GridColumn
		imeMode : String IME（入力メソッドエディター）のモードを指定します。	GridColumn
		itemEditor : IFactory この列の個々のグリッドセルを編集するために使用される IGridItemEditor クラスのクラスファクトリです。	GridColumn
		itemRenderer : IFactory 個々のグリッドセルをレンダリングするために使用される IGridItemRenderer クラスのクラスファクトリです。	GridColumn
		itemRendererFunction : Function 指定する場合、このプロパティの値は、データプロバイダーアイテムおよび列パラメーターに基づいてアイテムレンダラーの IFactory を返す冪等関数にする必要があります。	GridColumn
		labelFunction : Function データプロバイダーアイテムを、アイテムレンダラーの label プロパティの初期化に使用される列固有のストリングに変換する冪等関数です。	GridColumn
		maxWidth : Number この列の最大幅（ピクセル単位）です。	GridColumn
		minWidth : Number この列の最小幅（ピクセル単位）です。	GridColumn
		rendererIsEditable : Boolean アイテムレンダラーのコントロールのいずれかが編集可能かどうかを判別します。	GridColumn
		resizable : Boolean 列の幅をユーザーが変更できるかどうかを示します。	GridColumn
		showDataTips : * 列にデータヒントが表示されるかどうかを示します。	GridColumn
		sortable : Boolean このプロパティが true の場合、グリッドのデータプロバイダーが ICollectionView の場合、および関連付けられているグリッドの sortableColumns プロパティが true の場合、この列ではインタラクティブソートがサポートされます。	GridColumn
		sortCompareFunction : Function この列のデータエレメントに関してソートを実行するときに 2 つのエレメントを比較する関数です。	GridColumn
		sortDescending : Boolean true の場合、この列は降順でソートされます。	GridColumn
		sortField : SortField [読み取り専用] この列の dataField を基準にしてコレクションをソートするために使用できる SortField を返します。	GridColumn
		visible : Boolean true の場合、この列を表示します。	GridColumn
		width : Number この列の幅（ピクセル単位）です。	GridColumn

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		GridColumn(columnName:String = null) コンストラクターです。	GridColumn
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		itemToDataTip(item:Object):String 指定されたデータプロバイダーアイテムを列固有のデータヒントストリングに変換します。	GridColumn
		itemToLabel(item:Object):String 指定されたデータプロバイダーアイテムを列固有のストリングに変換します。	GridColumn
		itemToRenderer(item:Object):IFactory 指定されたデータプロバイダーアイテムを列固有のアイテムレンダラーファクトリに変換します。	GridColumn
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

イベント

イベントの詳細についてはここをクリックしてください

継承されるイベントを隠す

継承されるイベントを表示

	イベント		概要	定義元
		activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
		deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher

パブリック定数

	定数		定義元
		ERROR_TEXT : String = "unknown" [静的] 対応するプロパティ名（パス）の解決に失敗した場合の、itemToLabel() または itemToDataTip() メソッドの戻り値です。	GridColumn

プロパティの詳細

columnIndex

プロパティ

columnIndex:int [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

グリッドの列リストにおけるこの列の場所、またはこの列のグリッドが null である場合は -1 です。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 columnIndexChanged イベントが送出されます。

実装
public function get columnIndex():int

dataField

プロパティ

dataField:String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

列に関連付けられているデータプロバイダーアイテム内のフィールドまたはプロパティの名前です。各 GridColumn では、アイテムレンダラーで表示できるテキストを計算するために、このプロパティまたは labelFunction プロパティが設定されている必要があります。 dataField プロパティおよび labelFunction プロパティが設定されている場合、データは labelFunction を使用して表示され、dataField を使用してソートされます。

このプロパティのこの値は、必ずしも列ヘッダーに表示されるストリングであるとは限りません。このプロパティは、データプロバイダーのデータにアクセスする目的でのみ使用します。詳細については、headerText プロパティを参照してください。

列または列のグリッドで labelFunction が指定されている場合、dataField は使用されません。

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 dataFieldChanged イベントが送出されます。

実装
public function get dataField():String
public function set dataField(value:String):void

関連する API エレメント

itemToLabel
labelFunction

dataTipField

プロパティ

dataTipField:String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

データヒントとして表示するデータプロバイダー内のフィールドの名前です。デフォルトでは、showDataTips が true の場合、関連付けられているグリッドコントロールは、各データプロバイダーアイテムで label という名前のプロパティを検索して表示します。ただし、データプロバイダーに label プロパティが存在しない場合は、dataTipField プロパティを設定して別のプロパティ名を指定できます。例えば、データベースに含まれる一連の人物名がユーザーに表示される場合には、値を "FullName" に設定できます。

GridColumn.dataTipField はこのプロパティよりも優先されます。

この列または列のグリッドで dataTipFunction プロパティの値が指定されている場合、dataTipField プロパティは無視されます。

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 dataTipFieldChanged イベントが送出されます。

実装
public function get dataTipField():String
public function set dataTipField(value:String):void

関連する API エレメント

dataTipFunction
itemToDataTip

dataTipFormatter

プロパティ

dataTipFormatter:IFormatter

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

データプロバイダーアイテムをストリングに変換するために、列の itemToDataTip() メソッドで使用されるフォーマッターを指定します。

フォーマッターの styleParent が指定されなかった場合は列のグリッドに設定されて、グリッドの locale スタイルをフォーマッターが継承するようになります。

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 dataTipFormatterChanged イベントが送出されます。

実装
public function get dataTipFormatter():IFormatter
public function set dataTipFormatter(value:IFormatter):void

関連する API エレメント

itemToDataTip
formatter

dataTipFunction

プロパティ

dataTipFunction:Function

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

データヒントを決定するためにデータプロバイダーの各アイテムで実行するコールバック関数を指定します。このプロパティは itemToDataTip メソッドで使用します。

デフォルトでは、showDataTips が true の場合、各データプロバイダーアイテムで label という名前のプロパティが検索され、その値がデータヒントとして表示されます。ただし、データプロバイダーによっては、label プロパティが存在せず、また行にデータを表示するために使用できる別のプロパティも存在しない場合があります。

例えば、フルネームをデータヒントとして表示したい場合に、データプロバイダーに lastName フィールドと firstName フィールドが別々に存在しているケースが考えられます。このような場合は、両方のフィールドの値を単一のストリングとして返す関数を dataTipFunction プロパティに指定します。また、フォーマットとローカライズを処理するために dataTipFunction プロパティを使用することもできます。

dataTipFunction 関数の署名は、次と一致する必要があります。

dataTipFunction(item:Object, column:GridColumn):String

item パラメーターは、行全体に対するデータプロバイダーアイテムです。 2 つ目のパラメーターはこの列オブジェクトです。

通常の関数は、アイテムの firstName および lastName プロパティを連結するか、Date 値のプロパティに対してカスタム書式を適用します。

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 dataTipFunctionChanged イベントが送出されます。

実装
public function get dataTipFunction():Function
public function set dataTipFunction(value:Function):void

関連する API エレメント

itemToDataTip
dataTipField

editable

プロパティ

editable:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

列のアイテムが編集可能かどうかを示します。このプロパティが true で、関連付けられているグリッドの editable プロパティも true であれば、列内のアイテムは編集可能です。選択したアイテムをクリックするか、アイテムに移動して F2 キーを押すことにより、アイテムを個別に編集できます。

デフォルト値： true。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 editableChanged イベントが送出されます。

実装
public function get editable():Boolean
public function set editable(value:Boolean):void

formatter

プロパティ

formatter:IFormatter

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

データプロバイダーアイテムをストリングに変換するために、列の itemToLabel() メソッドで使用されるフォーマッターを指定します。

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 formatterChanged イベントが送出されます。

実装
public function get formatter():IFormatter
public function set formatter(value:IFormatter):void

関連する API エレメント

itemToLabel
dataTipFormatter

grid

プロパティ

grid:Grid [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

この列に関連付けられている Grid オブジェクトです。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 gridChanged イベントが送出されます。

実装
public function get grid():Grid

headerRenderer

プロパティ

headerRenderer:IFactory

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

この列のヘッダーとして使用される IGridItemRenderer クラスのクラスファクトリです。指定しない場合、DataGrid コントロールの columnHeaderGroup スキンパーツはデフォルトのヘッダーレンダラーを定義します。

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 headerRendererChanged イベントが送出されます。

実装
public function get headerRenderer():IFactory
public function set headerRenderer(value:IFactory):void

関連する API エレメント

headerText
IGridItemRenderer

headerText

プロパティ

headerText:String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

この列のヘッダーのテキストです。デフォルトでは、関連付けられているグリッドコントロールは dataField プロパティの値をヘッダーテキストとして使用します。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 headerTextChanged イベントが送出されます。

実装
public function get headerText():String
public function set headerText(value:String):void

imeMode

プロパティ

imeMode:String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

IME（入力メソッドエディター）のモードを指定します。IME を使用することによって、ユーザーは中国語、日本語、および韓国語のテキストを入力できます。Flex では、コントロールにフォーカスが置かれたときに、IME を指定されたモードに設定し、コントロールからフォーカスが離れたときに、元のモードに戻します。

このプロパティで有効な値の定数は、flash.system.IMEConversionMode クラスで定義されています。IME を指定しない場合は、null を指定します。

デフォルト値： null。

実装
public function get imeMode():String
public function set imeMode(value:String):void

関連する API エレメント

flash.system.IMEConversionMode

itemEditor

プロパティ

itemEditor:IFactory

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

この列の個々のグリッドセルを編集するために使用される IGridItemEditor クラスのクラスファクトリです。このプロパティが null であり、列のグリッドのオーナーが DataGrid コントロールの場合、DataGrid コントロールの itemEditor プロパティの値が使用されます。 DataGrid コントロールでアイテムエディターが指定されていない場合は、DefaultGridItemEditor クラスを使用します。

デフォルトのアイテムエディターは DefaultGridItemEditor クラスです。これは単純なテキストフィールドを編集可能にします。 GridItemEditor クラスのサブクラスを作成することによって、カスタムアイテムレンダラーを作成できます。カスタムアイテムエディターでは、データをグリッドの行全体に書き込み、より複雑なエディターを定義できます。

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 itemEditorChanged イベントが送出されます。

実装
public function get itemEditor():IFactory
public function set itemEditor(value:IFactory):void

itemRenderer

プロパティ

itemRenderer:IFactory

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

個々のグリッドセルをレンダリングするために使用される IGridItemRenderer クラスのクラスファクトリです。指定しない場合、関連付けられているグリッドコントロールの itemRenderer プロパティの値を使用します。

デフォルトのアイテムレンダラーは DefaultGridItemRenderer クラスです。これはデータアイテムをテキストとして表示します。 GridItemRenderer クラスのサブクラスを作成することによって、カスタムアイテムレンダラーを作成できます。カスタムアイテムレンダラーでは、グリッドの行全体のデータにアクセスして、セルについてより複雑な視覚的表現を定義できます。

デフォルト値は、関連付けられているグリッドコントロールの itemRenderer プロパティの値か、または null です。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 itemRendererChanged イベントが送出されます。

実装
public function get itemRenderer():IFactory
public function set itemRenderer(value:IFactory):void

itemRendererFunction

プロパティ

itemRendererFunction:Function

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

指定する場合、このプロパティの値は、データプロバイダーアイテムおよび列パラメーターに基づいてアイテムレンダラーの IFactory を返す冪等関数にする必要があります。itemRendererFunction プロパティに対する値を指定すると、この列で複数のアイテムレンダラーを使用できるようになります。

itemRendererFunction プロパティに対して指定する関数には次のシグネチャが必要です。

itemRendererFunction(item:Object, column:GridColumn):IFactory

item パラメーターは、行全体に対するデータプロバイダーアイテムです。 2 つ目のパラメーターはこの列オブジェクトです。

次に、アイテムレンダラー関数の例を示します。

      function myItemRendererFunction(item:Object, column:GridColumn):IFactory
      {
          return (item is Array) ? myArrayItemRenderer : myItemRenderer;
      }

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 itemRendererFunctionChanged イベントが送出されます。

実装
public function get itemRendererFunction():Function
public function set itemRendererFunction(value:Function):void

labelFunction

プロパティ

labelFunction:Function

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

データプロバイダーアイテムを、アイテムレンダラーの label プロパティの初期化に使用される列固有のストリングに変換する冪等関数です。

ラベル関数を使用して、複数のデータプロバイダーアイテムの値を単一のストリングとして組み合わせることができます。指定する場合、このプロパティは itemToLabel() メソッドで使用されます。このメソッドは、この列内の各アイテムレンダラーの label プロパティの値を計算します。

labelFunction プロパティに対して指定する関数には次のシグネチャが必要です。

labelFunction(item:Object, column:GridColumn):String

item パラメーターは、行全体に対するデータプロバイダーアイテムです。 2 つ目のパラメーターはこの列オブジェクトです。

一般的なラベル関数は、データプロバイダーアイテムの firstName および lastName プロパティを連結するか、Date 値のプロパティに対してカスタム書式を適用します。

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 labelFunctionChanged イベントが送出されます。

実装
public function get labelFunction():Function
public function set labelFunction(value:Function):void

関連する API エレメント

itemToLabel
dataField

maxWidth

プロパティ

maxWidth:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

この列の最大幅（ピクセル単位）です。指定する場合、グリッドのレイアウトにより、列のレイアウト幅が typicalItem および maxWidth のうちの小さい方の幅になります。この列がサイズ変更可能な場合、このプロパティによって、ユーザーがこの列に指定できる幅の上限が設定されます。このプロパティを設定しても、width および minWidth プロパティはいずれも変更されません。

デフォルト値： NaN。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 maxWidthChanged イベントが送出されます。

実装
public function get maxWidth():Number
public function set maxWidth(value:Number):void

minWidth

プロパティ

minWidth:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

この列の最小幅（ピクセル単位）です。指定する場合、グリッドのレイアウトにより、列のレイアウト幅が typicalItem および minWidth のうちの大きい方の幅になります。この列がサイズ変更可能な場合、このプロパティによって、ユーザーがこの列に指定できる幅の下限が指定されます。このプロパティを設定しても、width および maxWidth プロパティのいずれも変更されません。

デフォルト値： 20。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 minWidthChanged イベントが送出されます。

実装
public function get minWidth():Number
public function set minWidth(value:Number):void

rendererIsEditable

プロパティ

rendererIsEditable:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

アイテムレンダラーのコントロールのいずれかが編集可能かどうかを判別します。列が編集可能な場合、ユーザーがアイテムレンダラーの編集を開始すると、アイテムレンダラーのフォーカス可能コントロールにはキーボードフォーカスが設定されます。

このプロパティを true に設定すれば、ユーザーがセルの中をクリックするとセルが編集可能になります。セルが編集可能なため、DataGrid は editorIndicator スキンパーツを表示します。このスキンパーツは selectionIndicator スキンパーツの上に表示されます。そのため、編集セッションが完了するまで、セルの選択範囲のインジケーターがユーザーから見えなくなります。editorIndicator スキンパーツを削除または変更するカスタムスキンを作成すれば、selectionIndicator スキンパーツを表示できます。例えば、editorIndicator の alpha プロパティを設定して selectionIndicator が透けて見えるようにしたり、セルより小さくなるように editorIndicator のサイズを変更したりできます。

このプロパティを true に設定すると、アイテムレンダラーによって収集される入力の検証および保存はユーザーが行うこととなります。アイテムレンダラーに IGridItemRenderer.prepare() メソッドのオーバーライドが含まれている場合、未保存の入力フィールドの変更が上書きされないようにする必要があります。例えば、rendererIsEditable が true であり、レンダラーには data.myDataField の値を表示する単一の TextInput エレメントが含まれます。レンダラーの prepare() メソッドが TextInput コントロールの text プロパティを設定する場合、保留中の変更が存在しているとき、prepare() メソッドが text プロパティを設定しないようにする必要があります。

デフォルト値： false。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 rendererIsEditableChanged イベントが送出されます。

実装
public function get rendererIsEditable():Boolean
public function set rendererIsEditable(value:Boolean):void

resizable

プロパティ

resizable:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

列の幅をユーザーが変更できるかどうかを示します。このプロパティが true であり、関連付けられているグリッドの resizableColumns プロパティも true である場合、ユーザーは列ヘッダー間のグリッド線をドラッグして列のサイズを変更できます。

デフォルト値： true。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 resizableChanged イベントが送出されます。

実装
public function get resizable():Boolean
public function set resizable(value:Boolean):void

showDataTips

プロパティ

showDataTips:*

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

列にデータヒントが表示されるかどうかを示します。true の場合、行のテキストに対してデータヒントが表示されます。データヒントは、長すぎて行に収まらないテキストを表示するためのツールヒントです。

このプロパティの値が undefined（デフォルト）の場合、関連付けられているグリッドの showDataTips プロパティによってデータヒントが表示されるかどうかが決まります。このプロパティが設定されている場合、グリッドの showDataTips プロパティは無視されます。

デフォルト値： undefined。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 showDataTipsChanged イベントが送出されます。

実装
public function get showDataTips():*
public function set showDataTips(value:any):void

関連する API エレメント

getShowDataTips

sortable

プロパティ

sortable:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

このプロパティが true の場合、グリッドのデータプロバイダーが ICollectionView の場合、および関連付けられているグリッドの sortableColumns プロパティが true の場合、この列ではインタラクティブソートがサポートされます。通常、列のヘッダーでは、データプロバイダーの sort プロパティを Sort オブジェクト（SortField がこの列の dataField であるもの）に設定することによって、マウスクリックを処理します。

データプロバイダーが ICollectionView でない場合、このプロパティは無視されます。

デフォルト値： true。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 sortableChanged イベントが送出されます。

実装
public function get sortable():Boolean
public function set sortable(value:Boolean):void

sortCompareFunction

プロパティ

sortCompareFunction:Function

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

この列のデータエレメントに関してソートを実行するときに 2 つのエレメントを比較する関数です。labelFunction プロパティの値を指定する場合、通常、sortCompareFunction も指定します。

sortCompareFunction のシグネチャは次と一致する必要があります。

sortCompareFunction(obj1:Object, obj2:Object, column:GridColumn):int

この関数はオブジェクトの比較に基づいて次のような値を返す必要があります。

昇順で obj1 が obj2 よりも先に出現する場合は -1。
obj1 と obj2 が同じ場合は 0。
昇順で obj1 が obj2 よりも後で出現する場合は 1。

関数は、列パラメーターを使用して、一般的な比較関数を記述できます。

メモ：obj1 パラメーターと obj2 パラメーターはデータプロバイダーエレメント全体です。特定のアイテムのデータではありません。

dataProvider が ICollectionView でない場合、このプロパティは無視されます。

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 sortCompareFunctionChanged イベントが送出されます。

実装
public function get sortCompareFunction():Function
public function set sortCompareFunction(value:Function):void

sortDescending

プロパティ

sortDescending:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

true の場合、この列は降順でソートされます。例えば、列の dataField に数値が含まれている場合、この列の最大値を持つ列が最初の行となります。

このプロパティを設定してもソートは実行されません。ソート方向のみが設定されます。 dataProvider.refresh() メソッドが呼び出されると、ソートが実行されます。

データプロバイダーが ICollectionView でない場合、このプロパティは無視されます。

デフォルト値： false。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 sortDescendingChanged イベントが送出されます。

実装
public function get sortDescending():Boolean
public function set sortDescending(value:Boolean):void

sortField

プロパティ

sortField:SortField [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

この列の dataField を基準にしてコレクションをソートするために使用できる SortField を返します。

sortCompareFunction プロパティが定義されている場合は、SortField の compareFunction が自動的に設定されます。

sortCompareFunction プロパティが定義されておらず、dataField が複雑な場合、SortField の比較関数は、複雑な dataField を処理するデフォルトの比較関数を囲む閉包に割り当てられます。

sortCompareFunction および dataField プロパティが定義されておらず、labelFunction プロパティが定義されている場合、compareFunction は、データオブジェクトに適用される labelFunction に対して基本的なストリング比較を実行する閉包に割り当てられます。

実装
public function get sortField():SortField

関連する API エレメント

spark.collections.SortField

visible

プロパティ

visible:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

true の場合、この列を表示します。 false の場合、この列には領域が割り当てられず、レイアウトに含められません。

デフォルト値： true。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 visibleChanged イベントが送出されます。

実装
public function get visible():Boolean
public function set visible(value:Boolean):void

width

プロパティ

width:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

この列の幅（ピクセル単位）です。指定する場合、グリッドのレイアウトではその typicalItem プロパティとこの列の minWidth および maxWidth プロパティが無視されます。

デフォルト値： NaN。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 widthChanged イベントが送出されます。

実装
public function get width():Number
public function set width(value:Number):void

コンストラクターの詳細

()

コンストラクター

public function GridColumn(columnName:String = null)

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

コンストラクターです。

パラメーター

columnName:String (default = null) — dataField および headerText プロパティの初期値です。

メソッドの詳細

itemToDataTip

()

メソッド

public function itemToDataTip(item:Object):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

指定されたデータプロバイダーアイテムを列固有のデータヒントストリングに変換します。

このメソッドは、値 dataTipField および dataTipFunction を使用します。これらのプロパティが null の場合は、関連付けられているグリッドコントロールの対応するプロパティを使用します。グリッドコントロールの dataTipField プロパティも null の場合は、dataField プロパティを使用します。

dataTipFunction と dataTipFormatter が null の場合、このメソッドの値は item[dataTipField].toString() と同じになります。dataTipFormatter が指定されている場合、このメソッドの値は dataTipFormatter.format(item[dataTipField]) と同じになります。アイテムの dataField の解決でエラーがスローされた場合は、ERROR_TEXT が返されます。

item および dataTipFunction が null でない場合、このメソッドは dataTipFunction(item, this) を返します。ここで、2 つ目の引数はこの GridColumn です。

パラメーター

item:Object — grid.dataProvider.getItemAt(rowIndex) の値です。

戻り値

String — 指定されたデータプロバイダーアイテムまたは ERROR_TEXT の列固有のストリングです。

itemToLabel

()

メソッド

public function itemToLabel(item:Object):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

指定されたデータプロバイダーアイテムを列固有のストリングに変換します。このメソッドは、アイテムレンダラーの label プロパティを初期化するために使用されます。

labelFunction が null であり、dataField が "." というフィールド名のセパレーター文字を含まないストリングであり、フォーマッターが null である場合、このメソッドは次に等しくなります。

item[dataField].toString()

フォーマッターが指定された場合、このメソッドの値は次のようになります。

formatter.format(item[dataField])

dataField が "." で区切られたパスである場合、このメソッドでは連続する各パスエレメントを検索します。例えば、="foo.bar.baz" の場合、このメソッドは item.foo.bar.baz の値に基づくストリングを返します。アイテムの dataField の解決によってエラーがスローされた場合、ERROR_TEXT が返されます。

item および labelFunction が null でない場合、このメソッドは labelFunction(item, this) を返します。ここで、2 つ目の引数はこの GridColumn です。

パラメーター

item:Object — grid.dataProvider.getItemAt(rowIndex) の値。

戻り値

String — 指定された dataProvider アイテムの列固有のストリングまたは ERROR_TEXT です。

itemToRenderer

()

メソッド

public function itemToRenderer(item:Object):IFactory

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

指定されたデータプロバイダーアイテムを列固有のアイテムレンダラーファクトリに変換します。デフォルトでは、このメソッドは null 以外の場合は itemRendererFunction を呼び出し、null の場合は列の itemRenderer プロパティの値を返します。

パラメーター

item:Object — grid.dataProvider.getItemAt(rowIndex) の値です。

戻り値

IFactory — 指定された dataProvider アイテムに対する列固有のアイテムレンダラーファクトリです。

定数の詳細

ERROR_TEXT

定数

public static const ERROR_TEXT:String = "unknown"

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4.5

ランタイムバージョン:

Flash Player 10, AIR 2.5

対応するプロパティ名（パス）の解決に失敗した場合の、itemToLabel() または itemToDataTip() メソッドの戻り値です。この定数の値は単一の空白文字 " " です。

関連する API エレメント

itemToLabel
itemToDataTip

例この例の使用方法

GridColumnExample.mxml

<?xml version="1.0" encoding="utf-8"?>

<!--

A simple example of a DataGrid with explicitly specified columns.

The DataGrid's columns are specified by an ArrayList (an IList) and can always be accessed as such.  
For example dataGrid.columns.length returns the total number of columns and 
dataGrid.columns.getItemAt(index) returns the GridColumn at the specified index.  The columns list 
is mutable, which means that GridColumns can be added or removed at any time.

Column widths do not depend on the column's headerText, they're based on the rendered widths of 
the DataGrid's typicalItem. If that's not specified, then the first data item is used.  That's the 
case here.  Each column can specify an explicit width and by default all GridColumns are 
resizable="true", which means that the column can be interactively resized by dragging the edges 
between columns.  Interactively resizing column widths changes the DataGrid's measuredWidth which 
can be a little disconcerting if the DataGrid's width is not constrained.  In this example we've 
constrained the DataGrid's left and right edges which prevents changes in the DataGrid's 
measuredWidth from affecting its actual width.

-->

<s:Application 
    xmlns:fx="http://ns.adobe.com/mxml/2009" 
    xmlns:s="library://ns.adobe.com/flex/spark">
    
    <s:Panel title="Spark DataGrid Control Example which demonstrates a simple DataGrid with explicitly specified columns"
             width="75%" height="75%" 
             horizontalCenter="0" verticalCenter="0">
        
        <s:DataGrid id="dataGrid" left="5" right="5" top="5" bottom="5">
            <s:columns>
                <s:ArrayList>
                    <s:GridColumn dataField="key" headerText="Key"/>
                    <s:GridColumn dataField="name" headerText="Name"/>
                    <s:GridColumn dataField="price" headerText="Price"/>
                    <s:GridColumn dataField="call" headerText="Call"/>
                </s:ArrayList>
            </s:columns>
            
            <s:ArrayCollection>
                <s:DataItem key="1000" name="Abrasive" price="100.11" call="false"/>
                <s:DataItem key="1001" name="Brush" price="110.01" call="true"/>
                <s:DataItem key="1002" name="Clamp" price="120.02" call="false"/>
                <s:DataItem key="1003" name="Drill" price="130.03" call="true"/>
                <s:DataItem key="1004" name="Epoxy" price="140.04" call="false"/>
                <s:DataItem key="1005" name="File" price="150.05" call="true"/>
                <s:DataItem key="1006" name="Gouge" price="160.06" call="false"/>
                <s:DataItem key="1007" name="Hook" price="170.07" call="true"/>
                <s:DataItem key="1008" name="Ink" price="180.08" call="false"/>
                <s:DataItem key="1009" name="Jack" price="190.09" call="true"/>             
            </s:ArrayCollection>
        </s:DataGrid>    
    </s:Panel>
</s:Application>

GridColumnVisibilityExample.mxml

<?xml version="1.0" encoding="utf-8"?>

<!--

Demonstrate the GridColumn visible property and the support for dynamically adding and removing columns.

After selecting a column it's visibility can be changed, a copy of the column can be inserted, and the column can be removed.

The DataGrid columns property is a mutable list - an IList, like ArrayList - and columns can be added or removed at any time.  The difference 
between an IList and an intrinsic collection type like Array or Vector is that ILists dispatch events when they're changed.   That's why the
DropDownList, whose dataProvider is the list of columns, tracks the changes made with the Add/Remove buttons.

Changing a column's visibility does not change its presence or position in the columns IList but it prevents the DataGrid from displaying it.

-->

<s:Application 
    xmlns:fx="http://ns.adobe.com/mxml/2009" 
    xmlns:s="library://ns.adobe.com/flex/spark">
    
    <fx:Script>
        <![CDATA[
            // Insert a column to the left of specified column
            private function addNewColumn(column:GridColumn):void
            {
                const newColumn:GridColumn = new GridColumn();
                newColumn.dataField = column.dataField;
                newColumn.headerText = column.headerText + "+";
                dataGrid.columns.addItemAt(newColumn, column.columnIndex);
            }
            
            // Remove the specified column
            private function removeColumn(column:GridColumn):void
            {
                dataGrid.columns.removeItemAt(column.columnIndex);
            }
        ]]>
    </fx:Script>
    
    <s:Panel title="Spark DataGrid Control Example which demonstrates the GridColumn visible property and dynamically adding and removing columns"
             width="75%" height="75%" 
             horizontalCenter="0" verticalCenter="0">
        
        <s:controlBarContent>
            <s:HGroup verticalAlign="baseline">
                <s:DropDownList id="ddl" prompt="Select" dataProvider="{dataGrid.columns}" labelField="headerText"/>
                <s:Label text="Visible:"/>
                <s:CheckBox selected="@{ddl.selectedItem.visible}" enabled="{ddl.selectedItem}"/>
                <s:Button label="Add" click="addNewColumn(ddl.selectedItem)" enabled="{ddl.selectedItem}"/>
                <s:Button label="Remove" click="removeColumn(ddl.selectedItem)" enabled="{ddl.selectedItem}"/>
            </s:HGroup>
        </s:controlBarContent>
        
        <s:DataGrid id="dataGrid" left="5" right="5" top="5" bottom="5">
            <s:columns>
                <s:ArrayList>
                    <s:GridColumn dataField="key" headerText="Key"/>
                    <s:GridColumn dataField="name" headerText="Name"/>
                    <s:GridColumn dataField="price" headerText="Price"/>
                    <s:GridColumn dataField="call" headerText="Call"/>
                </s:ArrayList>
            </s:columns>
            
            <s:ArrayCollection>
                <s:DataItem key="1000" name="Abrasive" price="100.11" call="false"/>
                <s:DataItem key="1001" name="Brush" price="110.01" call="true"/>
                <s:DataItem key="1002" name="Clamp" price="120.02" call="false"/>
                <s:DataItem key="1003" name="Drill" price="130.03" call="true"/>
                <s:DataItem key="1004" name="Epoxy" price="140.04" call="false"/>
                <s:DataItem key="1005" name="File" price="150.05" call="true"/>
                <s:DataItem key="1006" name="Gouge" price="160.06" call="false"/>
                <s:DataItem key="1007" name="Hook" price="170.07" call="true"/>
                <s:DataItem key="1008" name="Ink" price="180.08" call="false"/>
                <s:DataItem key="1009" name="Jack" price="190.09" call="true"/>             
            </s:ArrayCollection>
        </s:DataGrid>    
    </s:Panel>    
</s:Application>

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

GridColumn - AS3 Flex

パッケージx

言語エレメント

付録

パッケージ spark.components.gridClasses

columnIndex

dataField

dataTipField

dataTipFormatter

dataTipFunction

editable

formatter

grid

headerRenderer

headerText

imeMode

itemEditor

itemRenderer

itemRendererFunction

labelFunction

maxWidth

minWidth

rendererIsEditable

resizable

showDataTips

sortable

sortCompareFunction

sortDescending

sortField

visible

width

GridColumn

itemToDataTip

itemToLabel

itemToRenderer

ERROR_TEXT