ASDoc

メソッド | プロパティ | エフェクト | イベント | スタイル

フレームあり | フレームなし

mx.controls.listclasses
ScrollSelectList クラス

直接の既知のサブクラス
mx.controls.List, mx.controls.Menu

ScrollSelectList クラス
mx.core.ScrollView の拡張

ScrollSelectList クラスは、行の選択やスクロールが可能な行リストを表すコントロールの基本クラスです。モデルとビューのアーキテクチャでは、これがビューになり、モデルは DataProvider になります。

MXML シンタックス

ScrollSelectList クラスは、親クラスのすべてのプロパティを継承し、次のプロパティを定義します。

 <mx:tagname
   cellRenderer="No default."
   dataTipField="label"
   dataTipFunction="No default."
   dataProvider="No default."
   dragEnabled="false|true"
   iconField="No default."
   iconFunction="No default."
   labelField="label"
   labelFunction="No default."
   multipleSelection="false|true"
   rowCount="7"
   rowHeight="Height of one row based onthe font size."
   rowRenderer="No default."
   selectable="true|false"
   selectedIndex="No default."
   showDataTips="false|true"
   variableRowHeight="false|true"
   verticalAlign="middle|top|bottom"
   wordWrap="false|true"
 />

関連項目
DataProvider

メソッド
	`addItem( label, data) : Void` Adds an item to the end of the dataProvider array.
	`addItemAt( index:Number, label, data) : Void`dataProvider 内の指定された場所にアイテムを追加します。
	`calculateWidths( index, count)`トリミングせずに、アイテムをリストに表示するために必要な幅を計算します。
	`clearSelected`選択内容をすべてクリアし、リストを再描画します。
	`createChildren( ) : Void`この ScrollSelectList の子となるオブジェクト (すべての行とセルを保持するコンテンツオブジェクト) を作成します。
	`draw( ) : Void`選択したアイテムの上に選択グラフィックを描画し、行の内容を描画し、さらに境界線とスクロールバーを描画します。
	`fillRowsFromBottom( xx:Number, h:Number, curY:Number, rC:Number, len:Number)`データの入っていないリストから行を取得するか、新しい行を作成して、その行にデータを入力し、先頭行の次の行に配置します。行を配置する場所がなくなるか、すべての行がデータで埋まるまでこの処理を続け、最終行が表示される位置まで行全体をスクロールします。
	`fillRowsFromTop( xx:Number, h:Number, curY:Number, rC:Number, len:Number)`データの入っていないリストから行を取得するか、新しい行を作成して、その行にデータを入力し、先頭行の次の行に配置します。行を配置する場所がなくなるか、すべての行がデータで埋まるまでこの処理を続けます。
	`getDropLocation( )` ドラッグアイテムがドロップターゲットに追加されるインデックスを返します。
	`getItemAt( index:Number) : Object` 現在のソート順と dataProvider の内容に基づいて、dataProvider 内の指定された場所のアイテムを取得します。
	`hideDropFeedback( )`マウスポインタの下にドロップインジケータを表示して、ドラッグ & ドロップ操作が可能であることを示します。
	`isSelected` 指定されたインデックスにあるアイテムが存在し、選択されている場合は、`true` を返します。
	`layoutChildren( ) : Void`表示可能な行の数が変更された場合に、表示される行を追加または削除します。
	`measure( ) : Void`表示を要求された行の数、明示的に要求された行の高さ、またはフォントの高さ (他の行の高さが指定されていない場合) に基づき、適切な幅と高さを計算します。
	`removeAll( ) : Void`すべてのアイテムを削除します。
	`removeItemAt( index:Number) : Object`指定した位置のアイテムを削除します。
	`replaceItemAt( index:Number, newLabel, newData) : Void`指定した位置のアイテムを置き換えます。
	`setPropertiesAt( index:Number, obj:Object) : Void`dataProvider 内の個々のアイテムのプロパティを設定します。
	`showDropFeedback( )`マウスポインタの下にドロップインジケータを表示して、ドラッグ & ドロップ操作が可能であることを示します。
	`sortItems( compareFunc, order) : Void`リストをソートします。
	`sortItemsBy( fieldName, order) : Void`指定したフィールドでリストをソートします。

mx.core.ScrollView クラスから継承されるメソッド

childLoaded   createChildren   createChildWithStyles   getViewMetrics   init   layoutChildren   setScrollProperties

mx.core.View クラスから継承されるメソッド

childLoaded   constructObject2   createChild   createChildren   destroyAllChildren   destroyChild   destroyChildAt   draw   getBorderMetrics   getChildAt   getChildIndex   getViewMetrics   init   layoutChildren   layoutChrome   setChildIndex

mx.core.UIComponent クラスから継承されるメソッド

drawFocus getFocus getFocusManager setEnabled setFocus

プロパティ
	`cellRenderer:Object`行のセルレンダラーの作成に使用するクラス参照です。
	`dataProvider:Object`表示するデータのセットです。
	`dataTipField:String`ラベルとして表示する dataProvider 配列オブジェクト内のフィールドの名前です。
	`dataTipFunction:Function`ラベルを決定するために各アイテムで実行するユーザー指定の関数です。
	`dragEnabled:Booleantrue` の場合、コンポーネント内でドラッグが可能です。
	`dropIndicatorSkin:String`ScrollSelectList から派生したコンポーネントをドラッグ & ドロップ操作でのドロップ先として使用できる場合、`showDropFeedback()` メソッドを呼び出すと、このプロパティに保存されている symbolName を持つグラフィックが表示されます。
	`iconField:String` アイコンとして表示する dataProvider 配列オブジェクト内のフィールドの名前です。
	`iconFunction:Function`アイテムのアイコンを決定するために各アイテムで実行するユーザー定義の関数です。
	`labelField:String`ラベルとして表示する dataProvider 配列オブジェクト内のフィールドの名前です。
	`labelFunction:Function`ラベルを決定するために各アイテムで実行するユーザー指定の関数です。
	`multipleSelection:Booleantrue` の場合、複数選択が可能です。
	`rowCount:Number`表示される行の数です。
	`rowHeight:Number`行の高さをピクセル単位で表します。
	`rowRenderer:var`行の行レンダラーの作成に使用するクラス参照です。
	`selectable:Booleantrue` の場合、リストでの選択操作が可能です。
	`selectedIndex:Number`dataProvider 内の選択したアイテムのインデックスです。
	`selectedIndices:Array`選択されているアイテム群のインデックスの配列を表します。
	`selectedItem:Object`dataProvider 内の選択したアイテムへの参照です。
	`selectedItems:Array`dataProvider 内の選択したアイテム群への参照で構成する配列を表します。
	`showDataTips:Boolean` `true` の場合、dataTips は行のテキストとして表示されます。
	`value:Object`選択されているアイテムにデータプロパティがある場合は、そのデータプロパティを表します。データプロパティがない場合は、そのアイテムのラベルプロパティを表します。
	`variableRowHeight:Boolean` `true` の場合、それぞれの行が別々の高さの値を持つことができます。
	`verticalAlign:String`行内のテキストの垂直方向の配置を設定できるようにするオプションです。
	`wordWrap:Boolean` `true` の場合、行のテキストの折り返しが可能になります。

mx.core.ScrollView クラスから継承されるプロパティ

className   hPosition   hScrollPolicy   liveScrolling   maxHPosition   maxVPosition   scrollTipFunction   showScrollTips   version   vPosition   vScrollPolicy

mx.core.View クラスから継承されるプロパティ

baselinePosition className numChildren version

mx.core.UIComponent クラスから継承されるプロパティ

enabled errorString tabEnabled tabIndex version

エフェクト

mx.core.UIComponent クラスから継承されるエフェクト

focusInEffect focusOutEffect

mx.core.UIObject クラスから継承されるエフェクト

creationCompleteEffect   hideEffect   mouseDownEffect   mouseOutEffect   mouseOverEffect   mouseUpEffect   moveEffect   resizeEffect   showEffect

イベント
`change`	ユーザーの操作によって `selectedIndex` プロパティまたは `selectedItem` プロパティが変更されるとブロードキャストします。このイベントオブジェクトの `target` プロパティには、イベントをトリガしたコンポーネントへの参照が含まれます。`type` プロパティには、イベントの名前である `change` が含まれます。次のような、選択したアイテムの属性にアクセスできます。 evt.target.selectedItem.label evt.target.selectedItem.data
`itemRollOut`	リストアイテムからマウスポインタが離れたときにブロードキャストされます。このイベントオブジェクトの `target` プロパティには、イベントをトリガしたコンポーネントへの参照が含まれます。`type` プロパティには、イベントの名前 `itemRollOut` が含まれます。`index` プロパティには、マウスポインタが離れたアイテムのインデックスが含まれます。
`itemRollOver`	アイテムにマウスポインタを合わせたときにブロードキャストされます。このイベントオブジェクトの `target` プロパティには、イベントをトリガしたコンポーネントへの参照が含まれます。`type` プロパティには、イベントの名前 `itemRollOver` が含まれます。`index` プロパティには、マウスポインタが指しているアイテムのインデックスが含まれます。

mx.core.ScrollView クラスから継承されるイベント

scroll

mx.core.View クラスから継承されるイベント

childCreated childDestroyed childIndexChanged

mx.core.UIComponent クラスから継承されるイベント

focusIn focusOut invalid keyDown keyUp valid valueCommitted

mx.core.UIObject クラスから継承されるイベント

creationComplete  dragComplete  dragDrop  dragEnter  dragExit  dragOver  draw  effectEnd  effectStart  hide  hideToolTip  initialize  load  mouseChangeSomewhere  mouseDown  mouseDownSomewhere  mouseMove  mouseMoveSomewhere  mouseOut  mouseOver  mouseUp  mouseUpSomewhere  move  resize  show  showToolTip  unload

スタイル

mx.core.UIObject クラスから継承されるスタイル

color   fontFamily   fontSize   fontStyle   fontWeight   horizontalGap   leading   marginLeft   marginRight   textAlign   textDecoration   textIndent   verticalGap

メソッドの詳細

addItem

addItem( label, data)
										
													 :  Void

dataProvider 配列の末尾にアイテムを追加します。このビューおよび dataProvider の他のビューは直ちに更新されます。

メソッドシグネチャは addItem(label:String, data) です。

パラメータ
label - 新規アイテムのラベルです。
data - 新規アイテムのデータです。Number、String、Object、Array などを指定できます。

戻り値
追加されたアイテムです。

addItemAt

addItemAt( index:Number, label, data)
										
													 :  Void

dataProvider 内の指定された場所にアイテムを追加します。このビューおよび dataProvider の他のビューは直ちに更新されます。

メソッドシグネチャは addItemAt(index:Number, label:String, data) です。

パラメータ
    index:Number - アイテムが追加されるインデックスです。
    label - 新規アイテムのラベルです。
    data - 新規アイテムのデータです。Number、String、Object、Array などを指定できます。

戻り値
追加されたアイテムです。

calculateWidths

calculateWidths( index, count)

トリミングせずに、アイテムをリストに表示するために必要な幅を計算します。このメソッドでは、dataProvider 内のすべてのアイテムを調べ、各アイテムのテキストの長さを測る必要があります。そのためメソッドの完了に時間がかかることがあります。width プロパティの値として割り当てることができる値を返します。幅を自動的に更新することはありません。テキストの長さを測るアイテムの数を制限するには、index パラメータと count パラメータを使用します。

パラメータ
index - リスト内でアイテムの調査を開始する位置です。
count - リスト内で調査するアイテムの数です。

戻り値
もっとも幅の広い行の幅です。

clearSelected

clearSelected( )

選択内容をすべてクリアし、リストを再描画します。メソッドシグネチャは clearSelected() です。

createChildren

createChildren( )
										
													 :  Void

この ScrollSelectList の子となるオブジェクト (すべての行とセルを保持するコンテンツオブジェクト) を作成します。このメソッドを呼び出しても、行とセルはすぐには作成されません。Flex から layoutChildren() メソッドを呼び出したときに作成されます。

draw

draw( )
										
													 :  Void

選択したアイテムの上に選択グラフィックを描画し、行の内容を描画し、さらに境界線とスクロールバーを描画します。

fillRowsFromBottom

fillRowsFromBottom( xx:Number, h:Number, curY:Number, rC:Number, len:Number)

データの入っていないリストから行を取得するか、新しい行を作成して、その行にデータを入力し、先頭行の次の行に配置します。行を配置する場所がなくなるか、すべての行がデータで埋まるまでこの処理を続け、最終行が表示される位置まで行全体をスクロールします。

パラメータ
    xx:Number - 各行の x 位置を表します。
    h:Number - 行の塗りつぶしに使用するピクセルの数です。
    curY:Number - 次に追加する行のピクセルオフセットです。
    rC:Number - 行の配列へのインデックスを表します。
    len:Number - データプロバイダに含まれているアイテムの数です。

fillRowsFromTop

fillRowsFromTop( xx:Number, h:Number, curY:Number, rC:Number, len:Number)

データの入っていないリストから行を取得するか、新しい行を作成して、その行にデータを入力し、先頭行の次の行に配置します。行を配置する場所がなくなるか、すべての行がデータで埋まるまでこの処理を続けます。

getDropLocation

getDropLocation( )

ドラッグアイテムがドロップターゲットに追加されるインデックスを返します。

getItemAt

getItemAt( index:Number)
										
													 :  Object

現在のソート順と dataProvider の内容に基づいて、dataProvider 内の指定された場所のアイテムを取得します。メソッドシグネチャは getItemAt(index:Number) です。

パラメータ
index:Number - 返されるアイテムのインデックスです。

戻り値
アイテムを返します。

hideDropFeedback

hideDropFeedback( )

マウスポインタの下にドロップインジケータを表示して、ドラッグ & ドロップ操作が可能であることを示します。

isSelected

isSelected( )

指定されたインデックスにあるアイテムが存在し、選択されている場合は、true を返します。

メソッドシグネチャは、isSelected(index:Number):Boolean です。

layoutChildren

layoutChildren( )
										
													 :  Void

表示可能な行の数が変更された場合に、表示される行を追加または削除します。

関連項目
mx.core.ScrollView

measure

measure( )
										
													 :  Void

表示を要求された行の数、明示的に要求された行の高さ、またはフォントの高さ (他の行の高さが指定されていない場合) に基づき、適切な幅と高さを計算します。rowCount プロパティおよび rowHeight プロパティの値により変化します。

関連項目
mx.core.ScrollView

removeAll

removeAll( )
										
													 :  Void

すべてのアイテムを削除します。このビューおよび dataProvider の他のビューは直ちに更新されます。

メソッドシグネチャは removeAll() です。

removeItemAt

removeItemAt( index:Number)
										
													 :  Object

指定した位置のアイテムを削除します。このビューおよび dataProvider の他のビューは直ちに更新されます。

メソッドシグネチャは removeItemAt(index:Number) です。

パラメータ
index:Number - 削除されるアイテムのインデックスです。

戻り値
削除されたアイテムを返します。

replaceItemAt

replaceItemAt( index:Number, newLabel, newData)
										
													 :  Void

指定した位置のアイテムを置き換えます。このビューおよび dataProvider の他のビューは直ちに更新されます。

メソッドシグネチャは replaceItemAt(index:Number, label:String, data) です。

パラメータ
    index:Number - 置き換えられるアイテムのインデックスです。
    newLabel -
    newData -

setPropertiesAt

setPropertiesAt( index:Number, obj:Object)
										
													 :  Void

dataProvider 内の個々のアイテムのプロパティを設定します。指定したアイテムにオブジェクト内のプロパティを追加して、既存のプロパティを置き換えます。プロパティの削除には使用できません。

パラメータ
index:Number - 変更するアイテムのインデックスです。
obj:Object - アイテムのプロパティ値です。

showDropFeedback

showDropFeedback( )

マウスポインタの下にドロップインジケータを表示して、ドラッグ & ドロップ操作が可能であることを示します。

sortItems

sortItems( compareFunc, order)
										
													 :  Void

リストをソートします。compareFunc は 3 つのパラメータを取ります。1 つ目のパラメータを 2 つ目のパラメータの前にソートする必要がある場合は、-1 を返します。2 つのパラメータが同等である場合は、0 を返します。1 つ目のパラメータを 2 つ目のパラメータの後にソートする必要がある場合は、+1 を返します。3 つ目のパラメータは、ソート方向、大文字と小文字の区別などを示す、Array クラスからのフラグのビットマスクです。このビューおよび dataProvider の他のビューは、直ちに更新されます。

メソッドシグネチャは sortItems(compareFunc:Function, flags:Number) です。

パラメータ
compareFunc - 比較に使用する関数です。
isNew:Boolean - 初めてドロップインジケータが描画された場合には true、更新されただけの場合には false を指定します。

sortItemsBy

sortItemsBy( fieldName, order)
										
													 :  Void

指定したフィールドでリストをソートします。このメソッドは、データがストリングであるか数値であるかを判別し、それに応じてソートを試みます。他の (日付と時刻などの) ソートは、sortItems() メソッドを使用して行う必要があります。このビューおよび dataProvider の他のビューは直ちに更新されます。

メソッドシグネチャは sortItemsBy(fieldName:String, order:String) です。

パラメータ
fieldName - ソートするフィールドです。
order - 昇順の場合は "asc"、降順の場合は "desc" です。

プロパティの詳細

cellRenderer

cellRenderer:Object

行のセルレンダラーの作成に使用するクラス参照です。デフォルトでは、セルレンダラーは単純なテキストのセルです。複雑な行を表示するには、複雑なセルを作成するクラスのクラス参照をこのプロパティに設定します。複雑な行には、複数行のテキストを含む行、チェックボックスを含む行、イメージを含む行などがあります。

dataProvider

dataProvider:Object

表示するデータのセットです。一部のクラスは、単純な配列を使用します。XML 階層を使用するものもあります。また、クラスインスタンスを使用するものもあります。

dataTipField

dataTipField:String

ラベルとして表示する dataProvider 配列オブジェクト内のフィールドの名前です。デフォルトでは、各配列オブジェクトの label という名前のプロパティが検索され、リストに表示されます。ただし、データオブジェクトに label プロパティが含まれない場合は、データオブジェクト内の別のプロパティを使用するように labelField プロパティを設定できます。たとえば、データベースから取得した複数の人名のセットを表示する場合の "FullName" がその例です。

dataTipFunction

dataTipFunction:Function

ラベルを決定するために各アイテムで実行するユーザー指定の関数です。デフォルトでは、各配列オブジェクトの label という名前のプロパティが検索され、リストに表示されます。ただし、label プロパティが存在せず、また行内の表示に使用できる別のプロパティが存在しないデータセットもあります。たとえば、データセットに lastName と firstName のフィールドがあり、フルネームを表示したい場合などです。このような場合に、適切なフィールドを検索して表示可能なストリングを返す labelFunction を指定できます。labelFunction は、フォーマット処理やローカライズにも使用できます。

dragEnabled

dragEnabled:Boolean

true の場合、コンポーネント内でドラッグが可能です。デフォルト値は false です。

dropIndicatorSkin

dropIndicatorSkin:String

ScrollSelectList から派生したコンポーネントをドラッグ & ドロップ操作でのドロップ先として使用できる場合、showDropFeedback() メソッドを呼び出すと、このプロパティに保存されている symbolName を持つグラフィックが表示されます。デフォルト値は ListDropIndicator です。

iconField

iconField:String

アイコンとして表示する dataProvider 配列オブジェクト内のフィールドの名前です。デフォルトでは、リストの行にあるテキストにはアイコンが表示されません。しかし、アイコンのフィールドを指定することで、アイコンとして作成して行に表示するグラフィックの symbolName を指定できます。

iconFunction

iconFunction:Function

アイテムのアイコンを決定するために各アイテムで実行するユーザー定義の関数です。デフォルトでは、リストの行にあるテキストにはアイコンが表示されません。しかし、アイコンの関数を指定することで、アイコンとして作成して行に表示するグラフィックの symbolName を指定できます。

labelField

labelField:String

ラベルとして表示する dataProvider 配列オブジェクト内のフィールドの名前です。デフォルトでは、各配列オブジェクトの label という名前のプロパティが検索され、リストに表示されます。ただし、データオブジェクトに label プロパティが含まれない場合は、データオブジェクト内の別のプロパティを使用するように labelField プロパティを設定できます。たとえば、データベースから取得した複数の人名のセットを表示する場合の "FullName" がその例です。

labelFunction

labelFunction:Function

ラベルを決定するために各アイテムで実行するユーザー指定の関数です。デフォルトでは、各配列オブジェクトの label という名前のプロパティが検索され、リストに表示されます。ただし、label プロパティが存在せず、また行内の表示に使用できる別のプロパティが存在しないデータセットもあります。たとえば、データセットに lastName と firstName のフィールドがあり、フルネームを表示したい場合などです。
このような場合に、適切なフィールドを検索して表示可能なストリングを返す labelFunction を指定できます。labelFunction は、フォーマット処理やローカライズにも使用できます。

List コントロールおよび List のすべてのサブクラス (DataGrid コントロールを除く) については、この関数のメソッドシグネチャは次のとおりです。labelFunction(item:Object) :String
item には、リストアイテムオブジェクトが含まれます。

DataGrid コントロールについては、メソッドシグネチャは次のとおりです。labelFunction(item:Object, columnName:String) :String
item には DataGrid アイテムオブジェクトが、columnName には DataGrid 列の名前が入ります。

メソッドは、このアイテムのコントロールに表示する String を返します。

multipleSelection

multipleSelection:Boolean

true の場合、複数選択が可能です。不連続な選択を無効にするオプションはありません。標準の複合選択操作 (Shift キーを押しながらクリック、または Ctrl キーを押しながらクリック) は常に使用できます。

rowCount

rowCount:Number

表示される行の数です。デフォルト値は 7 です。コンポーネントの高さが明示的に設定されている場合は、このプロパティは使用されない場合があります。

rowHeight

rowHeight:Number

行の高さをピクセル単位で表します。すべての行は、同じ高さであることが必要です。このプロパティを指定していない場合は、現在のフォントに合わせてテキスト行のサイズが調整されます。

rowRenderer

rowRenderer:var

行の行レンダラーの作成に使用するクラス参照です。デフォルトでは、行レンダラーによって各行に同じセルレンダラーが作成されます。カスタムの行レンダラーを使用すると、行ごとに異なるセルレンダラーを作成できます。

selectable

selectable:Boolean

true の場合、リストでの選択操作が可能です。サブクラス ScrollSelectList を持つ Menu クラスでは、選択状態を維持しないので、デフォルトではこのプロパティは false に設定されます。デフォルト値は true です。

selectedIndex

selectedIndex:Number

dataProvider 内の選択したアイテムのインデックスです。複数選択が可能な場合は、このプロパティの代わりに selectedIndices を使用します。このプロパティを設定すると、他のすべてのアイテムの選択状態がクリアされます。

selectedIndices

selectedIndices:Array

選択されているアイテム群のインデックスの配列を表します。単一選択の場合、機能は selectedIndex プロパティと同じです。複数選択の場合は、現在選択されているすべてのアイテムのインデックスで構成される Array を表します。Array の各エントリは、選択されているアイテムのインデックスを表す数値です。したがって、この Array の 0 番目のエレメントが "5" という数値であることもあり得ます。これは、複数選択されているアイテム群の 1 番目のアイテム (インデックスは 0) ではなく、6 番目のアイテム (インデックスは 5) を指しています。

selectedItem

selectedItem:Object

dataProvider 内の選択したアイテムへの参照です。このデータを変更すると、dataProvider とそのビューが変更されます。複数選択の場合は、selectedItems プロパティを使用します。

selectedItems

selectedItems:Array

dataProvider 内の選択したアイテム群への参照で構成する配列を表します。単一選択の場合、機能は selectedItem プロパティと同じです。複数選択の場合は、dataProvider 内のアイテムへの参照で構成する Array を表します。これらのアイテムを変更すると、dataProvider とビューが変更されます。

showDataTips

showDataTips:Boolean

true の場合、dataTips は行のテキストとして表示されます。デフォルト値は false です。

value

value:Object

選択されているアイテムにデータプロパティがある場合は、そのデータプロパティを表します。データプロパティがない場合は、そのアイテムのラベルプロパティを表します。

variableRowHeight

variableRowHeight:Boolean

true の場合、それぞれの行が別々の高さの値を持つことができます。デフォルト値は false です。

verticalAlign

verticalAlign:String

行内のテキストの垂直方向の配置を設定できるようにするオプションです。

wordWrap

wordWrap:Boolean

true の場合、行のテキストの折り返しが可能になります。デフォルト値は false です。

mx.controls.listclasses ScrollSelectList クラス