Modifier and Type	Class and Description
public abstract static class	Tree.Node< The type for the node's parent and child nodes. N extends Tree.Node, The type for the node's value. V, The type for the node's actor. A extends Actor> A `Tree` node which has an actor and value.
public static class	Tree.TreeStyle The style for a `Tree`.

Modifier and Type	Field and Description
private ClickListener	clickListener
private N	foundNode
pack-priv float	iconSpacingLeft
pack-priv float	iconSpacingRight
pack-priv float	indentSpacing
private N	overNode
pack-priv float	paddingLeft
pack-priv float	paddingRight
private float	prefHeight
private float	prefWidth
pack-priv N	rangeStart
pack-priv final Array<N>	rootNodes
pack-priv final Selection<N>	selection
private boolean	sizeInvalid
pack-priv Tree.TreeStyle	style
private static final Vector2	tmp Hides com.badlogic.gdx.scenes.scene2d.Group.tmp.
pack-priv float	ySpacing

Access	Constructor and Description
public	Tree(Skin skin)
public	Tree(Skin skin, String styleName)
public	Tree(Tree.TreeStyle style)

Method Summary

Modifier and Type	Method and Description
public void	add(N node)
public void	clearChildren(boolean unfocus) Overrides com.badlogic.gdx.scenes.scene2d.Group.clearChildren. Removes all tree nodes.
public void	collapseAll()
pack-priv static void	collapseAll(Array<? extends Tree.Node<N extends Tree.Node, V, A extends Actor>> nodes)
private void	computeSize()
private void	computeSize(Array<N> nodes, float indent, float plusMinusWidth)
public void	draw(Batch batch, float parentAlpha) Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.draw. If this method is overridden, the super method or `validate()` should be called to ensure the widget group is laid out.
protected void	drawBackground(Batch batch, float parentAlpha) Called to draw the background.
protected void	drawExpandIcon(N node, Drawable expandIcon, Batch batch, float x, float y)
protected void	drawIcon(N node, Drawable icon, Batch batch, float x, float y)
protected float	Returns: The Y position of the last visible actor for the nodes. drawIcons(Batch batch, float r, float g, float b, float a, N null for the root nodes. parent, Array<N> nodes, float indent, float plusMinusWidth) Draws selection, icons, and expand icons.
protected void	drawOver(N node, Drawable over, Batch batch, float x, float y, float width, float height)
protected void	drawSelection(N node, Drawable selection, Batch batch, float x, float y, float width, float height)
public void	expandAll()
pack-priv static void	expandAll(Array<? extends Tree.Node<N extends Tree.Node, V, A extends Actor>> nodes)
public void	findExpandedValues(Array<V> values)
pack-priv static boolean	findExpandedValues(Array<? extends Tree.Node<N extends Tree.Node, V, A extends Actor>> nodes, Array<T> values)
public N	findNode(V value) Returns the node with the specified value, or null.
pack-priv static Tree.Node<N extends Tree.Node, V, A extends Actor>	findNode(Array<? extends Tree.Node<N extends Tree.Node, V, A extends Actor>> nodes, Object value)
public ClickListener	getClickListener() Returns the click listener the tree uses for clicking on nodes and the over node.
protected Drawable	getExpandIcon(N node, float The X coordinate of the over node's icon. iconX) Returns the drawable for the expand icon.
public float	getIndentSpacing() Returns the amount of horizontal space for indentation level.
public N	getNodeAt(float y) Returns: May be null.
private float	getNodeAt(Array<N> nodes, float y, float rowY)
public Array<N>	getNodes() Deprecated Use `getRootNodes()`.
public N	getOverNode() Returns: May be null.
public V	getOverValue() Returns: May be null.
public float	getPrefHeight() Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.getPrefHeight. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.
public float	getPrefWidth() Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.getPrefWidth. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefWidth.
public Array<N>	getRootNodes() If the order of the root nodes is changed, `updateRootNodes()` must be called to ensure the nodes' actors are in the correct order.
public N	getSelectedNode() Returns the first selected node, or null.
public V	getSelectedValue() Returns the first selected value, or null.
public Selection<N>	getSelection()
public Tree.TreeStyle	getStyle() Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.getStyle. Get the current style of the actor
public float	getYSpacing()
private void	initialize()
public void	insert(int index, N node)
public void	invalidate() Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.invalidate. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.invalidate. Invalidates this actor's layout, causing `layout()` to happen the next time `validate()` is called.
public void	layout() Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.layout. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.layout. Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls `invalidate()` on any each child whose width or height has changed, and calls `validate()` on each child.
private float	layout(Array<N> nodes, float indent, float y, float plusMinusWidth)
private float	plusMinusWidth()
public void	remove(N node)
public void	restoreExpandedValues(Array<V> values)
pack-priv void	selectNodes(Array<N> nodes, float low, float high)
public void	setIconSpacing(float left, float right) Sets the amount of horizontal space left and right of the node's icon.
public void	setIndentSpacing(float indentSpacing)
public void	setOverNode(N May be null. overNode)
public void	setPadding(float padding) Sets the amount of horizontal space between the nodes and the left/right edges of the tree.
public void	setPadding(float left, float right) Sets the amount of horizontal space between the nodes and the left/right edges of the tree.
public void	setStyle(Tree.TreeStyle style) Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle. Set the current style of the actor
public void	setYSpacing(float ySpacing) Sets the amount of vertical space between nodes.
public void	updateRootNodes() Updates the order of the actors in the tree for all root nodes and all child nodes.

Inherited from com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup:: childrenChanged getMaxHeight getMaxWidth getMinHeight getMinWidth hit invalidateHierarchy needsLayout pack setFillParent setLayoutEnabled sizeChanged validate

Field Detail

clickListener	back to summary
private ClickListener clickListener

foundNode	back to summary
private N foundNode

iconSpacingLeft	back to summary
pack-priv float iconSpacingLeft

iconSpacingRight	back to summary
pack-priv float iconSpacingRight

indentSpacing	back to summary
pack-priv float indentSpacing

overNode	back to summary
private N overNode

paddingLeft	back to summary
pack-priv float paddingLeft

paddingRight	back to summary
pack-priv float paddingRight

prefHeight	back to summary
private float prefHeight

prefWidth	back to summary
private float prefWidth

rangeStart	back to summary
pack-priv N rangeStart

rootNodes	back to summary
pack-priv final Array<N> rootNodes

selection	back to summary
pack-priv final Selection<N> selection

sizeInvalid	back to summary
private boolean sizeInvalid

style	back to summary
pack-priv Tree.TreeStyle style

tmp	back to summary
private static final Vector2 tmp Hides com.badlogic.gdx.scenes.scene2d.Group.tmp.

ySpacing	back to summary
pack-priv float ySpacing

Constructor Detail

Tree	back to summary
public Tree(Skin skin)

Tree	back to summary
public Tree(Skin skin, String styleName)

Tree	back to summary
public Tree(Tree.TreeStyle style)

Method Detail

add	back to summary
public void add(N node)

clearChildren	back to summary
public void clearChildren(boolean unfocus) Overrides com.badlogic.gdx.scenes.scene2d.Group.clearChildren. Removes all tree nodes.

clearChildren

back to summary

public void clearChildren(boolean unfocus)

Overrides com.badlogic.gdx.scenes.scene2d.Group.clearChildren.

Removes all tree nodes.

collapseAll	back to summary
public void collapseAll()

collapseAll	back to summary
pack-priv static void collapseAll(Array<? extends Tree.Node<N extends Tree.Node, V, A extends Actor>> nodes)

computeSize	back to summary
private void computeSize()

computeSize	back to summary
private void computeSize(Array<N> nodes, float indent, float plusMinusWidth)

draw back to summary

draw	back to summary
public void draw(Batch batch, float parentAlpha) Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.draw. Doc from com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.draw. If this method is overridden, the super method or `validate()` should be called to ensure the widget group is laid out.

public void draw(Batch batch, float parentAlpha)

Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.draw.

Doc from com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.draw.

If this method is overridden, the super method or validate() should be called to ensure the widget group is laid out.

drawBackground	back to summary
protected void drawBackground(Batch batch, float parentAlpha) Called to draw the background. Default implementation draws the style background drawable.

drawExpandIcon	back to summary
protected void drawExpandIcon(N node, Drawable expandIcon, Batch batch, float x, float y)

drawIcon	back to summary
protected void drawIcon(N node, Drawable icon, Batch batch, float x, float y)

drawIcons	back to summary
protected float drawIcons(Batch batch, float r, float g, float b, float a, N parent, Array<N> nodes, float indent, float plusMinusWidth) Draws selection, icons, and expand icons. Parameters parent:N null for the root nodes. Returns:float The Y position of the last visible actor for the nodes.

drawIcons

back to summary

protected float drawIcons(Batch batch, float r, float g, float b, float a, N parent, Array<N> nodes, float indent, float plusMinusWidth)

Draws selection, icons, and expand icons.

Parameters

parent:N: null for the root nodes.

Returns:float

The Y position of the last visible actor for the nodes.

drawOver	back to summary
protected void drawOver(N node, Drawable over, Batch batch, float x, float y, float width, float height)

drawSelection	back to summary
protected void drawSelection(N node, Drawable selection, Batch batch, float x, float y, float width, float height)

expandAll	back to summary
public void expandAll()

expandAll	back to summary
pack-priv static void expandAll(Array<? extends Tree.Node<N extends Tree.Node, V, A extends Actor>> nodes)

findExpandedValues	back to summary
public void findExpandedValues(Array<V> values)

findExpandedValues	back to summary
pack-priv static boolean findExpandedValues(Array<? extends Tree.Node<N extends Tree.Node, V, A extends Actor>> nodes, Array<T> values)

findNode	back to summary
public N findNode(V value) Returns the node with the specified value, or null. Annotations @Null

findNode

back to summary

public N findNode(V value)

Returns the node with the specified value, or null.

Annotations

@Null

findNode	back to summary
pack-priv static Tree.Node<N extends Tree.Node, V, A extends Actor> findNode(Array<? extends Tree.Node<N extends Tree.Node, V, A extends Actor>> nodes, Object value) Annotations @Null

getClickListener	back to summary
public ClickListener getClickListener() Returns the click listener the tree uses for clicking on nodes and the over node.

getExpandIcon back to summary

getExpandIcon	back to summary
protected Drawable getExpandIcon(N node, float iconX) Returns the drawable for the expand icon. The default implementation returns `TreeStyle#plusOver` or `TreeStyle#minusOver` on the desktop if the node is the `over node`, the mouse is left of `iconX`, and clicking would expand the node. Parameters iconX:float The X coordinate of the over node's icon.

protected Drawable getExpandIcon(N node, float iconX)

Returns the drawable for the expand icon. The default implementation returns TreeStyle#plusOver or TreeStyle#minusOver on the desktop if the node is the over node, the mouse is left of iconX, and clicking would expand the node.

Parameters

iconX:float: The X coordinate of the over node's icon.

getIndentSpacing	back to summary
public float getIndentSpacing() Returns the amount of horizontal space for indentation level.

getNodeAt	back to summary
public N getNodeAt(float y) Returns:N May be null. Annotations @Null

getNodeAt	back to summary
private float getNodeAt(Array<N> nodes, float y, float rowY)

getNodes	back to summary
public Array<N> getNodes() Deprecated Use `getRootNodes()`. Annotations @Deprecated

getOverNode	back to summary
public N getOverNode() Returns:N May be null. Annotations @Null

getOverValue	back to summary
public V getOverValue() Returns:V May be null. Annotations @Null

getPrefHeight

back to summary

public float getPrefHeight()

Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.getPrefHeight.

Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.

getPrefWidth

back to summary

public float getPrefWidth()

Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.getPrefWidth.

Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefWidth.

getRootNodes	back to summary
public Array<N> getRootNodes() If the order of the root nodes is changed, `updateRootNodes()` must be called to ensure the nodes' actors are in the correct order.

getSelectedNode

back to summary

public N getSelectedNode()

Returns the first selected node, or null.

Annotations

@Null

getSelectedValue

back to summary

public V getSelectedValue()

Returns the first selected value, or null.

Annotations

@Null

getSelection	back to summary
public Selection<N> getSelection()

getStyle

back to summary

public Tree.TreeStyle getStyle()

Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.getStyle.

Doc from com.badlogic.gdx.scenes.scene2d.ui.Styleable.getStyle.

Get the current style of the actor

getYSpacing	back to summary
public float getYSpacing()

initialize	back to summary
private void initialize()

insert	back to summary
public void insert(int index, N node)

invalidate back to summary

public void invalidate()

Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.invalidate.

Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.invalidate.

Doc from com.badlogic.gdx.scenes.scene2d.utils.Layout.invalidate.

Invalidates this actor's layout, causing layout() to happen the next time validate() is called. This method should be called when state changes in the actor that requires a layout but does not change the minimum, preferred, maximum, or actual size of the actor (meaning it does not affect the parent actor's layout).

layout back to summary

public void layout()

Overrides com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup.layout.

Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.layout.

Doc from com.badlogic.gdx.scenes.scene2d.utils.Layout.layout.

Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls invalidate() on any each child whose width or height has changed, and calls validate() on each child. This method should almost never be called directly, instead validate() should be used.

layout

back to summary

private float layout(Array<N> nodes, float indent, float y, float plusMinusWidth)

plusMinusWidth	back to summary
private float plusMinusWidth()

remove	back to summary
public void remove(N node)

restoreExpandedValues	back to summary
public void restoreExpandedValues(Array<V> values)

selectNodes	back to summary
pack-priv void selectNodes(Array<N> nodes, float low, float high)

setIconSpacing	back to summary
public void setIconSpacing(float left, float right) Sets the amount of horizontal space left and right of the node's icon. If a node has no icon, the left spacing is used between the plus/minus drawable and the node's actor.

setIndentSpacing	back to summary
public void setIndentSpacing(float indentSpacing)

setOverNode	back to summary
public void setOverNode(N overNode) Parameters overNode:N May be null.

setPadding	back to summary
public void setPadding(float padding) Sets the amount of horizontal space between the nodes and the left/right edges of the tree.

setPadding	back to summary
public void setPadding(float left, float right) Sets the amount of horizontal space between the nodes and the left/right edges of the tree.

setStyle

back to summary

public void setStyle(Tree.TreeStyle style)

Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle.

Doc from com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle.

Set the current style of the actor

setYSpacing	back to summary
public void setYSpacing(float ySpacing) Sets the amount of vertical space between nodes.

updateRootNodes back to summary

public void updateRootNodes()

Updates the order of the actors in the tree for all root nodes and all child nodes. This is useful after changing the order of getRootNodes().

See Also: Node#updateChildren()

com.badlogic.gdx.scenes.scene2d.ui back to summary

public abstract Class Tree.Node<N extends Tree.Node, V, A extends Actor>

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.scenes.scene2d.ui.Tree.Node

Type Parameters

<N>: The type for the node's parent and child nodes.
<V>: The type for the node's value.
<A>: The type for the node's actor.

A Tree node which has an actor and value.

A subclass can be used so the generic type parameters don't need to be specified repeatedly.

Author: Nathan Sweet

Field Summary

Modifier and Type	Field and Description
pack-priv A	actor
pack-priv final Array<N>	children
pack-priv boolean	expanded
pack-priv float	height
pack-priv Drawable	icon
pack-priv N	parent
pack-priv boolean	selectable
pack-priv V	value

Constructor Summary

Access	Constructor and Description
public	Node(A actor)
public	Node() Creates a node without an actor.

Method Summary

Modifier and Type	Method and Description
public void	add(N node)
public void	addAll(Array<N> nodes)
protected int	Returns: The number of node actors added to the tree. addToTree(Tree<N, V> tree, int actorIndex) Called to add the actor to the tree when the node's parent is expanded.
public void	clearChildren() Removes all children from this node.
public void	collapseAll() Collapses all nodes under and including this node.
pack-priv int	countActors()
public void	expandAll() Expands all nodes under and including this node.
public void	expandTo() Expands all parent nodes of this node.
public void	findExpandedValues(Array<V> values)
public N	findNode(V value) Returns this node or the child node with the specified value, or null.
public A	getActor()
public Array<N>	getChildren() If the children order is changed, `updateChildren()` must be called to ensure the node's actors are in the correct order.
public float	getHeight() Returns the height of the node as calculated for layout.
public Drawable	getIcon()
public int	getLevel()
public N	getParent() Returns: May be null.
public Tree<N, V>	getTree() Returns the tree this node's actor is currently in, or null.
public V	getValue()
public boolean	hasChildren()
public void	insert(int childIndex, N node)
public boolean	isAscendantOf(N node) Returns true if the specified node is this node or an ascendant of this node.
public boolean	isDescendantOf(N node) Returns true if the specified node is this node or an descendant of this node.
public boolean	isExpanded()
public boolean	isSelectable()
public void	remove() Remove this node from its parent.
public void	remove(N node) Remove the specified child node from this node.
protected void	removeFromTree(Tree<N, V> tree, int actorIndex) Called to remove the actor from the tree, eg when the node is removed or the node's parent is collapsed.
public void	restoreExpandedValues(Array<V> values)
public void	setActor(A newActor)
public void	setExpanded(boolean expanded)
public void	setIcon(Drawable icon) Sets an icon that will be drawn to the left of the actor.
public void	setSelectable(boolean selectable)
public void	setValue(V value) Sets an application specific value for this node.
public void	updateChildren() Updates the order of the actors in the tree for this node and all child nodes.

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

Field Detail

actor	back to summary
pack-priv A actor

children	back to summary
pack-priv final Array<N> children

expanded	back to summary
pack-priv boolean expanded

height	back to summary
pack-priv float height

icon	back to summary
pack-priv Drawable icon

parent	back to summary
pack-priv N parent

selectable	back to summary
pack-priv boolean selectable

value	back to summary
pack-priv V value

Constructor Detail

Node	back to summary
public Node(A actor)

Node	back to summary
public Node() Creates a node without an actor. An actor must be set using `setActor(Actor)` before this node can be used.

Method Detail

add	back to summary
public void add(N node)

addAll	back to summary
public void addAll(Array<N> nodes)

addToTree

back to summary

protected int addToTree(Tree<N, V> tree, int actorIndex)

Called to add the actor to the tree when the node's parent is expanded.

Returns:int: The number of node actors added to the tree.

clearChildren	back to summary
public void clearChildren() Removes all children from this node.

collapseAll	back to summary
public void collapseAll() Collapses all nodes under and including this node.

countActors	back to summary
pack-priv int countActors()

expandAll	back to summary
public void expandAll() Expands all nodes under and including this node.

expandTo	back to summary
public void expandTo() Expands all parent nodes of this node.

findExpandedValues	back to summary
public void findExpandedValues(Array<V> values)

findNode

back to summary

public N findNode(V value)

Returns this node or the child node with the specified value, or null.

Annotations

@Null

getActor	back to summary
public A getActor()

getChildren	back to summary
public Array<N> getChildren() If the children order is changed, `updateChildren()` must be called to ensure the node's actors are in the correct order. That is not necessary if this node is not in the tree or is not expanded, because then the child node's actors are not in the tree.

getHeight	back to summary
public float getHeight() Returns the height of the node as calculated for layout. A subclass may override and increase the returned height to create a blank space in the tree above the node, eg for a separator.

getIcon	back to summary
public Drawable getIcon() Annotations @Null

getLevel	back to summary
public int getLevel()

getParent	back to summary
public N getParent() Returns:N May be null. Annotations @Null

getTree

back to summary

public Tree<N, V> getTree()

Returns the tree this node's actor is currently in, or null. The actor is only in the tree when all of its parent nodes are expanded.

Annotations

@Null

getValue	back to summary
public V getValue() Annotations @Null

hasChildren	back to summary
public boolean hasChildren()

insert	back to summary
public void insert(int childIndex, N node)

isAscendantOf	back to summary
public boolean isAscendantOf(N node) Returns true if the specified node is this node or an ascendant of this node.

isDescendantOf	back to summary
public boolean isDescendantOf(N node) Returns true if the specified node is this node or an descendant of this node.

isExpanded	back to summary
public boolean isExpanded()

isSelectable	back to summary
public boolean isSelectable()

remove	back to summary
public void remove() Remove this node from its parent.

remove	back to summary
public void remove(N node) Remove the specified child node from this node. Does nothing if the node is not a child of this node.

removeFromTree	back to summary
protected void removeFromTree(Tree<N, V> tree, int actorIndex) Called to remove the actor from the tree, eg when the node is removed or the node's parent is collapsed.

restoreExpandedValues	back to summary
public void restoreExpandedValues(Array<V> values)

setActor	back to summary
public void setActor(A newActor)

setExpanded	back to summary
public void setExpanded(boolean expanded)

setIcon	back to summary
public void setIcon(Drawable icon) Sets an icon that will be drawn to the left of the actor.

setSelectable	back to summary
public void setSelectable(boolean selectable)

setValue	back to summary
public void setValue(V value) Sets an application specific value for this node.

updateChildren back to summary

public void updateChildren()

Updates the order of the actors in the tree for this node and all child nodes. This is useful after changing the order of getChildren().

See Also: Tree#updateRootNodes()

public Class Tree<N extends Tree.Node, V>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class Tree.Node<N extends Tree.Node, V, A extends Actor>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Tree.TreeStyle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Modifier and Type	Field and Description
public Drawable	background
public Drawable	minus
public Drawable	minusOver
public Drawable	over
public Drawable	plus
public Drawable	plusOver
public Drawable	selection

Access	Constructor and Description
public	TreeStyle()
public	TreeStyle(Drawable plus, Drawable minus, Drawable selection)
public	TreeStyle(Tree.TreeStyle style)