表示可能なそれぞれの列に対応した DataGridColumn オブジェクトの配列です。明示的に設定されていない場合、DataGrid コントロールは、一連のプロパティを特定してそれらのプロパティをアルファベット順に表示するため、最初のデータプロパイダアイテムを調べようと試みます。

列のセットを変更する場合は、この配列を取得し、列および配列内の列順を変更してから、columns プロパティに新しい配列を割り当てる必要があります。これは、DataGrid コントロールにより列の配列の新しいコピーが返され、変更を加えても、その変更が認識されないためです。

このプロパティはデータバインディングのソースとして使用できます。

列の順序をユーザーが変更できるかどうかを示すフラグです。true の場合、ユーザーはヘッダセルをドラッグすることで DataGrid コントロールの列の順序を変更できます。

デフォルト値true.

データプロバイダ内のアイテムをユーザーが編集できるかどうかを示すフラグです。true の場合、コントロール内のアイテムが編集可能です。ユーザーは、アイテムレンダラーをクリックすることでエディタを開くことができます。

DataGrid コントロールに含まれる個々の列の編集をオフにするには、DataGridColumn.editable プロパティを使用するか、または itemEditBeginning および itemEditBegin イベントを使用します。

デフォルト値false.

編集中のデータプロバイダアイテムに対応するアイテムレンダラーの列と行のインデックスです (存在する場合)。

このオブジェクトには、アイテムの 0 から始まる列インデックスと行インデックスを示す columnIndex と rowIndex の 2 つのフィールドがあります。次に例を示します。{columnIndex:2, rowIndex:3}

このプロパティを設定すると、アイテムが表示されるまでスクロールし、itemEditBegin イベントを送出して、指定されたアイテムレンダラーでアイテムエディタが開きます。

デフォルト値null.

このプロパティはデータバインディングのソースとして使用できます。

編集中のアイテムが位置する DataGrid コントロール内のアイテムレンダラーへの参照です。

itemEditBegin イベントと itemEditEnd イベントのイベントリスナー内から、editedItemRenderer.data プロパティを使用して編集されているアイテムの現在値にアクセスできます。

左端からコンテンツへのオフセットです。これは、一部のサブクラスではピクセルのオフセットまたはその他のメトリック (DataGrid コントロール内の列の数など) とすることができます。DataGrid は列単位でスクロールします。したがって、horizontalScrollPosition の値は常に、0 から、最後の列が表示可能になる列のインデックスまでの範囲内に位置します。これは、ピクセル単位でスクロールする List コントロールとは異なります。DataGrid コントロールは、常に列の左端を DataGrid コントロールの左端に揃えます。

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

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

デフォルト値null.

関連項目

現在アクティブなアイテムエディタのインスタンスへの参照です (存在する場合)。

アイテムの編集中にアイテムエディタのインスタンスと新しいアイテム値にアクセスするには、itemEditorInstance プロパティを使用します。itemEditorInstance プロパティは、itemEditBegin イベントのイベントリスナーの実行後に初めて有効になります。したがって通常は、itemEditEnd イベントのイベントリスナー内から itemEditorInstance プロパティにアクセスするのみです。

DataGridColumn.itemEditor プロパティは、アイテムエディタのクラス (つまり、アイテムエディタインスタンスのデータ型) を定義します。

MXML でこのプロパティを設定することはありません。

列の最小幅です (ピクセル単位)。NaN ではない場合は、DataGrid コントロールよってこの値がすべての列の最小幅として適用されます。それ以外の場合は、個々の列に最小幅を指定できます。

デフォルト値NaN.

列のサイズをユーザーが変更できるかどうかを示すフラグです。true の場合、ユーザーはヘッダセル間のグリッド線をドラッグすることで DataGrid コントロールの列を拡大または縮小できます。true の場合、ユーザーによる特定の列のサイズ変更を防ぐには、個々の列の resizeable プロパティを false に設定する必要もあります。

デフォルト値true.

データプロバイダアイテムをユーザーが列ヘッダーセルのクリック操作でソートできるかどうかを示すフラグです。true の場合、ユーザーが列ヘッダセルをクリックすることによってデータプロバイダアイテムをソートできます。ソートフィールドとして、列の DataGridColumn.dataField プロパティまたは列の DataGridColumn.sortCompareFunction プロパティが使用されます。列が複数回クリックされると、ソートの昇順と降順が切り替わります。true の場合、個々の列の sortable プロパティを false に設定することにより、ヘッダへのクリックに反応しないようにできます。

このプロパティと列の sortable プロパティがどちらも true の場合、ポインタがヘッダセル上にあるときにユーザーがマウスボタンを離すと、DataGrid コントロールによって headerRelease イベントが送出されます。このイベントに対して preventDefault() メソッドを呼び出すハンドラがない場合、DataGrid によって、その列の DataGridColumn.dataField または DataGridColumn.sortCompareFunction プロパティを使用したソートが実行されます。

デフォルト値true.

関連項目

コンストラクタ。

列のサイズ変更時にユーザーが通常使用する列ヘッダセパレータを削除します。

itemEditor プロパティで指定されたエディタを使用して editedItemPosition のアイテムレンダラーに対応するアイテムエディタを作成します。

このメソッドは、エディタインスタンスを itemEditorInstance プロパティとして設定します。

itemEditBegin イベントに対するイベントリスナー内からのみ、このメソッドを呼び出すことができます。これ以外の時点でエディタを作成するには、itemEditBegin イベントを生成するように editedItemPosition プロパティを設定します。

このメソッドは、アイテムレンダラーに対して現在開いているアイテムエディタを閉じます。通常、このメソッドは、preventDefault() メソッドを呼び出してデフォルトイベントリスナーの実行を防止した後に、itemEditEnd イベントのイベントリスナー内からのみ呼び出されます。

示されたカラーを使用して列の背景を描画します。この実装では、入力された Sprite オブジェクトの子として Shape オブジェクトを作成し、適切な色で塗り潰します。

指定された UIComponent 内にヘッダの背景を描画します。コンポーネントの幅が変更された場合、描画されたグラフィックが水平方向に拡大・縮小されるか、このメソッドが再度呼び出されて、異なる幅や高さで再描画が行われます。

行間に線を描画します。この実装では、特定の Sprite オブジェクト内に線を直接描画します。Sprite オブジェクトは、線が描画される前にクリアされます。

列の間の線と、列の背景を描画します。この実装では、必要に応じて drawHorizontalLine()、drawVerticalLine()、および drawColumnBackground() メソッドが呼び出されます。これらのグラフィックをすべて含む Sprite が作成され、z 順序の前面に listContent の子として追加されます。

位置、高さ、色の指定に従って行の背景を描画します。この実装では、入力された Sprite オブジェクトの子として Shape オブジェクトを作成し、適切な色で塗り潰します。このメソッドでは、backgroundAlpha スタイルプロパティの設定に基づいて、背景色の透明度を決定します。

列のサイズ変更時にユーザーが通常使用する列ヘッダセパレータを作成して表示します。この実装では、線および列の背景と同じ Sprite が使用され、headerSeparatorSkin のインスタンスが追加され、ユーザーがサイズ変更を希望したときがわかるようにマウスリスナーが付加されます。

列間に線を描画します。この実装では、特定の Sprite オブジェクト内に線を直接描画します。Sprite オブジェクトは、線が描画される前にクリアされます。

ソート矢印グラフィックを、現在のソートキーとなっている列に描画します。この実装では、sortArrowSkin スタイルプロパティで指定されたスキンのインスタンスを作成または再使用し、適切な列ヘッダに配置します。また、ヘッダ内のテキストがソート矢印によって隠れる場合は、列ヘッダのサイズを縮小します。

ユーザーが列の幅を変更したときに送出され、その列に表示されるデータ量が変化したことを示します。horizontalScrollPolicy が "none" の場合は、サイズ変更される列に合わせて他の列が縮小または展開します。また、サイズ変更された列からもこのイベントが送出されます。

DataGridEvent.COLUMN_STRETCH 定数は columnStretch イベントのイベントオブジェクトの type プロパティ値を定義し、ユーザーが列を水平方向に展開したことを示します。

イベントオブジェクトの各プロパティには次の値が設定されます。

ユーザーが列のコンテンツに基づいてグリッドコンテンツをソートするようにコントロールに要求するために、列ヘッダの上でマウスボタンを離したときに送出されます。列が並べ替え可能であり、データプロバイダでソートがサポートされる場合にのみ送出されます。DataGrid コントロールは、このイベントに対して、単一列のソートを実装するデフォルトハンドラを持ちます。複数列のソートを実装するには、単一列のソートを阻止するために preventDefault() メソッドを呼び出し、データプロバイダの sort プロパティを設定します。

DataGridEvent.HEADER_RELEASE 定数は headerRelease イベントのイベントオブジェクトの type プロパティ値を定義し、ユーザーが列ヘッダの上でマウスを押して離したことを示します。

イベントオブジェクトの各プロパティには次の値が設定されます。

ユーザーが列を新しい位置にドラッグした後、列ヘッダの上でマウスボタンを離し、新しいインデックスに列が移動したときに送出されます。

IndexChangedEvent.HEADER_SHIFT 定数は headerShift イベントのイベントオブジェクトの type プロパティ値を定義し、ユーザーが DataGrid 列を新しい位置にドラッグしたときのように、ヘッダのインデックスが変更されたことを示します。

イベントオブジェクトの各プロパティには次の値が設定されます。

editedItemPosition プロパティが設定され、アイテムが編集可能になったときに送出されます。

DataGridEvent.ITEM_EDIT_BEGIN 定数は itemEditBegin イベントのイベントオブジェクトの type プロパティ値を定義し、アイテムが編集可能であることを示します。

このイベントのデフォルトリスナーは、次のアクションを実行します。

• createItemEditor() メソッドの呼び出しを通じてアイテムエディタオブジェクトを作成します。
• data プロパティをアイテムからエディタにコピーします。デフォルトでは、アイテムエディタオブジェクトは、TextInput コントロールのインスタンスです。リストコントロールの itemEditor プロパティを使用して、独自のアイテムエディタクラスを指定します。
• リストコントロールの itemEditorInstance プロパティを設定して、アイテムエディタインスタンスを参照するようにします。

このイベントのイベントリスナーを記述して、アイテムエディタに渡されるデータを変更できます。たとえば、データ、データのフォーマット、またはアイテムエディタで使用するその他の情報を変更できます。

イベントリスナーを作成して、アイテムの編集に使用するアイテムエディタを指定することもできます。たとえば、2 つの異なるアイテムエディタがあるとします。イベントリスナー内で編集するデータまたは他の情報を調べ、以下の手順に従って適切なアイテムエディタを開くことができます。

1. preventDefault() を呼び出すと、Flex が createItemEditor() メソッドがデフォルトイベントリスナーの一部として呼び出されるのを阻止できます。
2. 適切なエディタに itemEditor プロパティを設定します。
3. createItemEditor() メソッドを呼び出します。

イベントオブジェクトの各プロパティには次の値が設定されます。

ユーザーが、アイテムレンダラー上、DataGrid コントロールのタブ上、または DataGrid コントロール内でマウスボタンを離したとき、またはその他の方法でアイテムを編集しようと試みたときに送出されます。

DataGridEvent.ITEM__EDIT_BEGINNING 定数は itemEditBeginning イベントの ListEvent オブジェクトの type プロパティ値を定義し、ユーザーがアイテム上でマウスボタンを離すなどの操作によってアイテムを編集できる状態にあることを示します。

このイベントのデフォルトリスナーによって、DataGrid.editedItemPosition プロパティがフォーカスを持つアイテムに設定されて、アイテムの編集セッションが開始されます。

通常では、このイベントに対する独自のイベントリスナーを記述して、特定のアイテムを編集できないようにします。このイベントの独自のイベントリスナー内から preventDefault() メソッドを呼び出すことによって、デフォルトリスナーの実行が阻止されます。

イベントオブジェクトの各プロパティには次の値が設定されます。

何らかの理由でアイテム編集セッションが終了するときに送出されます。

DataGridEvent.ITEM_EDIT_END 定数は itemEditEnd イベントのイベントオブジェクトの type プロパティ値を定義し、編集セッションが終了することを示します。

List コンポーネントには、このイベントのデフォルトハンドラがあり、アイテムエディタから List コントロールのデータプロバイダにデータをコピーします。デフォルトのイベントリスナーは、次のアクションを実行します。

• このイベントに関連付けられた DataGridColumn コントロールの editorDataField プロパティを使用して、新しいデータを含むアイテムエディタのプロパティを判別し、その新しいデータでデータプロバイダアイテムを更新します。デフォルトのアイテムエディタは TextInput コントロールであるため、editorDataField プロパティのデフォルト値は "text" であり、TextInput の text プロパティに新しいアイテムデータが含まれることを指定します。
• destroyItemEditor() メソッドを呼び出してアイテムエディタを閉じます。

通常では、このイベントのイベントリスナーを記述して、次のアクションを実行します。

• イベントリスナーで、エディタから List コンポーネントに返されたデータを変更できます。たとえば、List コントロールにデータを返す前に、データを再フォーマットできます。デフォルトでは、アイテムエディタは単一の値のみ返すことができます。複数の値を返す場合は、itemEditEnd イベントのイベントリスナーを記述する必要があります。
• イベントリスナーで、アイテムエディタに入力されたデータを確認できます。データが正しくない場合は、preventDefault() メソッドを呼び出して、新しいデータが List コントロールに渡されないようにし、エディタが閉じるのを阻止できます。

イベントオブジェクトの各プロパティには次の値が設定されます。

アイテムレンダラーがフォーカスを得たときに送出されます。ユーザーが DataGrid コントロールのアイテムをクリックするか、キーボードを使用してアイテムに移動した場合に発生する可能性があります。アイテムが編集可能な場合にのみ送出されます。

DataGridEvent.ITEM_FOCUS_IN 定数は itemFocusIn イベントのイベントオブジェクトの type プロパティ値を定義し、アイテムがフォーカスを受け取ったことを示します。

イベントオブジェクトの各プロパティには次の値が設定されます。

アイテムレンダラーがフォーカスを失ったときに送出されます。ユーザーが DataGrid コントロールの内部または外部にある別のアイテムをクリックするか、キーボードを使用して DataGrid コントロールの内部または外部にある別のアイテムに移動した場合に発生する可能性があります。アイテムが編集可能な場合にのみ送出されます。

DataGridEvent.ITEM_FOCUS_OUT 定数は itemFocusOut イベントのイベントオブジェクトの type プロパティ値を定義し、アイテムがフォーカスを失ったことを示します。

イベントオブジェクトの各プロパティには次の値が設定されます。