TreeGuiImpl.TreeNode (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.ui.client.gui.TreeGuiImpl.TreeNode

All Implemented Interfaces:

Printable

Enclosing class:

TreeGuiImpl
```
public static class TreeGuiImpl.TreeNode
extends java.lang.Object
implements Printable
```
The class represents one tree node.

Field Summary

Fields
Modifier and Type	Field and Description
`java.util.List<TreeGuiImpl.TreeNode>`	`nodes` Child nodes or `null` if case of no children
`TreeGuiImpl.TreeNode`	`parent` Parent node
`TreeNodeEntry`	`value` Related config node entry

Constructor Summary

Constructors
Modifier Constructor and Description

private TreeNode(TreeNodeEntry value)
The constructor.

Constructors
Modifier	Constructor and Description
`private`	`TreeNode(TreeNodeEntry value)` The constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChild(TreeGuiImpl.TreeNode node)` Adds a node to the list of child nodes.
`private java.util.List<TreeGuiImpl.TreeNode>`	`ancestorsAndThis()` Get a list consisting of this node and all ancestors of this node, the tree root will be the first list item.
`int`	`childIndex()` Get this node index in the sibling list.
`private int`	`childIndex(TreeGuiImpl.TreeNode node)` Search this node children for a node with the given node value.
`boolean`	`descendsFrom(TreeGuiImpl.TreeNode other)` Test if this node descends from the given node.
`int`	`getLevel()` Returns the zero based node level.
`int`	`getNodeImageId(boolean nodeSelected)` Return the internal image identifier.
`boolean`	`isDFTBeforeThan(TreeGuiImpl.TreeNode other)` Test if this node precedes a given node in tree depth first traversal order.
`private boolean`	`isSiblingLowerThan(TreeGuiImpl.TreeNode other)` Test if this node is strictly lower than other sibling node in the sibling order.
`private TreeGuiImpl.TreeNode`	`lastVisibleChild()` Get the last child of this node or `null` if this node has no children or is collapsed.
`TreeGuiImpl.TreeNode`	`nextDFT()` Get the node next to this node on DFT order.
`TreeGuiImpl.TreeNode`	`nextSibling()` Get the next sibling of this node or `null` if this node is the last child or the tree root.
`private TreeGuiImpl.TreeNode`	`nextSiblingRecursively()` Get this node next sibling if exists, otherwise call this function recursively for this node parent.
`TreeGuiImpl.TreeNode`	`nextVisible()` Get the next visible node in the hierarchy
`TreeGuiImpl.TreeNode`	`nodeAt(java.util.function.Function<TreeGuiImpl.TreeNode,TreeGuiImpl.TreeNode> getNext, int distance)` Traverse from this node to the distance using the provided function returning the next node.
`private TreeGuiImpl.TreeNode`	`prevSibling()` Get the previous sibling of this node or `null` if this node is the first child.
`TreeGuiImpl.TreeNode`	`prevVisible()` Get the previous visible node in the tree or `null`:
`void`	`print(PrintHelper printer)` Add class-specific fields to the helper.
`void`	`remove()` Remove this node from its parent child nodes.
`java.lang.String`	`toString()` Returns a string representation of the object.
`int`	`visibleIndex()` Get node visible index.
`java.lang.Iterable<TreeGuiImpl.TreeNode>`	`visibleNodes(java.util.function.Function<TreeGuiImpl.TreeNode,TreeGuiImpl.TreeNode> getNext)` Get iterable for all visible tree nodes, starting from this node.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.util.Printable
asString

- Field Detail
  - nodes
```
public java.util.List<TreeGuiImpl.TreeNode> nodes
```
    Child nodes or null if case of no children
  - parent
```
public TreeGuiImpl.TreeNode parent
```
    Parent node
  - value
```
public final TreeNodeEntry value
```
    Related config node entry
- Constructor Detail
  - TreeNode
```
private TreeNode(TreeNodeEntry value)
```
    The constructor.
- Method Detail
  - addChild
```
public void addChild(TreeGuiImpl.TreeNode node)
```
    Adds a node to the list of child nodes. Check if node already exists avoiding potential duplication.
    
    Parameters:
    
    node - The node to add.
  - childIndex
```
public int childIndex()
```
    Get this node index in the sibling list. Node must not be the tree root.
    
    Returns:
    
    see above
  - descendsFrom
```
public boolean descendsFrom(TreeGuiImpl.TreeNode other)
```
    Test if this node descends from the given node.
    
    Parameters:
    
    other - the other node
    
    Returns:
    
    see above
  - getLevel
```
public int getLevel()
```
    Returns the zero based node level. The level of the root (invisible) node is -1.
    
    Returns:
    
    the node level.
  - getNodeImageId
```
public final int getNodeImageId(boolean nodeSelected)
```
    Return the internal image identifier.
    
    Parameters:
    
    nodeSelected - The value indicates if the requested image is for the selected node.
    
    Returns:
    
    The internal image identifier.
  - isDFTBeforeThan
```
public boolean isDFTBeforeThan(TreeGuiImpl.TreeNode other)
```
    Test if this node precedes a given node in tree depth first traversal order. Both nodes must not be null, the same node, or tree root.
    
    Parameters:
    
    other - the node to compare with
    
    Returns:
    
    see above.
  - nextDFT
```
public final TreeGuiImpl.TreeNode nextDFT()
```
    Get the node next to this node on DFT order. Note: node expansion status is ignored.
    
    Returns:
    
    see above
  - nextSibling
```
public final TreeGuiImpl.TreeNode nextSibling()
```
    Get the next sibling of this node or null if this node is the last child or the tree root.
    
    Returns:
    
    see above
  - nextVisible
```
public TreeGuiImpl.TreeNode nextVisible()
```
    Get the next visible node in the hierarchy
    
    Returns:
    
    the next visible node or null if this node is the last visible node.
  - nodeAt
```
public final TreeGuiImpl.TreeNode nodeAt(java.util.function.Function<TreeGuiImpl.TreeNode,TreeGuiImpl.TreeNode> getNext,
                                         int distance)
```
    Traverse from this node to the distance using the provided function returning the next node. Return the node.
    
    Parameters:
    
    getNext - the function to navigate from one node to another
    
    distance - the number of steps to move
    
    Returns:
    
    see above
  - prevVisible
```
public TreeGuiImpl.TreeNode prevVisible()
```
    Get the previous visible node in the tree or null:
  - if this node is the first sibling, return node parent;
  - otherwise return the last node in the previous sibling subtree.

Returns:: see above

remove
```
public void remove()
```
Remove this node from its parent child nodes.

visibleIndex
```
public final int visibleIndex()
```
Get node visible index.

Returns:

the node index in DFT

visibleNodes
```
public final java.lang.Iterable<TreeGuiImpl.TreeNode> visibleNodes(java.util.function.Function<TreeGuiImpl.TreeNode,TreeGuiImpl.TreeNode> getNext)
```
Get iterable for all visible tree nodes, starting from this node.

Parameters:

getNext - a function to navigate to the next node

Returns:

see above

print
```
public void print(PrintHelper printer)
```
Add class-specific fields to the helper.

Specified by:

print in interface Printable

Parameters:

printer - the string helper to update

toString
```
public java.lang.String toString()
```
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
```
 getClass().getName() + '@' + Integer.toHexString(hashCode())
 
```
Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

ancestorsAndThis
```
private final java.util.List<TreeGuiImpl.TreeNode> ancestorsAndThis()
```
Get a list consisting of this node and all ancestors of this node, the tree root will be the first list item.

Returns:

see above

childIndex
```
private int childIndex(TreeGuiImpl.TreeNode node)
```
Search this node children for a node with the given node value. Nodes are compared with Object.equals(Object).

Parameters:

node - The node to search

Returns:

index node in the list or -1 if no matching node was found.

isSiblingLowerThan
```
private final boolean isSiblingLowerThan(TreeGuiImpl.TreeNode other)
```
Test if this node is strictly lower than other sibling node in the sibling order.

Parameters:

other - other node to compare, must be a sibling to this node, and differ from this node

Returns:

see above

lastVisibleChild
```
private final TreeGuiImpl.TreeNode lastVisibleChild()
```
Get the last child of this node or null if this node has no children or is collapsed.

Returns:

see above

nextSiblingRecursively
```
private TreeGuiImpl.TreeNode nextSiblingRecursively()
```
Get this node next sibling if exists, otherwise call this function recursively for this node parent.

Returns:

the node found or null

prevSibling
```
private final TreeGuiImpl.TreeNode prevSibling()
```
Get the previous sibling of this node or null if this node is the first child.

Returns:

see above

Class TreeGuiImpl.TreeNode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.util.Printable

Field Detail

nodes

parent

value

Constructor Detail

TreeNode

Method Detail

addChild

childIndex

descendsFrom

getLevel

getNodeImageId

isDFTBeforeThan

nextDFT

nextSibling

nextVisible

nodeAt

prevVisible

remove

visibleIndex

visibleNodes

print

toString

ancestorsAndThis

childIndex

isSiblingLowerThan

lastVisibleChild

nextSiblingRecursively

prevSibling