GridColumn  - AS3 Flex

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

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

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

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

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

デフォルト値： null。

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

関連する API エレメント

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

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

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

デフォルト値： null。

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

関連する API エレメント

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

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

デフォルト値： null。

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

関連する API エレメント

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

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

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

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

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

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

デフォルト値： null。

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

関連する API エレメント

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

デフォルト値： true。

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

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

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

デフォルト値： null。

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

関連する API エレメント

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

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

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

デフォルト値： null。

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

関連する API エレメント

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

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

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

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

デフォルト値： null。

関連する API エレメント

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

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

デフォルト値： null。

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

関連する API エレメント

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

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

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

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

関連する API エレメント

指定する場合、このプロパティの値は、データプロバイダーアイテムおよび列パラメーターに基づいてアイテムレンダラーの 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 イベントが送出されます。

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

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

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

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

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

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

デフォルト値： null。

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

関連する API エレメント

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

デフォルト値： NaN。

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

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

デフォルト値： 20。

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

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

このプロパティを 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 イベントが送出されます。

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

デフォルト値： true。

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

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

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

デフォルト値： undefined。

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

関連する API エレメント

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

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

デフォルト値： true。

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

この列のデータエレメントに関してソートを実行するときに 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 イベントが送出されます。

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

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

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

デフォルト値： false。

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

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

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

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

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

関連する API エレメント

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

デフォルト値： true。

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

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

デフォルト値： NaN。

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

コンストラクターです。

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

このメソッドは、値 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 です。

パラメーター

指定されたデータプロバイダーアイテムを列固有のストリングに変換します。このメソッドは、アイテムレンダラーの 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 です。

パラメーター

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

パラメーター

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

関連する API エレメント