ListCollectionView中filterFunction只对集合过滤一次的实现

在Flex中，集合类ListCollectionView及其子类是很常用的。这个类提供了两个很有用的功能，一个是过滤，一个是排序。这两个功能的实现是设置ListCollectionViewr的filterFunction和sort属性，然后调用refresh方法。然后refresh方法会在系统认为合适的时候，更新集合内容。

不过，在集合内容被更新之后，ListCollectionViewr的filterFunction和sort属性并不会被清除，而且这时向集合中插入新的元素，都要经过过滤和排序。

尤其是对过滤操作来说，我们很可能会遇到希望只对集合现有的元素一次过滤，然后在后续的插入操作中，不再进行过滤。这时，就需要在集合更新操作完成之后，将ListCollectionViewr的filterFunction属性置空。而另一方面，Flex系统并不一定会在refresh方法被调用时，就会立刻去更新集合内容，所以我们在调用refresh方法后，立刻去将filterFunction置空，可能会出现问题。根据Flex 的language reference，当集合更新完成后，集合会触发CollectionEvent事件，并且这个事件的kind属性是CollectionEventKind.REFRESH，那么我们就有以下这种解决方法。

1. package mithrilon.flex {
3.     import mx.collections.ListCollectionView;
4.     import mx.events.CollectionEvent;
5.     import mx.events.CollectionEventKind;
7.     public class CollectionUtils {
9.         /**
10.         * Filter <code>ListCollectionView</code> parameter collection with <code>Function</code>
11.         * parameter filterFunction, then refresh the collection. When refreshing has been finished,
12.         * remove the filterFunction from the collection.
13.         * 
14.         * NOTE:The definition of filterFunction must follow the requirement of 
15.         * <code>ListCollectionView</code>. 
16.         */
17.         public static function filterCollectionOnceAndRefresh(collection:ListCollectionView,
18.                 filterFunction:Function):void
19.         {
20.             filterCollectionOnce(collection, filterFunction);
21.             collection.refresh();
22.         }
24.         /**
25.         * Filter <code>ListCollectionView</code> parameter collection with <code>Function</code>
26.         * parameter filterFunction. When refreshing has been finished, filterFunction will be
27.         * removed from the collection.
28.         * 
29.         * NOTE:The definition of filterFunction must follow the requirement of 
30.         * <code>ListCollectionView</code>.
31.         * NOTE: You should refresh the collection. 
32.         */
33.         public static function filterCollectionOnce(collection:ListCollectionView,
34.                 filterFunction:Function):void
35.         {
36.             collection.filterFunction = filterFunction;
37.             collection.addEventListener(CollectionEvent.COLLECTION_CHANGE, removeCollectionFilter);
38.         }
40.         /**
41.         * This is a event handler for <code>CollectionEvent</code>. When the event parameter's kind
42.         * property is <code>CollectionEventKind.REFRESH</code>, it will remove filterFunction from 
43.         * collection dipatching event.
44.         * 
45.         * When a <code>ListCollectionView</code> object dispatches a CollectionEvent object whose
46.         * kind property is <code>CollectionEventKind.REFRESH</code>, it means the refreshing
47.         * operation on that collection has been done successfully.
48.         */
49.         public static function removeCollectionFilter(event:CollectionEvent):void {
50.             if (!event || event.kind != CollectionEventKind.REFRESH) {
51.                 return;
52.             }
54.             var collection:ListCollectionView = event.target as ListCollectionView;
55.             collection.filterFunction = null;
57.             collection.removeEventListener(CollectionEvent.COLLECTION_CHANGE, removeCollectionFilter);
59.             //NOTE: It is NOT enough to set filterFunction to be null to remove filter from
60.             //collection. Calling refresh method is necessary, or some internal data containing
61.             //filtering info will cause some error.
62.             collection.refresh();
63.         }
64.     }
65. }

可以如下使用此工具类。

 

1. ……
2. var collection:ArrayCollection = new ArrayCollection();
3. ……
4. CollectionUtils.filterCollectionOnceAndRefresh(collection, someFilter);
5. ……

 

注意：

在CollectionUtils的62行，此处调用refresh方法的作用是将集合内部保存的一些过滤和排序的视图数据清空，因为只是将filterFunction置空，集合是不会同时清除视图数据的，这时如果对集合进行操作，就会产生一些运行时异常。而且也必须在collection.removeEventListener(CollectionEvent.COLLECTION_CHANGE, removeCollectionFilter)这段代码的后面调用refresh，否则

removeCollectionFilter可能会被重复调用。