| メソッド | プロパティ | スタイル | フレームあり | フレームなし |
DataGridColumn クラスは、DataGrid コントロール内の列を記述します。DataGridColumn は、それぞれ表示可能な列に対して 1 つ存在します。データプロバイダには、表示されない列、つまり DataGridColumn を必要としない列が含まれる場合があります。DataGridColumn では、列内のテキストの色とフォント、列のデータを表示するコンポーネントの種類を指定したり、列の編集、ソートやサイズ変更を可能にするかどうか、または列ヘッダのテキストを指定できます。
MXML シンタックス
DataGrid コントロールの列を設定するには、<mx:DataGridColumn> タグを使用します。<mx.DataGridcolumn> タグは、MXML で列プロパティの子として指定します。<mx:DataGridColumn> タグには、次のプロパティを使用できます。
<mx:DataGridColumn
cellRenderer="No default."
columnName="No default, required."
color=No default."
editable="true|false"
fontFamily="No default."
fontSize="No default."
fontStyle="normal|italic"
fontWeight="normal|bold"
headerRenderer="No default."
headerText="No default."
labelFunction="No default."
marginLeft="0"
marginRight="0"
resizable="true|false"
sortable="true|false"
sortCompareFunction="No default."
sortOnHeaderRelease="true|false"
textAlign="right|center|left"
textDecoration="none|underline"
textIndent="0"
width="100"
/>
関連項目
mx.styles.CSSStyleDeclaration
mx.events.EventDispatcher
| メソッド |
| mx.styles.CSSStyleDeclaration クラスから継承されるメソッド |
getStyle |
| プロパティ | |
| cellRenderer:varこの列にデータを表示するオブジェクトのクラスオブジェクト参照またはシンボルリンケージ ID です。 |
| colNum:Numberグリッドに表示されたこの列の 0 から始まるインデックスです。 |
| columnName:String列に関連付けられているデータ内のフィールドまたはプロパティの名前です。 |
| dataTipField:Stringラベルとして表示する dataProvider 配列オブジェクト内のフィールドの名前です。 |
| dataTipFunction:Functionラベルを決定するために各アイテムで実行するユーザー指定の関数です。 |
| editable:Booleantrue の場合、列内のセルは、そのセルをクリックするか、Tab キーと矢印キーを使用してそのセルに移動することにより、個別に編集できます。 |
| headerCell:Object列ヘッダの表示に使用するセルです。 |
| headerRenderer:Stringこの列のヘッダを表示するオブジェクトのクラスオブジェクト参照またはシンボルリンケージ ID です。 |
| headerText:varこの列のヘッダのテキストです。 |
| labelFunction:Functionこの列に表示するテキストを決定する関数です。 |
| resizable:Booleantrue の場合、列ヘッダの間のグリッド線をドラッグして、列のサイズを変更できます。 |
| showDataTips:Boolean行内のテキストに dataTips を表示できるようにするかどうかを指定するブール値オプションです。 |
| sortable:Booleantrue の場合、sortOnHeaderRelease の値に応じて、ユーザーが列ヘッダをクリックしたとき、または列が DataGrid.sort() メソッドで指定されているときに、その列のデータを使用して dataProvider 内のアイテムが並べ替えられます。 |
| sortCompareFunction:Function ユーザーが列ヘッダをクリックして DataGrid の内容を並べ替えるときに呼び出されるコールバック関数へのポインタです。 |
| sortOnHeaderRelease:Booleantrue の場合、DataGrid はユーザーが列ヘッダをクリックしたときに、この列に基づいてデータを並べ替えます。 |
| width:Numberピクセル単位で表した列の幅です。 |
| wordWrap:Boolean行内のテキストの折り返しを許可するかどうかを指定するブール値オプションです。 |
| mx.styles.CSSStyleDeclaration クラスから継承されるプロパティ |
エフェクト |
| スタイル | |
backgroundColor | 型 : Number 形式 : Color CSS の継承 : なし列の背景色です。デフォルト値は undefined です。この場合、関連付けられている DataGrid コントロールの backgroundColor 値が使用されます。DataGrid コントロールの backgroundColor のデフォルト値は、0xFFFFFF です。 |
color | 型 : Number 形式 : Color CSS の継承 : ありコンポーネントラベルのテキストカラーです。 |
fontFamily | 型 : String CSS の継承 : あり使用するフォントの名前です。完全な CSS 実装と異なり、カンマ区切りリストはサポートされません。任意のフォントファミリ名を使用できます。汎用フォント名を指定した場合、適切なデバイスフォントに置換されます。 |
fontSize | 型 : Number 形式 : Length CSS の継承 : ありテキストの高さ (ピクセル単位) です。 |
fontStyle | CSS の継承 : ありテキストがイタリック体かどうかを表します。有効な値は、normal と italic です。デフォルトは normal です。 |
fontWeight | CSS の継承 : ありテキストがボールド体かどうかを表します。有効な値は、normal と bold です。デフォルトは normal です。 |
headerStyle | 型 : Object CSS Inheritance:なし列に適用する列ヘッダの CSS スタイル宣言です。 |
marginLeft | 型 : Number 形式 : Length CSS の継承 : なしコンテナの左境界線とコンテンツ領域の間隔を示すピクセル数です。デフォルトは 0 ピクセルです。 |
marginRight | 型 : Number 形式 : Length CSS の継承 : なしコンテナの右境界線とコンテンツ領域の間隔を示すピクセル数です。デフォルトは 0 ピクセルです。 |
textAlign | CSS の継承 : ありコンテナ内のテキストの整列です。有効な値は、left、right、または center です。デフォルトは left です。 |
textDecoration | CSS の継承 : なしテキストに下線を表示するかどうかを指定します。有効な値は、none と underline です。デフォルトは none です。 |
textIndent | 型 : Number 形式 : Length CSS の継承 : ありテキスト 1 行目の列左端からのオフセットです。デフォルトは 0 ピクセルです。 |
| プロパティの詳細 |
cellRenderer:var
colNum:Number
columnName:String
headerText」のプロパティの説明を参照してください。
dataTipField:String
label という名前のプロパティが検索され、リストに表示されます。ただし、データオブジェクトに label プロパティが含まれない場合は、データオブジェクト内の別のプロパティを使用するように labelField プロパティを設定できます。たとえば、データベースから取得した複数の人名のセットを表示する場合の "FullName" がその例です。
dataTipFunction:Function
label という名前のプロパティが検索され、リストに表示されます。ただし、label プロパティが存在せず、また行内の表示に使用できる別のプロパティが存在しないデータセットもあります。たとえば、データセットに lastName と firstName のフィールドがあり、フルネームを表示したい場合などです。このような場合に、適切なフィールドを検索して表示可能なストリングを返す labelFunction を指定できます。labelFunction は、フォーマット処理やローカライズにも使用できます。
editable:Boolean
true の場合、列内のセルは、そのセルをクリックするか、Tab キーと矢印キーを使用してそのセルに移動することにより、個別に編集できます。デフォルト値は false です。
headerCell:Object
headerRenderer:String
headerText:var
labelFunction:Function
labelFunction を使用してコールバック関数を指定します。このコールバック関数は、行全体のデータに適用する単一の引数を受け取り、ストリングを返す必要があります。コールバック関数を使用すると、データ内の firstName と lastName のフィールドの結合、Date に対するカスタム形式の適用、数字で表した月のストリングへの変換などが可能です。
resizable:Boolean
true の場合、列ヘッダの間のグリッド線をドラッグして、列のサイズを変更できます。デフォルト値は true です。
showDataTips:Boolean
sortable:Boolean
true の場合、sortOnHeaderRelease の値に応じて、ユーザーが列ヘッダをクリックしたとき、または列が DataGrid.sort() メソッドで指定されている場合に、その列のデータを使用して dataProvider 内のアイテムが並べ替えられます。デフォルト値は true です。
sortCompareFunction:Function
sortOnHeaderRelease:Boolean
true の場合、DataGrid はユーザーが列ヘッダをクリックしたときに、この列に基づいてデータを並べ替えます。デフォルト値は true です。DataGridColumn.sortable が true の場合にのみ有効です。
width:Number
wordWrap:Boolean