パッケージ | mx.collections |
インターフェイス | public interface IGroupingCollection2 extends IHierarchicalData , IEventDispatcher |
実装者 | GroupingCollection2 |
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 4 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
関連する API エレメント
メソッド | 定義元 | ||
---|---|---|---|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。 | IEventDispatcher | ||
更新が非同期的に実行される場合、更新操作をキャンセルしてグループの作成を中止します。 | IGroupingCollection2 | ||
ノードに子を含めることができる場合は、true を返します。 | IHierarchicalData | ||
イベントをイベントフローに送出します。 | IEventDispatcher | ||
ノードの子を表すオブジェクトを返します。 | IHierarchicalData | ||
ノードからデータを返します。 | IHierarchicalData | ||
ルートデータアイテムを返します。 | IHierarchicalData | ||
ノードに子がある場合は true を返します。 | IHierarchicalData | ||
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | IEventDispatcher | ||
グループ化をコレクションに適用します。 | IGroupingCollection2 | ||
EventDispatcher オブジェクトからリスナーを削除します。 | IEventDispatcher | ||
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | IEventDispatcher |
grouping | プロパティ |
grouping:Grouping
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 4 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
ソースデータに適用される Grouping オブジェクトです。 このプロパティを設定してもビューは自動的に更新されません。したがって、このプロパティを設定した後、refresh()
メソッドを呼び出す必要があります。
メモ:IGroupingCollection2 の Flex 実装では、グループ化を実行する前にリモートからすべてのアイテムを取得します。
実装
public function get grouping():Grouping
public function set grouping(value:Grouping):void
cancelRefresh | () | メソッド |
public function cancelRefresh():void
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
更新が非同期的に実行される場合、更新操作をキャンセルしてグループの作成を中止します。 このメソッドは、refresh()
メソッドを true
の asynch
引数(非同期更新を表す)を指定して呼び出した場合にのみ、更新をキャンセルします。
refresh | () | メソッド |
public function refresh(async:Boolean = false, dispatchCollectionEvents:Boolean = false):Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
グループ化をコレクションに適用します。コレクションはグループの変更を自動検出しません。したがって、group
、source
または summaries
プロパティを設定した後に、refresh()
メソッドを呼び出して、コレクションを更新する必要があります。また、caseInsensitive
、compareFunction
、groupingFunction
などのプロパティを変更してコレクションの GroupingField を変更したときにも、refresh()
メソッドを呼び出します。
refresh()
メソッドは同期的にも非同期的にも適用できます。
refresh()
を同期的に呼び出した場合、メソッドが返る前に、すべてのグループと要約が一緒に更新されます。つまり、この呼び出し中は他の処理操作をアプリケーションで実行できないという意味です。クライアントは、kind
プロパティの値が CollectionEventKind.REFRESH
に設定された CollectionEvent イベントを待機して、refresh()
メソッドが完了したことを確認する必要があります。
非同期更新では、すべてのグループと要約が個々に更新されます。グループと要約が更新される前に refresh()
メソッドが返るので、アプリケーションは実行を継続できます。また、更新中にコントロールが更新されるので、ユーザーはコントロールとの対話を継続できます。
一括更新と異なり、グループと要約を個々に更新する際のオーバーヘッドがあるので、非同期更新のほうが同期更新よりも処理時間が長くなります。しかし、大規模なデータセットを扱う場合、非同期更新であれば更新中もアプリケーションを継続実行できます。
パラメーター
async:Boolean (default = false ) — true の場合は更新が非同期になります。 デフォルトは false で、同期的に更新されることを示します。
| |
dispatchCollectionEvents:Boolean (default = false ) — true の場合、グループが形成されたときにイベントが送出されます。より高いパフォーマンスを得るには、false に設定します。true の場合、イベントがグループとして送出され、要約が同期的に計算されてコントロールが更新されます。メモ:async が true の場合、dispatchCollectionEvents は常に true に設定されます。デフォルトは、イベント送出が行われない false です。
|
Boolean — true が返されるのは refresh() メソッドが完了した場合です。false が返されるのは更新が完了していない場合です。これはアイテムがまだ保留中であることを意味する場合があります。
|
Tue Jun 12 2018, 10:34 AM Z