View source

class TreeCollection<T>

package feathers.data

extends EventDispatcher

implements IHierarchicalCollection<TreeNode<T>>

@:event(openfl.events.Event.CHANGE)@:event(feathers.events.HierarchicalCollectionEvent.ADD_ITEM)@:event(feathers.events.HierarchicalCollectionEvent.REMOVE_ITEM)@:event(feathers.events.HierarchicalCollectionEvent.REPLACE_ITEM)@:event(feathers.events.HierarchicalCollectionEvent.REMOVE_ALL)@:event(feathers.events.HierarchicalCollectionEvent.RESET)@:event(feathers.events.HierarchicalCollectionEvent.UPDATE_ITEM)@:event(feathers.events.HierarchicalCollectionEvent.UPDATE_ALL)@:event(feathers.events.HierarchicalCollectionEvent.FILTER_CHANGE)@:event(feathers.events.HierarchicalCollectionEvent.SORT_CHANGE)@:meta(DefaultProperty("array"))@defaultXmlProperty("array")

Wraps an Array data source with a common API for use with UI controls that support hierarchical data, such as TreeView.

Events:

openfl.events.Event.CHANGE
feathers.events.HierarchicalCollectionEvent.ADD_ITEM
feathers.events.HierarchicalCollectionEvent.REMOVE_ITEM
feathers.events.HierarchicalCollectionEvent.REPLACE_ITEM
feathers.events.HierarchicalCollectionEvent.REMOVE_ALL
feathers.events.HierarchicalCollectionEvent.RESET
feathers.events.HierarchicalCollectionEvent.UPDATE_ITEM
feathers.events.HierarchicalCollectionEvent.UPDATE_ALL
feathers.events.HierarchicalCollectionEvent.FILTER_CHANGE
feathers.events.HierarchicalCollectionEvent.SORT_CHANGE
Available since

1.0.0

.

See also:

Constructor

new(?array:Array<TreeNode<T>>)

Creates a new TreeCollection object with the given arguments.

Available since

1.0.0

.

Variables

@:flash.propertyarray:Array<TreeNode<T>>

The Array<TreeNode> data source for this collection.

The following example replaces the data source with a new array:

collection.array = [];
Available since

1.0.0

.

@:flash.propertyfilterFunction:TreeNode<T> ‑> Bool

See also:

@:flash.propertysortCompareFunction:(TreeNode<T>, TreeNode<T>) ‑> Int

See also:

Methods

addAt(itemToAdd:TreeNode<T>, location:Array<Int>):Void

See also:

contains(item:TreeNode<T>):Bool

See also:

get(location:Array<Int>):TreeNode<T>

See also:

getLength(?location:Array<Int>):Int

See also:

isBranch(item:TreeNode<T>):Bool

See also:

locationOf(item:TreeNode<T>):Array<Int>

See also:

refresh():Void

See also:

remove(item:TreeNode<T>):Void

See also:

removeAll():Void

See also:

removeAt(location:Array<Int>):TreeNode<T>

See also:

set(location:Array<Int>, value:TreeNode<T>):Void

See also:

updateAll():Void

See also:

updateAt(location:Array<Int>):Void

See also: