IHierarchicalCollectionDataDescriptor

public interface
feathers.data.IHierarchicalCollectionDataDescriptor

Description

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

See also:
feathers.data.HierarchicalCollection

API overview

Constructor

IHierarchicalCollectionDataDescriptor ()

Functions

Public functions

addItemAt ( data: Object , item: Object , index: Number , rest: Vector.<Object> ): Void

Adds an item to the data source, at the specified location

getItemAt ( data: Object , index: Number , rest: Vector.<Object> ): Object

Returns the item at the specified location in the data source

getItemLocation ( data: Object , item: Object , result: Vector.<Number> = null , rest: Vector.<Object> ): Vector.<Number>

Determines which location the item appears at within the data source

getLength ( data: Object , rest: Vector.<Object> ): Number

The number of items at the specified location in the data source

isBranch ( node: Object ): Boolean

Determines if a node from the data source is a branch

removeItemAt ( data: Object , index: Number , rest: Vector.<Object> ): Object

Removes the item at the specified location from the data source and returns it

setItemAt ( data: Object , item: Object , index: Number , rest: Vector.<Object> ): Void

Replaces the item at the specified location with a new item

Constructor

IHierarchicalCollectionDataDescriptor ()

Functions

addItemAt ( data: Object , item: Object , index: Number , rest: Vector.<Object> ): 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: Number
rest: Vector.<Object>


getItemAt ( data: Object , index: Number , rest: Vector.<Object> ): 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: Number
rest: Vector.<Object>


getItemLocation ( data: Object , item: Object , result: Vector.<Number> = null , rest: Vector.<Object> ): Vector.<Number>

Determines which location the item appears at within the data source. If the item isn't in the data source, returns an empty Vector.&lt;int&gt;.

The rest arguments are optional indices to narrow the search.

Parameters

data: Object
item: Object
result: Vector.<Number> = null
rest: Vector.<Object>


getLength ( data: Object , rest: Vector.<Object> ): Number

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: Vector.<Object>


isBranch ( node: Object ): Boolean

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

Parameters

node: Object


removeItemAt ( data: Object , index: Number , rest: Vector.<Object> ): 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: Number
rest: Vector.<Object>


setItemAt ( data: Object , item: Object , index: Number , rest: Vector.<Object> ): 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: Number
rest: Vector.<Object>


: