com.badlogic.gdx.scenes.scene2d.ui

Class Tree<N extends Tree.Node,V>

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Actor

com.badlogic.gdx.scenes.scene2d.Group

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

com.badlogic.gdx.scenes.scene2d.ui.Tree<N,V>

Type Parameters:

N - The type of nodes in the tree.

V - The type of values for each node.

All Implemented Interfaces:

Cullable, Layout

public class Tree<N extends Tree.Node,V>
extends WidgetGroup

A tree widget where each node has an icon, actor, and child nodes.

The preferred size of the tree is determined by the preferred size of the actors for the expanded nodes.

ChangeListener.ChangeEvent is fired when the selected node changes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tree.Node<N extends Tree.Node,V,A extends Actor> A Tree node which has an actor and value.
static class	Tree.TreeStyle The style for a Tree.

Constructor Summary

Constructors

Constructor and Description
Tree(Skin skin)
Tree(Skin skin, java.lang.String styleName)
Tree(Tree.TreeStyle style)

Method Summary

Modifier and Type	Method and Description
void	add(N node)
void	clearChildren(boolean unfocus) Removes all tree nodes.
void	collapseAll()
void	draw(Batch batch, float parentAlpha) If this method is overridden, the super method or WidgetGroup.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	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.
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)
void	expandAll()
void	findExpandedValues(Array<V> values)
N	findNode(V value) Returns the node with the specified value, or null.
ClickListener	getClickListener() Returns the click listener the tree uses for clicking on nodes and the over node.
protected Drawable	getExpandIcon(N node, float iconX) Returns the drawable for the expand icon.
float	getIndentSpacing() Returns the amount of horizontal space for indentation level.
N	getNodeAt(float y)
Array<N>	getNodes() Deprecated. Use getRootNodes().
N	getOverNode()
V	getOverValue()
float	getPrefHeight()
float	getPrefWidth()
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.
N	getSelectedNode() Returns the first selected node, or null.
V	getSelectedValue() Returns the first selected value, or null.
Selection<N>	getSelection()
Tree.TreeStyle	getStyle()
float	getYSpacing()
void	insert(int index, N node)
void	invalidate() Invalidates this actor's layout, causing Layout.layout() to happen the next time Layout.validate() is called.
void	layout() Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls Layout.invalidate() on any each child whose width or height has changed, and calls Layout.validate() on each child.
void	remove(N node)
void	restoreExpandedValues(Array<V> values)
void	setIconSpacing(float left, float right) Sets the amount of horizontal space left and right of the node's icon.
void	setIndentSpacing(float indentSpacing)
void	setOverNode(N overNode)
void	setPadding(float padding) Sets the amount of horizontal space between the nodes and the left/right edges of the tree.
void	setPadding(float left, float right) Sets the amount of horizontal space between the nodes and the left/right edges of the tree.
void	setStyle(Tree.TreeStyle style)
void	setYSpacing(float ySpacing) Sets the amount of vertical space between nodes.
void	updateRootNodes() Updates the order of the actors in the tree for all root nodes and all child nodes.

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup

childrenChanged, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, invalidateHierarchy, needsLayout, pack, setFillParent, setLayoutEnabled, sizeChanged, validate

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Group

act, addActor, addActorAfter, addActorAt, addActorBefore, applyTransform, applyTransform, clear, clear, clearChildren, computeTransform, debugAll, drawChildren, drawDebug, drawDebugChildren, findActor, getChild, getChildren, getCullingArea, hasChildren, hit, isTransform, localToDescendantCoordinates, removeActor, removeActor, removeActorAt, resetTransform, resetTransform, setCullingArea, setDebug, setStage, setTransform, swapActor, swapActor, toString

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor

addAction, addCaptureListener, addListener, ancestorsVisible, ascendantsVisible, clearActions, clearListeners, clipBegin, clipBegin, clipEnd, debug, drawDebugBounds, fire, firstAscendant, getActions, getCaptureListeners, getColor, getDebug, getHeight, getListeners, getName, getOriginX, getOriginY, getParent, getRight, getRotation, getScaleX, getScaleY, getStage, getTop, getTouchable, getUserObject, getWidth, getX, getX, getY, getY, getZIndex, hasActions, hasKeyboardFocus, hasParent, hasScrollFocus, isAscendantOf, isDescendantOf, isTouchable, isTouchFocusListener, isTouchFocusTarget, isVisible, localToActorCoordinates, localToAscendantCoordinates, localToParentCoordinates, localToScreenCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, positionChanged, remove, removeAction, removeCaptureListener, removeListener, rotateBy, rotationChanged, scaleBy, scaleBy, scaleChanged, screenToLocalCoordinates, setBounds, setColor, setColor, setDebug, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, setParent, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setSize, setTouchable, setUserObject, setVisible, setWidth, setX, setX, setY, setY, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, toBack, toFront

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Tree

public Tree(Skin skin)

Tree

public Tree(Skin skin,
            java.lang.String styleName)

Tree

public Tree(Tree.TreeStyle style)

Method Detail

setStyle

public void setStyle(Tree.TreeStyle style)

add

public void add(N node)

insert

public void insert(int index,
                   N node)

remove

public void remove(N node)

clearChildren

public void clearChildren(boolean unfocus)

Removes all tree nodes.

Overrides:

clearChildren in class Group

invalidate

public void invalidate()

Description copied from interface: Layout

Invalidates this actor's layout, causing Layout.layout() to happen the next time Layout.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).

Specified by:

invalidate in interface Layout

Overrides:

invalidate in class WidgetGroup

layout

public void layout()

Description copied from interface: Layout

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

Specified by:

layout in interface Layout

Overrides:

layout in class WidgetGroup

draw

public void draw(Batch batch,
                 float parentAlpha)

Description copied from class: WidgetGroup

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

Overrides:

draw in class WidgetGroup

parentAlpha - The parent alpha, to be multiplied with this actor's alpha, allowing the parent's alpha to affect all children.

drawBackground

protected void drawBackground(Batch batch,
                              float parentAlpha)

Called to draw the background. Default implementation draws the style background drawable.

drawIcons

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

Draws selection, icons, and expand icons.

Parameters:

parent - null for the root nodes.

Returns:

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

drawSelection

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

drawOver

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

drawExpandIcon

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

drawIcon

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

getExpandIcon

protected Drawable getExpandIcon(N node,
                                 float iconX)

Returns the drawable for the expand icon. The default implementation returns Tree.TreeStyle.plusOver or Tree.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 - The X coordinate of the over node's icon.

getNodeAt

@Null
public N getNodeAt(float y)

Returns:

May be null.

getSelection

public Selection<N> getSelection()

getSelectedNode

@Null
public N getSelectedNode()

Returns the first selected node, or null.

getSelectedValue

@Null
public V getSelectedValue()

Returns the first selected value, or null.

getStyle

public Tree.TreeStyle getStyle()

getRootNodes

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.

getNodes

@Deprecated
public Array<N> getNodes()

Deprecated. Use getRootNodes().

updateRootNodes

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:

Tree.Node.updateChildren()

getOverNode

@Null
public N getOverNode()

Returns:

May be null.

getOverValue

@Null
public V getOverValue()

Returns:

May be null.

setOverNode

public void setOverNode(@Null
                        N overNode)

Parameters:

overNode - May be null.

setPadding

public void setPadding(float padding)

Sets the amount of horizontal space between the nodes and the left/right edges of the tree.

setPadding

public void setPadding(float left,
                       float right)

Sets the amount of horizontal space between the nodes and the left/right edges of the tree.

setIndentSpacing

public void setIndentSpacing(float indentSpacing)

getIndentSpacing

public float getIndentSpacing()

Returns the amount of horizontal space for indentation level.

setYSpacing

public void setYSpacing(float ySpacing)

Sets the amount of vertical space between nodes.

getYSpacing

public float getYSpacing()

setIconSpacing

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.

getPrefWidth

public float getPrefWidth()

Specified by:

getPrefWidth in interface Layout

Overrides:

getPrefWidth in class WidgetGroup

getPrefHeight

public float getPrefHeight()

Specified by:

getPrefHeight in interface Layout

Overrides:

getPrefHeight in class WidgetGroup

findExpandedValues

public void findExpandedValues(Array<V> values)

restoreExpandedValues

public void restoreExpandedValues(Array<V> values)

findNode

@Null
public N findNode(V value)

Returns the node with the specified value, or null.

collapseAll

public void collapseAll()

expandAll

public void expandAll()

getClickListener

public ClickListener getClickListener()

Returns the click listener the tree uses for clicking on nodes and the over node.