パッケージmx.collections
インターフェイスpublic interface IList extends IEventDispatcher
実装者 ListCollectionView

順序に従って構成されたアイテムのコレクションです。 インデックスに基づいたアクセスメソッドおよび操作メソッドを提供します。

IList は、リモートから取得したデータに対するビューであることがあります。 リモートの可能性があるコレクションを記述する場合は、データがその時点でまだ取得できない場合を想定して処理することが重要です。これには、ItemPendingError を使用します。

ICollectionView は IList の代わりです。

関連項目

mx.collections.errors.ItemPendingError
mx.collections.ICollectionView
mx.collections.ListCollectionView
Using Data Providers and Collections

パブリックプロパティ
 プロパティ定義元
  length : int
[読み取り専用] コレクション内のアイテムの数です。
IList
パブリックメソッド
 メソッド定義元
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
IEventDispatcher
  
addItem(item:Object):void
指定されたアイテムをリストの末尾に追加します。
IList
  
addItemAt(item:Object, index:int):void
指定されたインデックス位置にアイテムを追加します。
IList
 Inherited
dispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
IEventDispatcher
  
getItemAt(index:int, prefetch:int = 0):Object
指定されたインデックス位置にあるアイテムを取得します。
IList
  
getItemIndex(item:Object):int
リスト内の、getItemAt(index) == アイテムとなるアイテムのインデックスを返します。
IList
 Inherited
hasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
IEventDispatcher
  
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
アイテムが更新されたビューを通知します。
IList
  
removeAll():void
リストからすべてのアイテムを削除します。
IList
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
IEventDispatcher
  
removeItemAt(index:int):Object
指定されたインデックス位置にあるアイテムを削除し、返します。
IList
  
setItemAt(item:Object, index:int):Object
指定されたインデックス位置にアイテムを配置します。
IList
  
toArray():Array
IList 実装と同じ順序で指定された配列を返します。
IList
 Inherited
willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
IEventDispatcher
イベント
 イベント 概要 定義元
  
collectionChange
IList が何らかの方法で更新されると送出されます。IList
プロパティの詳細
lengthプロパティ
length:int  [読み取り専用]

コレクション内のアイテムの数です。 0 はアイテムがないことを意味し、-1 は長さが不明であることを意味します。



実装
    public function get length():int
メソッドの詳細
addItem()メソッド
public function addItem(item:Object):void

指定されたアイテムをリストの末尾に追加します。 addItemAt(item, length) と同じです。

パラメータ

item:Object — 追加するアイテムです。

addItemAt()メソッド 
public function addItemAt(item:Object, index:int):void

指定されたインデックス位置にアイテムを追加します。 追加したアイテムより大きいインデックスを持つすべてのアイテムのインデックスが 1 ずつ増えます。 指定されたインデックスが 0 未満であるか、またはリストの長さより大きい場合は、RangeError がスローされます。

パラメータ

item:Object — インデックス位置に配置するアイテムです。
 
index:int — アイテムを配置するインデックス位置です。


例外
RangeError — インデックスが 0 未満であるか、またはリストの長さより大きい場合。
getItemAt()メソッド 
public function getItemAt(index:int, prefetch:int = 0):Object

指定されたインデックス位置にあるアイテムを取得します。

パラメータ

index:int — アイテムを取得するリストのインデックスです。
 
prefetch:int (default = 0) — アイテムがローカルでない場合に要求時に取得するアイテムの方向と量を示す int 値です。

戻り値
Object — そのインデックス位置にあるアイテムです。アイテムがない場合は null です。

例外
ItemPendingError — そのインデックスのデータをリモートからロードする必要がある場合。
 
RangeError — index < 0 または index >= length の場合。
getItemIndex()メソッド 
public function getItemIndex(item:Object):int

リスト内の、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

アイテムが更新されたビューを通知します。 これは、ビューの内容が IEventDispatcher を実装せず、PropertyChangeEvent を送出する場合に便利です。 プロパティを指定すると、ビューは通知メカニズムを最適化できます。 プロパティを指定しないと、ビュー全体の単純な更新が選択されます。

パラメータ

item:Object — 更新されたビュー内のアイテムです。
 
property:Object (default = null) — 更新されたプロパティの名前です。
 
oldValue:Object (default = null) — そのプロパティの古い値です。 プロパティが null の場合はアイテムの古い値を指定できます。
 
newValue:Object (default = null) — そのプロパティの新しい値です。 プロパティが null の場合、アイテムは新しい値と見なされるので、指定する必要はありません。

関連項目

mx.events.CollectionEvent
mx.events.PropertyChangeEvent
removeAll()メソッド 
public function removeAll():void

リストからすべてのアイテムを削除します。

アイテムがローカルではなく、非同期処理を実行する必要がある場合は、ItemPendingError がスローされます。

ItemPendingError の使用の詳細については、ItemPendingError およびコレクションの説明を参照してください。

removeItemAt()メソッド 
public function removeItemAt(index:int):Object

指定されたインデックス位置にあるアイテムを削除し、返します。 このインデックスより後にあったアイテムは、インデックスが 1 つずつ前になります。

パラメータ

index:int — アイテムが削除されるインデックスです。

戻り値
Object — 削除されたアイテムです。

例外
RangeError — インデックスが 0 未満であるか、または長さより大きい場合。
setItemAt()メソッド 
public function setItemAt(item:Object, index:int):Object

指定されたインデックス位置にアイテムを配置します。 アイテムが既にそのインデックス位置にある場合は、新しいアイテムに置き換えられ、インデックス位置にあったアイテムが返されます。

パラメータ

item:Object — 指定されたインデックス位置に配置される新しいアイテムです。
 
index:int — アイテムを配置するインデックス位置です。

戻り値
Object — 置き換えられたアイテムです。アイテムがない場合は null です。

例外
RangeError — インデックスが 0 未満であるか、または長さより大きい場合。
toArray()メソッド 
public function toArray():Array

IList 実装と同じ順序で指定された配列を返します。 このメソッドでは、ItemPendingError がスローされることがあります。

戻り値
Array — 配列です。

例外
ItemPendingError — リモートからのデータのロードがまだ完了していない場合。
イベントの詳細
collectionChange イベント
イベントオブジェクトの型: mx.events.CollectionEvent
プロパティ CollectionEvent.type = mx.events.CollectionEvent.COLLECTION_CHANGE

IList が何らかの方法で更新されると送出されます。

CollectionEvent.COLLECTION_CHANGE 定数は、コレクションが変更されたときに送出されるイベントのイベントオブジェクトの type プロパティ値を定義します。

イベントオブジェクトの各プロパティには次の値が設定されています。イベントの種類によっては無効なプロパティもあります。詳細については、各プロパティの説明を参照してください。

プロパティ値
bubblesfalse
cancelablefalse
currentTargetイベント処理を行うイベントリスナーの定義用オブジェクトを表します。 例えば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は myButton となります。
itemsイベントの影響を受けるアイテムの情報を持つオブジェクトの配列です。このフィールドの内容はイベントの種類に応じて異なります。詳細については、items プロパティを参照してください。
kindイベントの種類です。有効な値が定数として CollectionEventKind クラスに定義されます。
locationitems プロパティで指定されたアイテムのターゲットコレクション内における位置です。
oldLocationitems プロパティで指定されたアイテムのコレクション内における以前の位置です。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。
typeCollectionEvent.COLLECTION_CHANGE



© 2009 Adobe Systems Incorporated. All rights reserved.
Thu Mar 19 2009, 08:51 PM -07:00
 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/collections/IList.html