A function to determine if each item in the collection should be included or excluded from visibility through APIs like length and getItemAt().

The function is expected to have the following signature:

function( item:Object ):Boolean

In the following example, the filter function is based on the text of a TextInput component:

var collection:IListCollection; //this would be created from a concrete implementation
var list:List = new List();
list.dataProvider = collection;
this.addChild( list );
var input:TextInput = new TextInput();
input.addEventListener( Event.CHANGE, function():void
{
   if( input.text.length == 0 )
   {
       collection.filterFunction = null;
       return;
   }
   collection.filterFunction = function( item:Object ):Boolean
   {
       var itemText:String = item.label.toLowerCase();
       var filterText:String = input.text.toLowerCase();
       return itemText.indexOf( filterText ) >= 0;
   };
} );
this.addChild( input );

The default value is null.

The number of items in the collection.

A function to compare each item in the collection to determine the order when sorted.

The function is expected to have the following signature:

function( a:Object, b:Object ):int

The return value should be -1 if the first item should appear before the second item when the collection is sorted. The return value should be 1 if the first item should appear after the second item when the collection in sorted. Finally, the return value should be 0 if both items have the same sort order.

The default value is null.

Adds all items from another collection.

Parameters

Adds all items from another collection, placing the items at a specific index in this collection.

Parameters

Adds an item to the end of the collection.

If the collection is filtered, addItem() may add the item to the unfiltered data, but omit it from the filtered data. If the item is omitted from the filtered data, CollectionEventType.ADD_ITEM will not be dispatched.

Parameters

Adds an item to the collection, at the specified index.

If the collection is filtered, the index is the position in the filtered data, rather than position in the unfiltered data.

Parameters

Determines if the specified item is in the collection.

If the collection is filtered, contains() will return false for items that are excluded by the filter.

Parameters

Calls a function for each item in the collection that may be used to dispose any properties on the item. For example, display objects or textures may need to be disposed.

The function is expected to have the following signature:

function( item:Object ):void

In the following example, the items in the collection are disposed:

collection.dispose( function( item:Object ):void
{
    var accessory:DisplayObject = DisplayObject(item.accessory);
    accessory.dispose();
}

If the collection has a filterFunction, it will be removed, and it will not be restored.

Parameters

See also

Returns the item at the specified index in the collection.

Parameters

Determines which index the item appears at within the collection. If the item isn't in the collection, returns -1.

If the collection is filtered, getItemIndex() will return -1 for items that are excluded by the filter.

Parameters

Removes the item from the end of the collection and returns it.

A convenient alias for addItem().

Parameters

See also

Refreshes the collection using the filterFunction or sortCompareFunction without passing in a new values for these properties. Useful when either of these functions relies on external variables that have changed.

Removes all items from the collection.

Removes a specific item from the collection.

If the collection is filtered, removeItem() will not remove the item from the unfiltered data if it is not included in the filtered data. If the item is not removed, CollectionEventType.REMOVE_ITEM will not be dispatched.

Parameters

Removes the item at the specified index from the collection and returns it.

If the collection is filtered, the index is the position in the filtered data, rather than position in the unfiltered data.

Parameters

Replaces the collection's data with data from another collection.

Parameters

Replaces the item at the specified index with a new item.

Parameters

Removes the first item in the collection and returns it.

Adds an item to the beginning of the collection.

Parameters

Call updateAll() to manually inform any component rendering the IListCollection that the properties of all, or many, of the collection's items have changed, and that any rendered views should be updated. The collection will dispatch the CollectionEventType.UPDATE_ALL event.

Alternatively, the item can dispatch an event when one of its properties has changed, and a custom item renderer can listen for that event and update itself automatically.

See also

Call updateItemAt() to manually inform any component rendering the IListCollection that the properties of a single item in the collection have changed, and that any views associated with the item should be updated. The collection will dispatch the CollectionEventType.UPDATE_ITEM event.

Alternatively, the item can dispatch an event when one of its properties has changed, and a custom item renderer can listen for that event and update itself automatically.

Parameters

See also

Dispatched when an item is added to the collection.

The properties of the event object have the following values:

Dispatched when the underlying data source changes and components will need to redraw the data.

The properties of the event object have the following values:

Dispatched when the filterFunction property changes or the refresh() function is called on the IListCollection.

The properties of the event object have the following values:

See also

Dispatched when an item is removed from the collection.

The properties of the event object have the following values:

Dispatched when an item is replaced in the collection.

The properties of the event object have the following values:

Dispatched when the collection has changed drastically, such as when the underlying data source is replaced completely.

The properties of the event object have the following values:

Dispatched when the sortCompareFunction property changes or the refresh() function is called on the IListCollection.

The properties of the event object have the following values:

See also

Dispatched when the updateAll() function is called on the IListCollection.

The properties of the event object have the following values:

See also

Dispatched when the updateItemAt() function is called on the IListCollection.

The properties of the event object have the following values:

See also