DataGridColumn  - AS3 Flex

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

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

関連する API エレメント

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

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

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

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

この関数は、データプロバイダーエレメントを含む単一の Object パラメーターを取り、ストリングを返す関数であることが必要です。

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

ユーザーが列を新しい位置にドラッグできるかどうかを示すフラグです。true の場合、ユーザーは列ヘッダーを新しい位置にドラッグできます。

デフォルト値： true。

列の中のアイテムが編集可能かどうかを示すフラグです。 このプロパティが true で、DataGrid の editable プロパティも true であれば、列内のアイテムは編集可能です。アイテムをクリックするか、Tab キーと矢印キーを使用してアイテムに移動することにより、アイテムを個別に編集できます。

デフォルト値： true。

リストアイテムの新しいデータを格納するアイテムエディターのプロパティの名前です。 例えば、デフォルトの itemEditor は TextInput なので、editorDataField プロパティのデフォルト値は "text" となり、TextInput コントロールの text プロパティが指定されます。

デフォルト値： "text"。

アイテムレンダラーのサイズに対するアイテムエディターの高さです（ピクセル単位）。 このプロパティを使用すると、エディターをアイテムレンダラーと数ピクセル分オーバーラップさせて、エディターの周囲の境界線を補正することができます。 なお、エディターの表示中にこれらの値を変更しても、それらの変更は現在のエディターに反映されませんが、次のアイテムレンダラーでエディターが開かれたときに反映されます。

デフォルト値： 0。

アイテムエディターで Enter キーを使用するかどうかを示すフラグです。 true の場合、アイテムエディターで Enter キーを使用できます。この場合、DataGrid は Enter キーを検索せず、Enter キーが押されるとエディターを移動します。 なお、エディターの表示中にこの値を変更しても、それらの変更は現在のエディターに反映されませんが、次のアイテムレンダラーでエディターが開かれたときに反映されます。

デフォルト値： false.。

アイテムレンダラーのサイズに対するアイテムエディターの幅です（ピクセル単位）。 このプロパティを使用すると、エディターをアイテムレンダラーと数ピクセル分オーバーラップさせて、エディターの周囲の境界線を補正することができます。 なお、エディターの表示中にこれらの値を変更しても、それらの変更は現在のエディターに反映されませんが、次のアイテムレンダラーでエディターが開かれたときに反映されます。

デフォルト値： 0。

アイテムの左上隅の位置に対するアイテムエディターの左上隅の x 座標です（ピクセル単位）。 このプロパティを使用すると、エディターをアイテムレンダラーと数ピクセル分オーバーラップさせて、エディターの周囲の境界線を補正することができます。 なお、エディターの表示中にこれらの値を変更しても、それらの変更は現在のエディターに反映されませんが、次のアイテムレンダラーでエディターが開かれたときに反映されます。

デフォルト値： 0。

アイテムの左上隅の位置に対するアイテムエディターの左上隅の y 座標です（ピクセル単位）。 このプロパティを使用すると、エディターをアイテムレンダラーと数ピクセル分オーバーラップさせて、エディターの周囲の境界線を補正することができます。 なお、エディターの表示中にこれらの値を変更しても、それらの変更は現在のエディターに反映されませんが、次のアイテムレンダラーでエディターが開かれたときに反映されます。

デフォルト値： 0。

コンポーネントがフォーカスを得たときに、IME を有効にするかどうかを指定するフラグです。エディターが起動している場合は、それに従って enableIME が設定されます。

列の列ヘッダーを表示するアイテムレンダラーインスタンスに対応するクラスファクトリです。 このプロパティの値として、ドロップインアイテムレンダラー、インラインアイテムレンダラー、またはカスタムアイテムレンダラーの各コンポーネントを指定できます。

デフォルトのアイテムレンダラーは DataGridItemRenderer クラスです。これはアイテムデータをテキストとして表示します。

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

この列のヘッダーのテキストです。 デフォルトでは、DataGrid コントロールは dataField プロパティの値をヘッダーテキストとして使用します。

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

ヘッダー内のテキストが 1 行に収まらない場合に折り返すかどうかを示すフラグです。 undefined の場合は、DataGrid コントロールの wordWrap プロパティが使用されます。

デフォルト値： undefined。

IME（入力メソッドエディター）のモードを指定します。IME を使用することによって、ユーザーは中国語、日本語、および韓国語のテキストを入力できます。itemFocusIn イベントが発生すると IME モードが設定され、itemFocusOut イベントが発生すると設定前の値に戻ります。 このプロパティで有効な値の定数は、flash.system.IMEConversionMode クラスで定義されています。

デフォルト値は null です。この場合、DataGrid コントロールの imeMode プロパティの値が使用されます。

関連する API エレメント

列が編集可能な場合に列の編集に使用するアイテムエディターのインスタンスに対応するクラスファクトリです。

デフォルト値： new ClassFactory(mx.controls.TextInput)。

さらに例を参照

列にある各アイテムのデータを表示するアイテムレンダラーインスタンスに対応するクラスファクトリです。 このプロパティの値として、ドロップインアイテムレンダラー、インラインアイテムレンダラー、またはカスタムアイテムレンダラーの各コンポーネントを指定できます。

デフォルトのアイテムレンダラーは DataGridItemRenderer クラスです。これはアイテムデータをテキストとして表示します。

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

この列に表示するテキストを決定する関数です。 デフォルトでは、データにあるフィールドのうち、その列の名前と一致するフィールドのテキストが列に表示されます。 しかし、データ内の複数のフィールドに基づくテキストや、適切に書式設定されていない情報を表示したい場合があります。 そのような場合は、labelFunction を使用してコールバック関数を指定します。

DataGrid コントロールの場合、メソッドシグネチャの形式は次のようになります。

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

ここで、item は DataGrid アイテムオブジェクトを示し、column は DataGrid 列を示します。

コールバック関数を使用すると、データ内の firstName フィールドと lastName フィールドの結合、Date に対するカスタム書式の適用、数字で表された月からストリングへの変換などが可能です。

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

列の最小幅です。

デフォルト値： 20。

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

列にある各アイテムのデータを表示するアイテムレンダラーインスタンスに対応するクラスファクトリです。 このプロパティの値として、ドロップインアイテムレンダラー、インラインアイテムレンダラー、またはカスタムアイテムレンダラーの各コンポーネントを指定できます。

デフォルトのアイテムレンダラーは DataGridItemRenderer クラスです。これはアイテムデータをテキストとして表示します。

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

アイテムレンダラーがアイテムエディターでもあることを示すフラグです。 このプロパティを true に設定すると itemEditor プロパティは無視され、そのアイテムのアイテムレンダラーがアイテムエディターとして使用されます。

デフォルト値： false。

列の幅をユーザーが変更できるかどうかを示すフラグです。 true の場合、ユーザーは列ヘッダーの間のグリッド線をドラッグして、列のサイズを変更できます。

デフォルト値： true。

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

デフォルト値： false。

この列のヘッダーのクリック操作でユーザーがデータプロバイダーをソートできるかどうかを示すフラグです。 このプロパティと DataGrid の sortableColumns プロパティの両方を true に設定すると、ユーザーがこの列のヘッダーをマウスでクリックして離したときに、DataGrid コントロールから headerRelease イベントが送出されます。 他のハンドラーが preventDefault() メソッドを headerRelease イベントに対して呼び出さなければ、列の dataField プロパティまたは sortCompareFunction を使用して dataProvider のアイテムが並べ替えられます。

デフォルト値： true。

列の中のデータをソートするときに呼び出されるコールバック関数です。 このプロパティを指定しない場合、基本的なストリングまたは数値のソートを使用してデータのソートが試行されます。 データがストリングでも数値でもない場合、または dataField プロパティがデータプロバイダーの有効なプロパティでない場合は、ソートが機能しないか、例外が生成されます。 labelFunction プロパティの値を指定する場合は、この列でのソートが許可されていない場合を除き、通常は sortCompareFunction プロパティにも関数を指定します。つまり、列の dataField からの値を、labelFunction プロパティから求められる値と同じようにソートしないときに関数を指定します。

DataGrid コントロールはこの関数を使用して、データプロバイダーのコレクションのエレメントをソートします。 コールバック関数の関数シグネチャは 2 つのパラメーターを受け取り、次のような形式に従う必要があります。

mySortCompareFunction(obj1:Object, obj2:Object):int 

obj1 — 比較するデータエレメントです。

obj2 — obj1 の比較対象となるデータエレメントです。

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

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

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

デフォルト値： null。

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

列ソートが昇順（false）か降順（true）かを示します。

このプロパティを設定してもソートは実行されません。ソート方向のみが設定されます。 ソートを実行するには、列ヘッダーをクリックします。

デフォルト値： false;。

列が可視状態かどうかを示すフラグです。 true の場合、列は可視です。

デフォルト値： true。

列の幅を示すピクセル数です。DataGrid の horizontalScrollPolicy プロパティが false の場合、表示されるすべての列が表示可能領域内に収まる必要があります。この場合、すべての列幅を合計した幅が表示可能領域に対して小さすぎたり大きすぎたりした場合、DataGrid では個々の列の幅がそのまま使用されるとは限りません。

デフォルト値： 100。

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

この列の行内のテキストが 1 行に収まらない場合に折り返すかどうかを示すフラグです。 undefined の場合は、DataGrid コントロールの wordWrap プロパティが使用されます。

DataGrid.variableRowHeight プロパティも true である場合に限り有効です。

デフォルト値： undefined。

コンストラクターです。

適切なファクトリを返します。ファクトリが指定されていない場合は、デフォルトのファクトリを使用します。

パラメーター

dataTipField プロパティおよび dataTipFunction プロパティに基づき、指定されたデータオブジェクトのデータヒントとしてアイテムレンダラーが表示するストリングを返します。 このメソッドは、パラメーターをストリングに変換できない場合にスペースを 1 つ返します。

このメソッドは、DataGridColumn クラスのサブクラスを作成するために開発者が使用するものです。 アプリケーション開発者による使用は考慮されていません。

パラメーター

指定されたデータオブジェクトに対してアイテムレンダラーが表示するストリングを返します。 DataGridColumn またはその DataGrid コントロールの labelFunction プロパティが null でない場合は、その関数がデータオブジェクトに適用されます。 それ以外の場合、このメソッドは、dataField プロパティによって指定されたフィールドの内容を抽出するか、データオブジェクトのストリング値を取得します。 このメソッドは、パラメーターをストリングに変換できない場合にスペースを 1 つ返します。

パラメーター