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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

アイテムレンダラーは、このプロパティ定義をオーバーライドして、グリッドの行全体のデータにアクセスできます。

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

List アイテムレンダラーとは異なり、Grid アイテムレンダラーには、レンダラーまたはその行がマウスの下にあることを表示する排他的な役割はありません。Grid 自体は、マウスポインターが置かれた行またはセルに対して、hoverIndicator スキンパーツを自動的に表示します。Grid アイテムレンダラーは、そのプロパティを変更して、マウスポインターが置かれていることを強調することもできます。

List アイテムレンダラーとは異なり、Grid アイテムレンダラーには、自分が選択範囲の一部であることを表示する排他的な役割はありません。Grid 自体は、選択された行またはセルに対して、selectionIndicator スキンパーツを自動的に表示します。また、アイテムレンダラーは、選択範囲の一部であることを強調するためにビジュアルプロパティを変更できます。

List アイテムレンダラーとは異なり、Grid アイテムレンダラーには、自分のセルまたは行にキャレットがあることを表示する排他的な役割はありません。Grid 自体は、キャレット行またはキャレットセルに対して、caretIndicator スキンパーツを自動的に表示します。また、アイテムレンダラーは、キャレットがあることを強調するためにビジュアルプロパティを変更できます。

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

デフォルトでは、save() メソッドは、エディターが保存されて閉じられたときに、このプロパティの値をグリッドコントロールのデータプロバイダーに書き込み直します。

カスタムアイテムレンダラーの多くは、このプロパティの getter および setter メソッドをオーバーライドします。 setter メソッドをオーバーライドして、セル値に基づいてエディターを初期化します。 getter メソッドをオーバーライドして、新しいセル値を save() メソッドに返します。

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

List アイテムレンダラーとは異なり、Grid アイテムレンダラーには、レンダラーまたはその行がマウスの下にあることを表示する排他的な役割はありません。Grid 自体は、マウスポインターが置かれた行またはセルに対して、hoverIndicator スキンパーツを自動的に表示します。Grid アイテムレンダラーは、そのプロパティを変更して、マウスポインターが置かれていることを強調することもできます。

GridItemRenderer クラスは、labelDisplay エレメントが指定されている場合、そのエレメントの text プロパティに、このプロパティの値を自動的にコピーします。Grid は、label を列の itemToLabel() メソッドから返される値に設定します。

List アイテムレンダラーとは異なり、Grid アイテムレンダラーには、自分が選択範囲の一部であることを表示する排他的な役割はありません。Grid 自体は、選択された行またはセルに対して、selectionIndicator スキンパーツを自動的に表示します。また、アイテムレンダラーは、選択範囲の一部であることを強調するためにビジュアルプロパティを変更できます。

List アイテムレンダラーとは異なり、Grid アイテムレンダラーには、自分のセルまたは行にキャレットがあることを表示する排他的な役割はありません。Grid 自体は、キャレット行またはキャレットセルに対して、caretIndicator スキンパーツを自動的に表示します。また、アイテムレンダラーは、キャレットがあることを強調するためにビジュアルプロパティを変更できます。