| パッケージ | mx.collections |
| インターフェイス | public interface IList extends IEventDispatcher |
| 実装者 | ArrayList, AsyncListView, ListCollectionView, NumericDataProvider |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
IList は、リモートから取得したデータに対するビューであることがあります。 リモートの可能性があるコレクションを記述する場合は、データがその時点でまだ取得できない場合を想定して処理することが重要です。これには、ItemPendingError を使用します。
ICollectionView は IList の代わりです。
関連する API エレメント
mx.collections.ICollectionView
mx.collections.ListCollectionView
継承されるパブリックメソッドを隠す
継承されるパブリックメソッドを表示| メソッド | 定義元 | ||
|---|---|---|---|
 | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。 | IEventDispatcher | |
指定されたアイテムをリストの末尾に追加します。 | IList | ||
指定されたインデックス位置にアイテムを追加します。 | IList | ||
|
イベントをイベントフローに送出します。 | IEventDispatcher | |
指定されたインデックス位置にあるアイテムを取得します。 | IList | ||
リスト内の、getItemAt(index) == アイテムとなるアイテムのインデックスを返します。 | IList | ||
|
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | IEventDispatcher | |
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
アイテムが更新されたビューを通知します。 | IList | ||
リストからすべてのアイテムを削除します。 | IList | ||
|
EventDispatcher オブジェクトからリスナーを削除します。 | IEventDispatcher | |
指定されたインデックス位置にあるアイテムを削除し、返します。 | IList | ||
指定されたインデックス位置にアイテムを配置します。 | IList | ||
IList 実装と同じ順序で指定された配列を返します。 | IList | ||
|
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | IEventDispatcher | |
length | プロパティ |
addItem | () | メソッド |
addItemAt | () | メソッド |
public function addItemAt(item:Object, index:int):void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定されたインデックス位置にアイテムを追加します。 追加したアイテムより大きいインデックスを持つすべてのアイテムのインデックスが 1 ずつ増えます。 指定されたインデックスが 0 未満であるか、またはリストの長さより大きい場合は、RangeError がスローされます。
パラメーター
item:Object — インデックス位置に配置するアイテムです。
| |
index:int — アイテムを配置するインデックス位置です。
|
例外
RangeError — インデックスが 0 未満であるか、またはリストの長さより大きい場合。
|
getItemAt | () | メソッド |
public function getItemAt(index:int, prefetch:int = 0):Object| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定されたインデックス位置にあるアイテムを取得します。
パラメーター
index:int — アイテムを取得するリストのインデックスです。
| |
prefetch:int (default = 0)int 値です。
|
Object — そのインデックス位置にあるアイテムです。アイテムがない場合は null です。
|
例外
ItemPendingError — そのインデックスのデータをリモートからロードする必要がある場合。
| |
RangeError — index < 0 または index >= length の場合。
|
getItemIndex | () | メソッド |
public function getItemIndex(item:Object):int| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
リスト内の、getItemAt(index) == アイテムとなるアイテムのインデックスを返します。
メモ：IViewCursor.findxxx() メソッドとは異なり、getItemIndex() メソッドは、検索対象のアイテムに含まれるフィールドのサブセットのみをパラメーターとして渡すことはできません。このメソッドは常に、入力パラメーターに完全に一致するアイテムを検索します。
パラメーター
item:Object — 検索するアイテムです。
|
int — アイテムのインデックスです。アイテムがリスト内にない場合は -1 です。
|
itemUpdated | () | メソッド |
public function itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
アイテムが更新されたビューを通知します。 これは、ビューの内容が IEventDispatcher を実装せず、PropertyChangeEvent を送出する場合に便利です。 プロパティを指定すると、ビューは通知メカニズムを最適化できます。 プロパティを指定しないと、ビュー全体の単純な更新が選択されます。
パラメーター
item:Object — 更新されたビュー内のアイテムです。
| |
property:Object (default = null) | |
oldValue:Object (default = null) | |
newValue:Object (default = null) |
関連する API エレメント
removeAll | () | メソッド |
public function removeAll():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
リストからすべてのアイテムを削除します。
アイテムがローカルではなく、非同期処理を実行する必要がある場合は、ItemPendingError がスローされます。
ItemPendingError の使用の詳細については、ItemPendingError およびコレクションの説明を参照してください。
removeItemAt | () | メソッド |
public function removeItemAt(index:int):Object| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定されたインデックス位置にあるアイテムを削除し、返します。 このインデックスより後にあったアイテムは、インデックスが 1 つずつ前になります。
パラメーター
index:int — アイテムが削除されるインデックスです。
|
Object — 削除されたアイテムです。
|
例外
RangeError — インデックスが 0 未満であるか、または長さより大きい場合。
|
setItemAt | () | メソッド |
public function setItemAt(item:Object, index:int):Object| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定されたインデックス位置にアイテムを配置します。 アイテムが既にそのインデックス位置にある場合は、新しいアイテムに置き換えられ、インデックス位置にあったアイテムが返されます。
パラメーター
item:Object — 指定されたインデックス位置に配置される新しいアイテムです。
| |
index:int — アイテムを配置するインデックス位置です。
|
Object — 置き換えられたアイテムです。アイテムがない場合は null です。
|
例外
RangeError — インデックスが 0 未満であるか、または長さより大きい場合。
|
toArray | () | メソッド |
public function toArray():Array| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
IList 実装と同じ順序で指定された配列を返します。 このメソッドでは、ItemPendingError がスローされることがあります。
戻り値Array — 配列です。
|
例外
ItemPendingError — リモートからのデータのロードがまだ完了していない場合。
|
collectionChange | イベント |
mx.events.CollectionEventプロパティ CollectionEvent.type =
mx.events.CollectionEvent.COLLECTION_CHANGE| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
IList が何らかの方法で更新されると送出されます。
CollectionEvent.COLLECTION_CHANGE 定数は、コレクションが変更されたときに送出されるイベントのイベントオブジェクトのtype プロパティ値を定義します。
イベントオブジェクトの各プロパティには次の値が設定されています。 イベントの種類によっては無効なプロパティもあります。詳細については、各プロパティの説明を参照してください。
| プロパティ | 値 |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | イベント処理を行うイベントリスナーの定義用オブジェクトを表します。 例えば、イベントリスナーの登録に myButton.addEventListener() を使用すると、myButton の値は currentTarget となります。 |
items | イベントの影響を受けるアイテムの情報を持つオブジェクトの配列です。 このフィールドの内容はイベントの種類に応じて異なります。詳細については、items プロパティを参照してください。 |
kind | イベントの種類です。 有効な値が定数として CollectionEventKind クラスに定義されます。 |
location | items プロパティで指定されたアイテムのターゲットコレクション内における位置です。 |
oldLocation | items プロパティで指定されたアイテムのコレクション内における以前の位置です。 |
target | イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。 イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。 |
type | CollectionEvent.COLLECTION_CHANGE |
Tue Jun 12 2018, 10:34 AM Z