Constructor
new CollectionNodeSet()
A CollectionNodeSet represents a collection of nodes. The CollectionNodeSet is an object returned by the success callback
of the fetchChildren method on CollectionTreeDataSource.
- Source:
Methods
-
getChildNodeSet(index) → {oj.CollectionNodeSet|null}
-
Gets the node set child of the specified index.
Parameters:
Name Type Description index
number the index of the node/row in which we want to retrieve the child node set - Source:
- ojtree-model/CollectionNodeSet.js, line 162
Returns:
the child node set representing the child collection.- Type
- oj.CollectionNodeSet | null
-
getCount() → {number}
-
Gets the actual count of the result set.
- Source:
- ojtree-model/CollectionNodeSet.js, line 102
Returns:
the actual count of the result set.- Type
- number
-
getData(index) → {Object}
-
Gets the data of the specified index. An error is throw when 1) the range is not yet available and 2) the index specified is out of bounds.
Parameters:
Name Type Description index
number the index of the node/row in which we want to retrieve the data from. - Source:
- ojtree-model/CollectionNodeSet.js, line 115
Returns:
the data for the specified index. oj.RowData should be returned for data that represents a row with a number of columns.- Type
- Object
-
getMetadata(index) → {Object}
-
Gets the metadata of the specified index. An error is throw when 1) the range is not yet available and 2) the index specified is out of bounds. The metadata that the data source must return are: 1) key - Object, the key of the node/row. 2) leaf - boolean, true if it's a leaf, false otherwise. 3) depth? - number, the depth of the node/row. (or should the caller just calculate it?)
Parameters:
Name Type Description index
number the index of the node/row in which we want to retrieve the metadata from. - Source:
- ojtree-model/CollectionNodeSet.js, line 139
Returns:
the metadata object for the specific index.- Type
- Object
-
getParent() → {Object}
-
Gets the parent key for this result set.
- Source:
- ojtree-model/CollectionNodeSet.js, line 82
Returns:
the parent key for this result set.- Type
- Object
-
getStart() → {number}
-
Gets the start index of the result set.
- Source:
- ojtree-model/CollectionNodeSet.js, line 92
Returns:
the start index of the result set.- Type
- number