interface IHierarchicalCollection<T>

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

The following example filters a collection of strings by searching for a substring at the beginning:

collection.filterFunction = (a:String) =>
{
	return StringTools.startsWith(a.toLowerCase(), "john");
};

See also:

• feathers.data.HierarchicalCollectionEvent.FILTER_CHANGE

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

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 is sorted. Finally, the return value should be 0 if both items have the same sort order.

The following example sorts a collection of Float values:

collection.sortCompareFunction = (a:Float, b:Float) =>
{
	if (a > b) {
		return 1;
	} else if (a < b) {
		return -1;
	}
	return 0;
};

See also:

• feathers.data.HierarchicalCollectionEvent.SORT_CHANGE

Adds an item to the collection at the specified location, increasing the the length of the parent branch by one.

var location = [2, 0];
var item = { text: "New Item" };
collection.addAt(item, location);

See also:

• feathers.data.HierarchicalCollectionEvent.ADD_ITEM

Determines if the collection contains the specified item.

The following example checks if a collection contains an item:

var item = { text: "New Item" };
collection.addAt(item, [0]);

var contained = collection.contains(item); // true

Returns the item at the specified location within the collection.

The following example gets an item from a specific location:

var location = [2, 0];
var item = collection.get(location);

The following example iterates over the items at the root of a collection:

for(i in 0...collection.getLength()) {
	var location = [i];
	var item = collection.get(i);
}

The number of items at the specified location within the collection. If called without a location, returns the length of the root.

The following example iterates over the items at the root of a collection:

for(i in 0...collection.getLength()) {
	var location = [i];
	var item = collection.get(location);
}

Determines if an item from the collection is a branch or not.

The following example iterates over the items at the root of a collection and prints the locations of branches to the debug console:

for(i in 0...collection.getLength()) {
	var location = [i];
	var item = collection.get(location);
	if(collection.isBranch(item)) {
		trace("branch: " + location);
	}
}

Returns the location of the specified item, or null if the item is not in the collection.

The following example gets the location of an item in the collection:

var item = { text: "New Item" };
collection.addAt(item, [0]);

var index = collection.locationOf(item); // [0]

Removes an item from the collection.

var location = [2, 0];
var item = { text: "New Item" };
collection.addAt(item, location);
collection.remove(item);

See also:

• feathers.data.HierarchicalCollectionEvent.REMOVE_ITEM

Removes all items from a branch, decreasing the branch's length to zero. If called without a location, returns removes all items from the root of collection, resulting in a completely empty location.

The following example removes all items from a collection:

collection.removeAll();

See also:

• feathers.data.HierarchicalCollectionEvent.REMOVE_ALL

Removes an item from the collection at the specified location, decreasing the length of the parent branch by one.

var location = [2, 0];
var item = { text: "New Item" };
collection.addAt(item, location);
collection.removeAt(location);

See also:

• feathers.data.HierarchicalCollectionEvent.REMOVE_ITEM

Replaces the item at the specified location in the collection with a new item.

The following example replaces an item in a collection:

var location = [2, 0];
collection.set(location, object);

See also:

• feathers.data.HierarchicalCollectionEvent.REPLACE_ITEM

Notifies components using the collection that all items should be considered changed.

The following example updates all items in the collection:

collection.updateAll();

See also:

• IHierarchicalCollection.updateAt

• feathers.data.HierarchicalCollectionEvent.UPDATE_ALL

Notifies components using the collection that an item at the specified location has changed.

The following example updates an item in the collection:

var location = [2, 0];
collection.updateAt(location);

See also:

• IHierarchicalCollection.updateAll

• feathers.data.HierarchicalCollectionEvent.UPDATE_ITEM