ListCollectionView  - AS3 Flex

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

f(item:Object):Boolean

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

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

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 filterFunctionChanged イベントが送出されます。

関連する API エレメント

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

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 collectionChange イベントが送出されます。

このコレクションビューがラップする IList です。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 listChanged イベントが送出されます。

ビューにソートまたはフィルターを適用すると、ソートによりアイテムの順序が変更されたか、またはフィルターによりアイテム数が減ったビューに含まれるアイテムの配列が localIndex プロパティにソート順に入れられます。 ListCollectionView クラスはこのプロパティを使用して、ビュー内のアイテムにアクセスします。 localIndex プロパティには、ソースにないものは含まれませんが、ソースにあるすべてのものが含まれるとは限りません。 ソートが実行されない場合、このプロパティは null になります。

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

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

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 sortChanged イベントが送出されます。

関連する API エレメント

ListCollectionView コンストラクターです。

アイテムのリストを現在のリストに追加し、渡される順序でリストの末尾に配置します。

パラメーター

アイテムのリストを現在のリストに追加し、関数に渡されるインデックス位置に配置します。アイテムはインデックス位置に、返される順序で配置されます。

パラメーター

イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。イベントリスナーは、特定のタイプのイベント、段階、および優先度に関する表示リスト内のすべてのノードに登録できます。

イベントリスナーが正常に登録された後に、addEventListener() をさらに呼び出して優先度を変更することはできません。リスナーの優先度を変更するには、最初に removeEventListener() を呼び出す必要があります。その後、同じリスナーを新しい優先度レベルで再度登録できます。

リスナーが登録された後に、addEventListener()（type または useCapture に別の値を設定）を再度呼び出すと、別のリスナー登録が作成されることに注意してください。例えば、最初にリスナーを登録するときに useCapture を true に設定すると、そのリスナーはキャプチャ段階のみでリスニングします。同じリスナーオブジェクトを使用して再度 addEventListener() を呼び出すと（このとき、useCapture に false を設定）、異なる 2 つのリスナーが登録されます。1 つはキャプチャ段階でリスニングするリスナーで、もう 1 つはターゲット段階とバブリング段階でリスニングするリスナーです。

ターゲット段階またはバブリング段階のみを対象とするイベントリスナーを登録することはできません。登録時にこれらの段階が組み合わされるのは、バブリングはターゲットノードの祖先にしか適用されないためです。

イベントリスナーが不要になった場合は、EventDispatcher.removeEventListener() を呼び出して、イベントリスナーを削除します。削除しない場合、メモリの問題が発生する可能性があります。ガベージコレクターは参照を有するオブジェクトを削除しないため、登録されているイベントリスナーに関係したオブジェクトはメモリから自動的に除去されません。

EventDispatcher インスタンスをコピーしても、それに関連付けられているイベントリスナーはコピーされません。新しく作成したノードにイベントリスナーが必要な場合は、ノードを作成した後に、リスナーを関連付ける必要があります。ただし、EventDispatcher インスタンスを移動した場合は、関連付けられているイベントリスナーも一緒に移動されます。

イベントがノードで処理されるときに、イベントリスナーがそのノードに登録中であれば、イベントリスナーは現在の段階ではトリガーされません。ただし、バブリング段階など、イベントフローの後の段階でトリガーすることができます。

イベントがノードで処理されているときにイベントリスナーがノードから削除された場合でも、イベントは現在のアクションによってトリガーされます。削除された後は、その後の処理で再び登録されない限り、イベントリスナーは二度と呼び出されません。

パラメーター

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

パラメーター

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

パラメーター

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

パラメーター

関連する API エレメント

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

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

関連する API エレメント

イベントをイベントフローに送出します。イベントターゲットは EventDispatcher オブジェクトです。これに対して dispatchEvent() が呼び出されます。

パラメーター

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

関連する API エレメント

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

パラメーター

リスト内の、getItemAt(index) == アイテムとなるアイテムのインデックスを返します。

メモ：IViewCursor.findxxx() メソッドとは異なり、getItemIndex() メソッドは、検索対象のアイテムに含まれるフィールドのサブセットのみをパラメーターとして渡すことはできません。このメソッドは常に、入力パラメーターに完全に一致するアイテムを検索します。

パラメーター

EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。これにより、EventDispatcher オブジェクトがイベントタイプの処理をイベントフロー階層のどこで変更したかを判断できます。特定のイベントタイプが実際にイベントリスナーをトリガーするかどうかを判別するには、IEventDispatcher.willTrigger() を使用します。

hasEventListener() と willTrigger() の違いは、hasEventListener() では自身が属するオブジェクトのみ検証され、willTrigger() では type パラメーターで指定されたイベントのイベントフロー全体が検証されることです。

パラメーター

MXML タグを使用して ListCollectionView を作成したときに、MXML コンパイラーによって自動的に呼び出されます。 ActionScript を介して ListCollectionView を作成する場合は、このメソッドを呼び出して、MXML ドキュメントおよび null（id について）を渡す必要があります。

パラメーター

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

パラメーター

関連する API エレメント

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

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

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

EventDispatcher オブジェクトからリスナーを削除します。対応するリスナーが EventDispatcher オブジェクトに登録されていない場合は、このメソッドを呼び出しても効果はありません。

パラメーター

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

パラメーター

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

パラメーター

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

このビューのコンテンツをストリングにプリントし、返します。

指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。指定されたタイプのイベントがこの EventDispatcher オブジェクトまたはその子孫に送出されたときに、イベントリスナーがイベントフローの任意の段階でトリガーされる場合、このメソッドは true を返します。

hasEventListener() と willTrigger() の違いは、hasEventListener() では自身が属するオブジェクトのみ検証され、willTrigger() では type パラメーターで指定されたイベントのイベントフロー全体が検証されることです。

パラメーター

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

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