Modifier and Type	Class and Description
private static class	TreeNode.TreeNodeSpliterator<T>

Modifier and Type	Field and Description
private final ObservableList<TreeNode<T>>	children This list holds the child nodes of the current node in the tree hierarchy.
private static final boolean	DEFAULT_EXPANDED
private static final double	DEFAULT_HEIGHT
private static final double	DEFAULT_WIDTH
private final BooleanProperty	expanded
private final DoubleProperty	height
private final ObservableList<TreeNode<T>>	linkedNodes This list holds references to nodes that are directly linked or associated with the current node.
private String	name Represents the name identifier for this node.
private final ReadOnlyObjectWrapper<TreeNode<T>>	parent
public static final double	USE_TREE_CELL_SIZE
private final ObjectProperty<T>	value
private final DoubleProperty	width

Access	Constructor and Description
public	TreeNode()
public	TreeNode(T value)

Method Summary

Modifier and Type	Method and Description
public BooleanProperty	expandedProperty()
public ObservableList<TreeNode<T>>	getChildren()
public int	Returns: the depth of the node in the tree getDepth() Get the depth of the node in the tree.
public TreeNode<T>	getFirstChild() Returns: The first node in the child node list.
public double	getHeight()
public TreeNode<T>	getLastChild() Returns: The last node in the child node list.
public int	getLevel()
public ObservableList<TreeNode<T>>	getLinkedNodes()
public String	getName()
public TreeNode<T>	getParent()
public T	getValue()
public double	getWidth()
public DoubleProperty	heightProperty()
public boolean	isAncestorCollapsed() Returns: true if the node is parent is collapsed
public boolean	isExpanded()
public boolean	isFirstChild() Returns: true: if this node is the first node of the parent
public boolean	isLastChild() Returns: true: if this node is the last node of the parent
public boolean	isLeaf() Returns: true: if the node is a leaf node
public boolean	Returns: true if the node is the root node of the tree isRoot() If there is no parent node, it is the root node
public ReadOnlyObjectProperty<TreeNode<T>>	parentProperty()
public void	setExpanded(boolean expanded)
public void	setHeight(double height)
public void	setName(String name)
protected void	setParent(TreeNode<T> parent)
public void	setSize(double width, double height)
public void	setValue(T value)
public void	setWidth(double width)
public Stream<TreeNode<T>>	stream() Convenient for traversing tree nodes.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public ObjectProperty<T>	valueProperty()
public DoubleProperty	widthProperty()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

children	back to summary
private final ObservableList<TreeNode<T>> children This list holds the child nodes of the current node in the tree hierarchy. Each child node in this list is directly connected to and descends from the current node. It represents the default connectivity in the tree structure, where parent nodes are intrinsically linked to their children.

DEFAULT_EXPANDED	back to summary
private static final boolean DEFAULT_EXPANDED

DEFAULT_HEIGHT	back to summary
private static final double DEFAULT_HEIGHT

DEFAULT_WIDTH	back to summary
private static final double DEFAULT_WIDTH

expanded	back to summary
private final BooleanProperty expanded

height	back to summary
private final DoubleProperty height

linkedNodes	back to summary
private final ObservableList<TreeNode<T>> linkedNodes This list holds references to nodes that are directly linked or associated with the current node. Unlike the 'children' list, which represents child nodes in a hierarchical structure, the 'linkedNodes' list represents peers or other related nodes that have a specific connection or relationship with this node, but are not necessarily its descendants in the tree hierarchy.

linkedNodes

back to summary

private final ObservableList<TreeNode<T>> linkedNodes

This list holds references to nodes that are directly linked or associated with the current node. Unlike the 'children' list, which represents child nodes in a hierarchical structure, the 'linkedNodes' list represents peers or other related nodes that have a specific connection or relationship with this node, but are not necessarily its descendants in the tree hierarchy.

name	back to summary
private String name Represents the name identifier for this node. ------------------------------------------------ The primary purpose of the 'name' is to assist in determining the style of the node and its links. For instance: 1. If the node's name is 'n', then the style class for the node would be 'node-n'. 2. For a regular parent-child relationship, if a node with name 'n' has a parent named 'm', the link connecting them will have a style class 'link-m-n'. 3. For any extra links, say from node 'p' to node 'n', the style class for the link would be 'link-extra-p-n'. ------------------------------------------------ Important considerations: - If the 'name' is null, all the above rules become invalid. - Both the relevant node and the current node must possess non-null 'name' values for these styling rules to apply. ------------------------------------------------ This naming convention aids in providing a systematic approach for styling, making it directly relatable to the node's relationship and connection type.

name

back to summary

private String name

Represents the name identifier for this node. ------------------------------------------------ The primary purpose of the 'name' is to assist in determining the style of the node and its links. For instance: 1. If the node's name is 'n', then the style class for the node would be 'node-n'. 2. For a regular parent-child relationship, if a node with name 'n' has a parent named 'm', the link connecting them will have a style class 'link-m-n'. 3. For any extra links, say from node 'p' to node 'n', the style class for the link would be 'link-extra-p-n'. ------------------------------------------------ Important considerations: - If the 'name' is null, all the above rules become invalid. - Both the relevant node and the current node must possess non-null 'name' values for these styling rules to apply. ------------------------------------------------ This naming convention aids in providing a systematic approach for styling, making it directly relatable to the node's relationship and connection type.

parent	back to summary
private final ReadOnlyObjectWrapper<TreeNode<T>> parent

USE_TREE_CELL_SIZE	back to summary
public static final double USE_TREE_CELL_SIZE

value	back to summary
private final ObjectProperty<T> value

width	back to summary
private final DoubleProperty width

TreeNode	back to summary
public TreeNode()

TreeNode	back to summary
public TreeNode(T value)

Method Detail

expandedProperty	back to summary
public BooleanProperty expandedProperty()

getChildren	back to summary
public ObservableList<TreeNode<T>> getChildren()

getDepth	back to summary
public int getDepth() Get the depth of the node in the tree. The depth of the root node is 0. Returns:int the depth of the node in the tree

getDepth

back to summary

public int getDepth()

Get the depth of the node in the tree. The depth of the root node is 0.

Returns:int: the depth of the node in the tree

getFirstChild	back to summary
public TreeNode<T> getFirstChild() Returns:TreeNode<T> The first node in the child node list.

getHeight	back to summary
public double getHeight()

getLastChild	back to summary
public TreeNode<T> getLastChild() Returns:TreeNode<T> The last node in the child node list.

getLevel	back to summary
public int getLevel()

getLinkedNodes	back to summary
public ObservableList<TreeNode<T>> getLinkedNodes()

getName	back to summary
public String getName()

getParent	back to summary
public TreeNode<T> getParent()

getValue	back to summary
public T getValue()

getWidth	back to summary
public double getWidth()

heightProperty	back to summary
public DoubleProperty heightProperty()

isAncestorCollapsed	back to summary
public boolean isAncestorCollapsed() Returns:boolean true if the node is parent is collapsed

isExpanded	back to summary
public boolean isExpanded()

isFirstChild	back to summary
public boolean isFirstChild() Returns:boolean true: if this node is the first node of the parent

isLastChild	back to summary
public boolean isLastChild() Returns:boolean true: if this node is the last node of the parent

isLeaf	back to summary
public boolean isLeaf() Returns:boolean true: if the node is a leaf node

isRoot	back to summary
public boolean isRoot() If there is no parent node, it is the root node Returns:boolean true if the node is the root node of the tree

isRoot

back to summary

public boolean isRoot()

If there is no parent node, it is the root node

Returns:boolean: true if the node is the root node of the tree

parentProperty	back to summary
public ReadOnlyObjectProperty<TreeNode<T>> parentProperty()

setExpanded	back to summary
public void setExpanded(boolean expanded)

setHeight	back to summary
public void setHeight(double height)

setName	back to summary
public void setName(String name)

setParent	back to summary
protected void setParent(TreeNode<T> parent)

setSize	back to summary
public void setSize(double width, double height)

setValue	back to summary
public void setValue(T value)

setWidth	back to summary
public void setWidth(double width)

stream	back to summary
public Stream<TreeNode<T>> stream() Convenient for traversing tree nodes.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

valueProperty	back to summary
public ObjectProperty<T> valueProperty()

widthProperty	back to summary
public DoubleProperty widthProperty()

com.dlsc.gemsfx.treeview back to summary

private Class TreeNode.TreeNodeSpliterator<T>

Class Inheritance

extends Object
implements Spliterator<TreeNode<T>>

java.lang.Object
com.dlsc.gemsfx.treeview.TreeNode.TreeNodeSpliterator

All Implemented Interfaces

java.util.Spliterator

Field Summary

Modifier and Type	Field and Description
private final Queue<TreeNode<T>>	queue

Constructor Summary

Access	Constructor and Description
pack-priv	TreeNodeSpliterator(TreeNode<T> root)

Method Summary

Modifier and Type	Method and Description
public int	characteristics() Implements java.util.Spliterator.characteristics. Returns a set of characteristics of this Spliterator and its elements.
public long	estimateSize() Implements java.util.Spliterator.estimateSize. Returns an estimate of the number of elements that would be encountered by a `forEachRemaining` traversal, or returns `Long#MAX_VALUE` if infinite, unknown, or too expensive to compute.
public boolean	tryAdvance(Consumer<? super TreeNode<T>> action) Implements java.util.Spliterator.tryAdvance. If a remaining element exists: performs the given action on it, returning `true`; else returns `false`.
public Spliterator<TreeNode<T>>	trySplit() Implements java.util.Spliterator.trySplit. If this spliterator can be partitioned, returns a Spliterator covering elements, that will, upon return from this method, not be covered by this Spliterator.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

queue	back to summary
private final Queue<TreeNode<T>> queue

Constructor Detail

TreeNodeSpliterator	back to summary
pack-priv TreeNodeSpliterator(TreeNode<T> root)

Method Detail

characteristics back to summary

public int characteristics()

Implements java.util.Spliterator.characteristics.

Doc from java.util.Spliterator.characteristics.

Returns a set of characteristics of this Spliterator and its elements. The result is represented as ORed values from ORDERED, DISTINCT, SORTED, SIZED, NONNULL, IMMUTABLE, CONCURRENT, SUBSIZED. Repeated calls to characteristics() on a given spliterator, prior to or in-between calls to trySplit, should always return the same result.

If a Spliterator reports an inconsistent set of characteristics (either those returned from a single invocation or across multiple invocations), no guarantees can be made about any computation using this Spliterator.

Annotations

@Override

estimateSize back to summary

public long estimateSize()

Implements java.util.Spliterator.estimateSize.

Doc from java.util.Spliterator.estimateSize.

Returns an estimate of the number of elements that would be encountered by a forEachRemaining traversal, or returns Long#MAX_VALUE if infinite, unknown, or too expensive to compute.

If this Spliterator is SIZED and has not yet been partially traversed or split, or this Spliterator is SUBSIZED and has not yet been partially traversed, this estimate must be an accurate count of elements that would be encountered by a complete traversal. Otherwise, this estimate may be arbitrarily inaccurate, but must decrease as specified across invocations of trySplit.

Annotations

@Override

tryAdvance back to summary

public boolean tryAdvance(Consumer<? super TreeNode<T>> action)

Implements java.util.Spliterator.tryAdvance.

Doc from java.util.Spliterator.tryAdvance.

If a remaining element exists: performs the given action on it, returning true; else returns false. If this Spliterator is ORDERED the action is performed on the next element in encounter order. Exceptions thrown by the action are relayed to the caller.

Subsequent behavior of a spliterator is unspecified if the action throws an exception.

Annotations

@Override

trySplit back to summary

public Spliterator<TreeNode<T>> trySplit()

Implements java.util.Spliterator.trySplit.

Doc from java.util.Spliterator.trySplit.

If this spliterator can be partitioned, returns a Spliterator covering elements, that will, upon return from this method, not be covered by this Spliterator.

If this Spliterator is ORDERED, the returned Spliterator must cover a strict prefix of the elements.

Unless this Spliterator covers an infinite number of elements, repeated calls to trySplit() must eventually return null. Upon non-null return:

the value reported for estimateSize() before splitting, must, after splitting, be greater than or equal to estimateSize() for this and the returned Spliterator; and
if this Spliterator is SUBSIZED, then estimateSize() for this spliterator before splitting must be equal to the sum of estimateSize() for this and the returned Spliterator after splitting.

This method may return null for any reason, including emptiness, inability to split after traversal has commenced, data structure constraints, and efficiency considerations.

Annotations

@Override

public Class TreeNode<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TreeNode.TreeNodeSpliterator<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail