Interface ITreeData<T>
- All Known Implementing Classes:
GlazedListTreeData
public interface ITreeData<T>
-
Method Summary
Modifier and TypeMethodDescriptiongetChildren
(int index) Return the child objects below the object at the given index if the object is a tree node.getChildren
(T object) Return the child objects below the given object if the object is a tree node.getChildren
(T object, boolean fullDepth) Return the child objects below the given object if the object is a tree node.getDataAtIndex
(int index) int
getDepthOfData
(int index) int
getDepthOfData
(T object) int
boolean
hasChildren
(int index) boolean
hasChildren
(T object) int
boolean
isValidIndex
(int index) Checks if a given index points to an element of the underlying list this ITreeData is connected to.
-
Method Details
-
getDepthOfData
- Parameters:
object
- The object that is represented by the tree node whose depth is requested.- Returns:
- the number of ancestors of the node for the given object. Root nodes have depth 0, other nodes depth is one greater than the depth of their parent node.
-
getDepthOfData
int getDepthOfData(int index) - Parameters:
index
- The index of the tree node whose depth is requested.- Returns:
- the number of ancestors of the node at the specified index. Root nodes have depth 0, other nodes depth is one greater than the depth of their parent node.
-
getDataAtIndex
- Parameters:
index
- The index for which the corresponding object in the tree structure is requested.- Returns:
- The object at the given index in the tree structure.
-
indexOf
- Parameters:
child
- The child whose index is requested.- Returns:
- The index of the given child object in the tree structure.
-
hasChildren
- Parameters:
object
- The object which should be checked for children.- Returns:
true
if the object has children in the tree structure,false
if it is a leaf.
-
hasChildren
boolean hasChildren(int index) - Parameters:
index
- The index of the object in the tree structure which should be checked for children.- Returns:
true
if the object has children in the tree structure,false
if it is a leaf.
-
getChildren
Return the child objects below the given object if the object is a tree node. It will only return the direct children and will not search for sub children.- Parameters:
object
- The object whose children are requested.- Returns:
- The children of the given object.
-
getChildren
Return the child objects below the given object if the object is a tree node.- Parameters:
object
- The object whose children are requested.fullDepth
- to return only direct children or search for sub children- Returns:
- The children of the given object.
-
getChildren
Return the child objects below the object at the given index if the object is a tree node. It will only return the direct children and will not search for sub children.- Parameters:
index
- The index of the object whose children are requested.- Returns:
- The children of the object at the given index.
-
getElementCount
int getElementCount()- Returns:
- The number of elements handled by this ITreeData.
-
isValidIndex
boolean isValidIndex(int index) Checks if a given index points to an element of the underlying list this ITreeData is connected to. This check is necessary for example to support mixing in a summary row together with a tree, where the summary row index is not in scope of the underlying list.- Parameters:
index
- The index to check.- Returns:
true
if the index points to an element of the underlying list,false
if it doesn't.
-