ASDoc

メソッド	フレームあり \| フレームなし

mx.controls.listclasses
DataSelector クラス

DataSelector クラス
Object の拡張

DataSelector クラスはデコレータ (Mix-in) クラスであり、つまりメソッドやプロパティを他のオブジェクト (通常は別のクラスのプロトタイプ) に動的に追加します。DataSelector クラスは、dataProvider と複数選択状態の両方にインターフェイスする機能を追加します。複数選択状態は、ComboBox および ScrollSelectList で使用されます。また DataSelector クラスは、この機能を他のクラスに継承させるためにも役立ちます。

メソッド
	`addItem( label, data) : Void` dataProvider 配列の末尾にアイテムを追加します。
	`addItemAt( index:Number, label, data) : Void` dataProvider 内の指定された場所にアイテムを追加します。
	`getDataProvider( ) : Object` 使用されているデータプロバイダを取得します。
	`getItemAt( index:Number) : Object` dataProvider の現在のソート順序と内容に基づき、dataProvider 内の指定された位置のアイテムを取得します。
	`getLength( ) : Number` dataProvider 内のアイテムの数です。
	`getSelectedIndex( ) : Number`選択されたアイテムのインデックスを取得します。
	`getSelectedIndices( ) : Array`選択されたアイテムのインデックスをエレメントとする配列を取得します。
	`getSelectedItem( ) : Object`選択されたアイテムを取得します。
	`getSelectedItems( ) : Array`選択されたアイテムをエレメントとする配列を取得します。
	`getValue( ) : Object`選択されたアイテムの値を取得します。selectedItem を使用する方が適切な場合もあります。
	`removeAll( ) : Void` すべてのアイテムを削除します。
	`removeItemAt( index:Number) : Object` 指定した位置のアイテムを削除します。
	`replaceItemAt( index:Number, newLabel, newData) : Void` 指定した位置のアイテムを置き換えます。
	`setDataProvider( dP:Object) : Void` 使用するデータプロバイダを設定します。
	`sortItems( compareFunc, order) : Void` リストをソートします。
	`sortItemsBy( fieldName, order) : Void` 指定したフィールドでリストをソートします。

メソッドの詳細

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 などを指定できます。

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

getDataProvider

getDataProvider( )
										
													 :  Object

使用されているデータプロバイダを取得します。メソッドシグネチャは getDataProvider() です。

戻り値
DataProvider

getItemAt

getItemAt( index:Number)
										
													 :  Object

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

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

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

getLength

getLength( )
										
													 :  Number

dataProvider 内のアイテムの数です。これは、必ずしも表示されているアイテムの数ではありません。

戻り値
数値を返します。

getSelectedIndex

getSelectedIndex( )
										
													 :  Number

選択されたアイテムのインデックスを取得します。

戻り値
選択されたアイテムのインデックスを返します。

getSelectedIndices

getSelectedIndices( )
										
													 :  Array

選択されたアイテムのインデックスをエレメントとする配列を取得します。DataSelector で複数選択が許可されている場合にのみ役立ちます。

戻り値
選択されたアイテムのインデックスをエレメントとする配列です。

getSelectedItem

getSelectedItem( )
										
													 :  Object

選択されたアイテムを取得します。

戻り値
選択されたアイテムです。

getSelectedItems

getSelectedItems( )
										
													 :  Array

選択されたアイテムをエレメントとする配列を取得します。DataSelector で複数選択が許可されている場合にのみ役立ちます。

戻り値
選択されたアイテムをエレメントとする配列です。

getValue

getValue( )
										
													 :  Object

選択されたアイテムの値を取得します。selectedItem を使用する方が適切な場合もあります。

戻り値
選択されたアイテムの値です。

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 -

setDataProvider

setDataProvider( dP:Object)
										
													 :  Void

使用するデータプロバイダを設定します。メソッドシグネチャは setDataProvider(dp :Object) です。

パラメータ
dP:Object -

sortItems

sortItems( compareFunc, order)
										
													 :  Void

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

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

パラメータ
compareFunc - 比較に使用する機能です。
order -

sortItemsBy

sortItemsBy( fieldName, order)
										
													 :  Void

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

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

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

mx.controls.listclasses DataSelector クラス