Class TreeLayoutHelper.TreeNode
java.lang.Object
org.eclipse.gef.layout.algorithms.TreeLayoutHelper.TreeNode
- Enclosing class:
- TreeLayoutHelper
Represents a node in a tree structure and stores all information related
to it. May be subclassed if additional data and behavior is necessary.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final List<TreeLayoutHelper.TreeNode>The children of this node.protected intThe depth of the node.protected booleantrueif this node is the first child, otherwisefalse.protected intThe height of the node.protected booleantrueif this node is the last child, otherwisefalse.protected final org.eclipse.gef.graph.NodeThe wrappedNode.protected intThe number of descendants.protected intThe number of leaves.protected intThe order of this node.protected final TreeLayoutHelperTheTreeLayoutHelperthat controls thisTreeLayoutHelper.TreeNode.protected TreeLayoutHelper.TreeNodeThe parent of this node. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedTreeNode(org.eclipse.gef.graph.Node node, TreeLayoutHelper owner) Creates a tree node related to given layout node -
Method Summary
Modifier and TypeMethodDescriptionprotected voidAdds given node to the list of this node's children and set its parent to this node.protected voidFinds a node that is the best parent for this node.intgetDepth()intorg.eclipse.gef.graph.NodegetNode()intintintgetOrder()Returns order in which nodes are visited during Deep First Search.getOwner()booleanisAncestorOf(TreeLayoutHelper.TreeNode descendant) protected booleanisBetterParent(TreeLayoutHelper.TreeNode potentialParent) Checks if a potential parent would be better for this node than its current parent.booleanbooleanprotected voidPerforms a DFS on the tree structure and calculates all parameters of its nodes.
-
Field Details
-
node
protected final org.eclipse.gef.graph.Node nodeThe wrappedNode. -
owner
TheTreeLayoutHelperthat controls thisTreeLayoutHelper.TreeNode. -
height
protected int heightThe height of the node. -
depth
protected int depthThe depth of the node. -
numOfLeaves
protected int numOfLeavesThe number of leaves. -
numOfDescendants
protected int numOfDescendantsThe number of descendants. -
order
protected int orderThe order of this node. -
children
The children of this node. -
parent
The parent of this node. -
firstChild
protected boolean firstChildtrueif this node is the first child, otherwisefalse. -
lastChild
protected boolean lastChildtrueif this node is the last child, otherwisefalse.
-
-
Constructor Details
-
TreeNode
Creates a tree node related to given layout node- Parameters:
node- the layout nodeowner-TreeLayoutObserverowning created node
-
-
Method Details
-
getNode
public org.eclipse.gef.graph.Node getNode()- Returns:
- node layout related to this tree node (null for
Super Root)
-
getOwner
- Returns:
TreeLayoutObserverowning this tree node
-
getHeight
public int getHeight()- Returns:
- height of this node in the tree (the longest distance to a leaf, 0 for a leaf itself)
-
getDepth
public int getDepth()- Returns:
- depth of this node in the tree (distance from root, 0 for a
root and -1 for
Super Root
-
getNumOfLeaves
public int getNumOfLeaves()- Returns:
- number of all leaves descending from this node (1 for a leaf itself)
-
getNumOfDescendants
public int getNumOfDescendants()- Returns:
- total number of descendants of this node (0 for leafs)
-
getOrder
public int getOrder()Returns order in which nodes are visited during Deep First Search. Children are visited in the same order as they were added to their layout context, unlessTreeLayoutHelper.computeTree(Node[])was called after the nodes were added. In that case the order is determined by order of nodes returned byNode.getAllSuccessorNodes(). Leaves are assigned successive numbers starting from 0, other nodes have order equal to the smallest order of their children.- Returns:
- order of this node
-
getChildren
- Returns:
- an unmodifiable list of this node's children
-
getParent
- Returns:
- this node's parent
-
isFirstChild
public boolean isFirstChild()- Returns:
- true if this node is the first child of its parent (has the smallest order)
-
isLastChild
public boolean isLastChild()- Returns:
- true if this node is the last child of its parent (has the highest order)
-
addChild
Adds given node to the list of this node's children and set its parent to this node.- Parameters:
child- node to add
-
precomputeTree
protected void precomputeTree()Performs a DFS on the tree structure and calculates all parameters of its nodes. Should be called onSuper Root. Uses recurrence to go through all the nodes. -
findNewParent
protected void findNewParent()Finds a node that is the best parent for this node. Add this node as a child of the found node. -
isBetterParent
Checks if a potential parent would be better for this node than its current parent. A better parent has smaller depth (with exception toSuper Root, which has depth equal to -1 but is never a better parent than any other node).- Parameters:
potentialParent- potential parent to check- Returns:
- true if potentialParent can be a parent of this node and is better than its current parent
-
isAncestorOf
- Parameters:
descendant- TheTreeLayoutHelper.TreeNodein question.- Returns:
- true if this node is an ancestor if given descendant node
-