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

ICollectionView は、データのコレクションに対するビューです。 このビューは、様々な条件でソートされたデータ、またはフィルタで絞り込まれたデータを表示するように変更できます。基になるデータは変更されません。 IViewCursor はコレクション内のアイテムへのアクセスを提供します。 IViewCursor インターフェイスの insert() メソッドおよび remove() メソッドを使用してコレクションを変更できます。

ICollectionView は、リモートから取得したデータに対するビューであることがあります。 リモートの可能性があるデータでこのインターフェイスを実装する場合は、ItemPendingError で示される、データを取得できない場合を処理することが重要です。

IList インターフェイスは ICollectionView インターフェイスの代わりになります。

関連項目

mx.collections.IViewCursor
mx.collections.errors.ItemPendingError
mx.collections.IList
Using Data Providers and Collections

パブリックプロパティ
 プロパティ定義元
  filterFunction : Function
関数の条件に一致しないアイテムを削除するためにビューが使用する関数です。
ICollectionView
  length : int
[読み取り専用] このビュー内のアイテムの数です。
ICollectionView
  sort : Sort
ICollectionView に適用されるソートです。
ICollectionView
パブリックメソッド
 メソッド定義元
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
IEventDispatcher
  
contains(item:Object):Boolean
指定されたオブジェクトをビューに含めるかどうかを返します。
ICollectionView
  
createCursor():IViewCursor
このビューに対して使用する新しい IViewCursor を作成します。
ICollectionView
  
disableAutoUpdate():void
コレクション自体およびコレクション内のアイテムの変更がビューから送出されないようにします。
ICollectionView
 Inherited
dispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
IEventDispatcher
  
enableAutoUpdate():void
自動更新を有効にします。
ICollectionView
 Inherited
hasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
IEventDispatcher
  
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
アイテムが更新されたビューを通知します。
ICollectionView
  
refresh():Boolean
ビューにソートとフィルタを適用します。
ICollectionView
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
IEventDispatcher
 Inherited
willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
IEventDispatcher
イベント
 イベント 概要 定義元
  
collectionChange
ICollectionView が何らかの方法で更新されると送出されます。ICollectionView
プロパティの詳細
filterFunctionプロパティ
filterFunction:Function

関数の条件に一致しないアイテムを削除するためにビューが使用する関数です。 filterFunction のシグネチャは次のとおりになると予想されます。 

f(item:Object):Boolean
指定されたアイテムがビューに残っている場合、戻り値は true です。

フィルタがサポートされない場合、このプロパティにアクセスするとエラーがスローされます。 refresh() を呼び出す前に、更新するビューについて filterFunction プロパティを設定する必要があります。

メモ：ICollectionView の実装では、フィルタ関数を実行する前にリモートからすべてのアイテムを取得します。 ページングを使用している場合は、データを取得する前にリモートコレクションにフィルタを適用します。



実装
    public function get filterFunction():Function
    public function set filterFunction(value:Function):void

関連項目

refresh()
lengthプロパティ 
length:int  [読み取り専用]

このビュー内のアイテムの数です。 0 はアイテムがないことを意味し、-1 は長さが不明であることを意味します。



実装
    public function get length():int
sortプロパティ 
sort:Sort

ICollectionView に適用されるソートです。 ソートを設定してもビューは自動的に更新されないため、このプロパティを設定した後で refresh() メソッドを呼び出す必要があります。ソートがサポートされていない場合、このプロパティにアクセスするとエラーがスローされます。

メモ：ICollectionView の実装では、ソートを実行する前にリモートからすべてのアイテムを取得します。 ソートされたリストにページングを使用している場合は、データを取得する前にリモートコレクションにソートを適用します。



実装
    public function get sort():Sort
    public function set sort(value:Sort):void

関連項目

refresh()
メソッドの詳細
contains()メソッド
public function contains(item:Object):Boolean

指定されたオブジェクトをビューに含めるかどうかを返します。 IViewCursor.findxxx メソッドの場合とは異なり、この検索が成功するのは、パラメータに完全に一致するアイテムが見つかったときのみです。 ビューにフィルタが適用されている場合、このメソッドは、基になるコレクションにアイテムが含まれている場合でも false を返します。

パラメータ

item:Object — 検索対象のオブジェクトです。

戻り値
Boolean — 任意のフィルタを適用した後、ICollectionView にアイテムが含まれている場合は true を返します。それ以外の場合は、false を返します。
createCursor()メソッド 
public function createCursor():IViewCursor

このビューに対して使用する新しい IViewCursor を作成します。

戻り値
IViewCursor — 新しい IViewCursor 実装です。
disableAutoUpdate()メソッド 
public function disableAutoUpdate():void

コレクション自体およびコレクション内のアイテムの変更がビューから送出されないようにします。 また、コレクション内で位置が変更された場合、ビュー内のアイテムの位置が更新されないようにします。 enableAutoUpdate が呼び出された後、変更は適切にキューに入れられ、送出されます。 単一のアイテムに対して更新よりも多くのイベントが発生した場合は、ビューがリセットされることがあります。 disableAutoUpdate メソッドは累積的に動作します。ビューからイベントが送出され、ビューが更新されるには、enableAutoUpdate が同じ回数呼び出される必要があります。 disableAutoUpdate は個々のビューでのみ有効であるため、編集は他のビューによって個別に検出されます。

enableAutoUpdate()メソッド 
public function enableAutoUpdate():void

自動更新を有効にします。 詳細については、「disableAutoUpdate」を参照してください。

関連項目

disableAutoUpdate()
itemUpdated()メソッド 
public function itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void

アイテムが更新されたビューを通知します。 このメソッドは、ビューのコンテンツが IPropertyChangeNotifier を実装しない場合に便利です。 このメソッドの呼び出しに property パラメータが含まれている場合、ビューは通知メカニズムを最適化できることがあります。 プロパティを指定しないと、ビュー全体の単純な更新が選択されます。

パラメータ

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

関連項目

mx.events.CollectionEvent
mx.core.IPropertyChangeNotifier
mx.events.PropertyChangeEvent
refresh()メソッド 
public function refresh():Boolean

ビューにソートとフィルタを適用します。 ICollectionView は、ソートまたはフィルタの変更を自動検出しません。したがって、refresh() メソッドを呼び出してビューを更新する前に、sort プロパティまたは filterFunction プロパティを設定する必要があります。ICollectionView に IMXMLObject インターフェイスも実装されている場合は、refresh() メソッドを initialized() メソッドから呼び出してください。

更新が正常に完了した場合は true を返し、ソートが完了していない場合（アイテムが保留中の場合など）は false を返します。 ビューのクライアントは、CollectionEventKind.REFRESHkind プロパティを使用して CollectionEvent イベントを待つことで、refresh() 操作が完了したことを確認する必要があります。

戻り値
Boolean — refresh() が完了した場合は true、refresh() が完了していない場合は false です。
イベントの詳細
collectionChange イベント
イベントオブジェクトの型: mx.events.CollectionEvent
プロパティ CollectionEvent.type = mx.events.CollectionEvent.COLLECTION_CHANGE

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

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/ICollectionView.html