Tree (libgdx API)

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

All Implemented Interfaces:

Cullable, Layout
```
public class Tree
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.

Author:

Nathan Sweet

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Tree.Node

static class Tree.TreeStyle
The style for a Tree.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Tree.Node`
`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)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Tree.Node node)`
`void`	`clearChildren()` 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.
`void`	`expandAll()`
`void`	`findExpandedObjects(Array objects)`
`Tree.Node`	`findNode(java.lang.Object object)` Returns the node with the specified object, or null.
`ClickListener`	`getClickListener()` Returns the click listener the tree uses for clicking on nodes and the over node.
`float`	`getIndentSpacing()` Returns the amount of horizontal space for indentation level.
`Tree.Node`	`getNodeAt(float y)`
`Array<Tree.Node>`	`getNodes()`
`Tree.Node`	`getOverNode()`
`java.lang.Object`	`getOverObject()`
`float`	`getPrefHeight()`
`float`	`getPrefWidth()`
`Array<Tree.Node>`	`getRootNodes()`
`Selection<Tree.Node>`	`getSelection()`
`Tree.TreeStyle`	`getStyle()`
`float`	`getYSpacing()`
`void`	`insert(int index, Tree.Node 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(Tree.Node node)`
`void`	`restoreExpandedObjects(Array objects)`
`void`	`setIconSpacing(float left, float right)` Sets the amount of horizontal space between the node actors and icons.
`void`	`setOverNode(Tree.Node overNode)`
`void`	`setPadding(float padding)` 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.

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, computeTransform, debugAll, drawChildren, drawDebug, drawDebugChildren, findActor, getChildren, getCullingArea, hasChildren, hit, isTransform, localToDescendantCoordinates, removeActor, removeActor, resetTransform, resetTransform, setCullingArea, setDebug, setStage, setTransform, swapActor, swapActor, toString

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor
addAction, addCaptureListener, addListener, 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, hasParent, isAscendantOf, isDescendantOf, isTouchable, isVisible, localToAscendantCoordinates, localToParentCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, positionChanged, remove, removeAction, removeCaptureListener, removeListener, rotateBy, rotationChanged, scaleBy, scaleBy, 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, 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(Tree.Node node)
```
  - insert
```
public void insert(int index,
                   Tree.Node node)
```
  - remove
```
public void remove(Tree.Node node)
```
  - clearChildren
```
public void clearChildren()
```
    Removes all tree nodes.
    
    Overrides:
    
    clearChildren in class Group
  - getNodes
```
public Array<Tree.Node> getNodes()
```
  - 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 - Should be multiplied with the actor's alpha, allowing a 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.
  - getNodeAt
```
public Tree.Node getNodeAt(float y)
```
    Returns:
    
    May be null.
  - getSelection
```
public Selection<Tree.Node> getSelection()
```
  - getStyle
```
public Tree.TreeStyle getStyle()
```
  - getRootNodes
```
public Array<Tree.Node> getRootNodes()
```
  - getOverNode
```
public Tree.Node getOverNode()
```
    Returns:
    
    May be null.
  - getOverObject
```
public java.lang.Object getOverObject()
```
    Returns:
    
    May be null.
  - setOverNode
```
public void setOverNode(Tree.Node 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.
  - 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 between the node actors and icons.
  - 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
  - findExpandedObjects
```
public void findExpandedObjects(Array objects)
```
  - restoreExpandedObjects
```
public void restoreExpandedObjects(Array objects)
```
  - findNode
```
public Tree.Node findNode(java.lang.Object object)
```
    Returns the node with the specified object, 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.

Class Tree

Nested Class Summary

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

Tree

Tree

Tree

Method Detail

setStyle

add

insert

remove

clearChildren

getNodes

invalidate

layout

draw

drawBackground

getNodeAt

getSelection

getStyle

getRootNodes

getOverNode

getOverObject

setOverNode

setPadding

getIndentSpacing

setYSpacing

getYSpacing

setIconSpacing

getPrefWidth

getPrefHeight

findExpandedObjects

restoreExpandedObjects

findNode

collapseAll

expandAll

getClickListener