| Package | feathers.data |
| Class | public class ArrayChildrenHierarchicalCollectionDataDescriptor |
| Inheritance | ArrayChildrenHierarchicalCollectionDataDescriptor  Object |
| Implements | IHierarchicalCollectionDataDescriptor |
"children",
but it may be customized.
The basic structure of the data source takes the following form. The root must always be an Array.
[
{
text: "Branch 1",
children:
[
{ text: "Child 1-1" },
{ text: "Child 1-2" }
]
},
{
text: "Branch 2",
children:
[
{ text: "Child 2-1" },
{ text: "Child 2-2" },
{ text: "Child 2-3" }
]
}
]
| Property | Defined By | ||
|---|---|---|---|
| childrenField : String = children
The field used to access the Array of a branch's children. | ArrayChildrenHierarchicalCollectionDataDescriptor | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | ArrayChildrenHierarchicalCollectionDataDescriptor | ||
addItemAt(data:Object, item:Object, index:int, ... rest):void
Adds an item to the data source, at the specified location. | ArrayChildrenHierarchicalCollectionDataDescriptor | ||
getItemAt(data:Object, index:int, ... rest):Object
Returns the item at the specified location in the data source. | ArrayChildrenHierarchicalCollectionDataDescriptor | ||
getItemLocation(data:Object, item:Object, result:Vector.<int> = null, ... rest):Vector.<int>
Determines which location the item appears at within the data source. | ArrayChildrenHierarchicalCollectionDataDescriptor | ||
getLength(data:Object, ... rest):int
The number of items at the specified location in the data source. | ArrayChildrenHierarchicalCollectionDataDescriptor | ||
isBranch(node:Object):Boolean
Determines if a node from the data source is a branch. | ArrayChildrenHierarchicalCollectionDataDescriptor | ||
removeItemAt(data:Object, index:int, ... rest):Object
Removes the item at the specified location from the data source and
returns it. | ArrayChildrenHierarchicalCollectionDataDescriptor | ||
setItemAt(data:Object, item:Object, index:int, ... rest):void
Replaces the item at the specified location with a new item. | ArrayChildrenHierarchicalCollectionDataDescriptor | ||
| childrenField | property |
public var childrenField:String = childrenThe field used to access the Array of a branch's children.
| ArrayChildrenHierarchicalCollectionDataDescriptor | () | Constructor |
public function ArrayChildrenHierarchicalCollectionDataDescriptor()Constructor.
| addItemAt | () | method |
public function addItemAt(data:Object, item:Object, index:int, ... rest):voidAdds an item to the data source, at the specified location.
The rest arguments are the indices that make up the location.
Parameters
data:Object | |
item:Object | |
index:int | |
... rest |
| getItemAt | () | method |
public function getItemAt(data:Object, index:int, ... rest):ObjectReturns the item at the specified location in the data source.
The rest arguments are the indices that make up the location.
Parameters
data:Object | |
index:int | |
... rest |
Object |
| getItemLocation | () | method |
public function getItemLocation(data:Object, item:Object, result:Vector.<int> = null, ... rest):Vector.<int>
Determines which location the item appears at within the data source.
If the item isn't in the data source, returns an empty Vector.<int>.
The rest arguments are optional indices to narrow
the search.
Parameters
data:Object | |
item:Object | |
result:Vector.<int> (default = null) | |
... rest |
Vector.<int> |
| getLength | () | method |
public function getLength(data:Object, ... rest):intThe number of items at the specified location in the data source.
The rest arguments are the indices that make up the location. If a location is omitted, the length returned will be for the root level of the collection.
Parameters
data:Object | |
... rest |
int |
| isBranch | () | method |
public function isBranch(node:Object):BooleanDetermines if a node from the data source is a branch.
Parameters
node:Object |
Boolean |
| removeItemAt | () | method |
public function removeItemAt(data:Object, index:int, ... rest):ObjectRemoves the item at the specified location from the data source and returns it.
The rest arguments are the indices that make up the location.
Parameters
data:Object | |
index:int | |
... rest |
Object |
| setItemAt | () | method |
public function setItemAt(data:Object, item:Object, index:int, ... rest):voidReplaces the item at the specified location with a new item.
The rest arguments are the indices that make up the location.
Parameters
data:Object | |
item:Object | |
index:int | |
... rest |