Packagefeathers.data
Interfacepublic interface IHierarchicalCollectionDataDescriptor
Implementors ArrayChildrenHierarchicalCollectionDataDescriptor

An adapter interface to support any kind of data source in hierarchical collections.

See also

HierarchicalCollection


Public Methods
 MethodDefined By
  
addItemAt(data:Object, item:Object, index:int, ... rest):void
Adds an item to the data source, at the specified location.
IHierarchicalCollectionDataDescriptor
  
getItemAt(data:Object, index:int, ... rest):Object
Returns the item at the specified location in the data source.
IHierarchicalCollectionDataDescriptor
  
getItemLocation(data:Object, item:Object, result:Vector.<int> = null, ... rest):Vector.<int>
Determines which location the item appears at within the data source.
IHierarchicalCollectionDataDescriptor
  
getLength(data:Object, ... rest):int
The number of items at the specified location in the data source.
IHierarchicalCollectionDataDescriptor
  
isBranch(node:Object):Boolean
Determines if a node from the data source is a branch.
IHierarchicalCollectionDataDescriptor
  
removeAll(data:Object):void
Removes all items from the data source.
IHierarchicalCollectionDataDescriptor
  
removeItemAt(data:Object, index:int, ... rest):Object
Removes the item at the specified location from the data source and returns it.
IHierarchicalCollectionDataDescriptor
  
setItemAt(data:Object, item:Object, index:int, ... rest):void
Replaces the item at the specified location with a new item.
IHierarchicalCollectionDataDescriptor
Method Detail
addItemAt()method
public function addItemAt(data:Object, item:Object, index:int, ... rest):void

Adds 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):Object

Returns 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

Returns
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

Returns
Vector.<int>
getLength()method 
public function getLength(data:Object, ... rest):int

The 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

Returns
int
isBranch()method 
public function isBranch(node:Object):Boolean

Determines if a node from the data source is a branch.

Parameters

node:Object

Returns
Boolean
removeAll()method 
public function removeAll(data:Object):void

Removes all items from the data source.

Parameters

data:Object

removeItemAt()method 
public function removeItemAt(data:Object, index:int, ... rest):Object

Removes 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

Returns
Object
setItemAt()method 
public function setItemAt(data:Object, item:Object, index:int, ... rest):void

Replaces 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