ListCollectionView  - AS3 Flex

视图用来消除不符合函数条件的项目的函数。FilterFunction 应具有以下签名：

f(item:Object):Boolean

如果滤镜是不支持的滤镜，则在访问此属性时 Flex 会引发错误。必须在设置 filterFunction 属性后调用 refresh() 以更新视图。

注意：ICollectionView 的 Flex 实现将先检索远程位置的所有项目，然后再执行 filter 函数。如果使用分页，请在检索数据之前将该滤镜应用到远程集合。

此属性可用作数据绑定的源。修改此属性后，将调度 filterFunctionChanged 事件。

相关 API 元素

此视图中的项目数。0 表示不包含项目，而 -1 表示长度未知。

此属性可用作数据绑定的源。修改此属性后，将调度 collectionChange 事件。

此集合视图所封装的 IList。

此属性可用作数据绑定的源。修改此属性后，将调度 listChanged 事件。

视图经过排序或过滤后，localIndex 属性将包含在排序或过滤后（已排序、已缩减）的视图中按排序顺序显示的所有项目的数组。ListCollectionView 类使用此属性访问该视图中的项目。localIndex 属性永远不能包含源中没有的任何内容，但可以不将源中的所有内容都包含在内。如果没有进行排序，则此属性为 null。

将应用于 ICollectionView 的 ISort。设置排序不会自动刷新视图，因此必须在设置此属性后调用 refresh() 方法。如果不支持排序，访问此属性时将引发错误。

注意：ICollectionView 的 Flex 实现将先检索远程位置的所有项目，然后再执行排序。如果要对排序后的列表使用分页，请在检索数据之前对远程集合应用排序。

此属性可用作数据绑定的源。修改此属性后，将调度 sortChanged 事件。

相关 API 元素

ListCollectionView 构造函数。

向当前列表添加一组项目，将它们按传入顺序放置在列表的末尾。

参数

向当前列表添加一组项目，将它们放置在传递给函数的索引指定的位置。这些项目按接收顺序放置在索引位置。

参数

使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。可以为特定类型的事件、阶段和优先级在显示列表的所有节点上注册事件侦听器。

成功注册一个事件侦听器后，无法通过额外调用 addEventListener() 来更改其优先级。要更改侦听器的优先级，必须先调用 removeEventListener()。然后，可以使用新的优先级再次注册该侦听器。

注册该侦听器后，如果继续调用具有不同 type 或 useCapture 值的 addEventListener()，则会创建单独的侦听器注册。例如，如果首先注册 useCapture 设置为 true 的侦听器，则该侦听器只在捕获阶段进行侦听。如果您使用同一个侦听器对象再次调用 addEventListener()，但 useCapture 设置为 false，则您将有两个单独的侦听器：一个在捕获阶段侦听，另一个在目标阶段和冒泡阶段侦听。

不能只为目标阶段或冒泡阶段注册事件侦听器。这些阶段在注册期间是成对出现的，因为冒泡阶段只适用于目标节点的祖代。

如果不再需要某个事件侦听器，可调用 EventDispatcher.removeEventListener() 删除它；否则会产生内存问题。由于垃圾回收器不会删除仍包含引用的对象，因此不会从内存中自动删除使用已注册事件侦听器的对象。

复制 EventDispatcher 实例时并不复制其中附加的事件侦听器。（如果新近创建的节点需要一个事件侦听器，必须在创建该节点后附加该侦听器。）但是，如果移动 EventDispatcher 实例，则其中附加的事件侦听器也会随之移动。

如果在正在处理事件的节点上注册事件侦听器，则不会在当前阶段触发事件侦听器，但会在事件流的稍后阶段触发，如冒泡阶段。

如果从正在处理事件的节点中删除事件侦听器，则该事件侦听器仍由当前操作触发。删除事件侦听器后，决不会再次调用该事件侦听器（除非再次注册以备将来处理）。

参数

向列表末尾添加指定项目。等效于 addItemAt(item, length)。

参数

在指定的索引处添加项目。任何大于已添加项目的索引的项目索引都会增加 1。如果指定索引小于零或者大于列表长度，则会引发 RangeError。

参数

返回指示视图是否包含指定对象的信息。与 IViewCursor.findxxx 方法不同，此搜索仅在找到完全与参数匹配的项目时才会成功。如果视图中包含已应用到该视图的滤镜，则即使基本集合确实包含该项目，此方法也会返回 false。

参数

相关 API 元素

创建使用此视图的新 IViewCursor。

防止视图调度对集合本身和集合中的项目的更改。如果集合中的位置发生变化，还要防止视图更新项目的位置。调用 enableAutoUpdate 后，将适当排列和调度更改。如果发生更新单个项目之外的其他事件，视图最终可能会重新设置。disableAutoUpdate 方法累积执行；要求视图调度并刷新事件的次数与调用 enableAutoUpdate 的次数相同。注意，disableAutoUpdate 仅影响单个视图；其他视图可能根据各个基础检测编辑。

相关 API 元素

将事件调度到事件流中。事件目标是对其调用 dispatchEvent() 的 EventDispatcher 对象。

参数

启用自动更新。有关详细信息，请参阅 disableAutoUpdate。

相关 API 元素

获取指定索引处的项目。

参数

如果项目位于列表中（这样的话 getItemAt(index) == item），则返回该项目的索引。

注意：与 IViewCursor.findxxx() 方法不同，getItemIndex() 方法不能在要搜索的项目中使用只带字段子集的参数；此方法始终搜索与输入参数完全匹配的项目。

参数

检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。这样，您就可以确定 EventDispatcher 对象在事件流层次结构中的哪个位置改变了对事件类型的处理。要确定特定事件类型是否确实会触发事件侦听器，请使用 IEventDispatcher.willTrigger()。

hasEventListener() 与 willTrigger() 的区别是：hasEventListener() 只检查它所属的对象，而 willTrigger() 检查整个事件流以查找由 type 参数指定的事件。

参数

如果 ListCollectionView 是使用 MXML 标签创建的，则由 MXML 编译器自动调用。如果通过 ActionScript 创建 ListCollectionView，则必须调用传递给 MXML 文档的此方法，并将 id 设置为 null。

参数

通知视图，某个项目已更新。如果视图的内容不实现 IPropertyChangeNotifier，则此方法非常有用。如果对此方法的调用包括 property 参数，则视图可以优化其通知机制。否则，它可能选择仅刷新整个视图。

参数

相关 API 元素

将排序和滤镜应用到视图。ICollectionView 不自动检测对排序或滤镜的更改，因此您必须在设置 sort 或 filterFunction 属性后调用 refresh() 方法以更新视图。如果 ICollectionView 实现也实现 IMXMLObject 接口，则应从 initialized() 方法调用 refresh() 方法。

如果刷新成功，则返回 true；如果排序尚未完成（例如，项目仍待处理），则返回 false。视图的客户端应等待执行带有 CollectionEventKind.REFRESH kind 属性的 CollectionEvent 事件以确保完成 refresh() 操作。

删除列表中的所有项目。

从 EventDispatcher 对象中删除侦听器。如果没有向 EventDispatcher 对象注册任何匹配的侦听器，则对此方法的调用没有任何效果。

参数

删除指定索引处的项目并返回该项目。原先位于此索引之后的所有项目的索引现在都向前移动一个位置。

参数

在指定的索引处放置项目。如果此索引处已存在项目，新项目将替代该项目，并返回该项目。

参数

返回与 IList 实现的填充顺序相同的 Array。此方法可能会引发 ItemPendingError。

将此视图的内容输出到字符串并返回该字符串。

检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。将指定类型的事件调度给此 EventDispatcher 对象或其任一后代时，如果在事件流的任何阶段触发了事件侦听器，则此方法返回 true。

hasEventListener() 与 willTrigger() 的区别是：hasEventListener() 只检查它所属的对象，而 willTrigger() 检查整个事件流以查找由 type 参数指定的事件。

参数

以某种方式更新 ICollectionView 后调度。

事件对象的属性具有下列值。并非所有属性对于各种事件都有意义。有关详细信息，请参阅详细的属性说明。