Table (libGDX Core 1.6.1 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.Table

All Implemented Interfaces:

Cullable, Layout

Direct Known Subclasses:

Button, Window
```
public class Table
extends WidgetGroup
```
A group that sizes and positions children using table constraints. By default, Actor.getTouchable() is Touchable.childrenOnly.
The preferred and minimum sizes are that of the children when laid out in columns and rows.

Author:

Nathan Sweet

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Table.Debug

static class Table.DebugRect

Nested Classes
Modifier and Type	Class and Description
`static class`	`Table.Debug`
`static class`	`Table.DebugRect`

Field Summary

Fields
Modifier and Type	Field and Description
`static Value`	`backgroundBottom` Value that is the bottom padding of the table's background.
`static Value`	`backgroundLeft` Value that is the left padding of the table's background.
`static Value`	`backgroundRight` Value that is the right padding of the table's background.
`static Value`	`backgroundTop` Value that is the top padding of the table's background.
`static Color`	`debugActorColor`
`static Color`	`debugCellColor`
`static Color`	`debugTableColor`

Constructor Summary

Constructors
Constructor and Description

Table()

Table(Skin skin)
Creates a table with a skin, which enables the add(String) and add(String, String) methods to be used.

Constructors
Constructor and Description
`Table()`
`Table(Skin skin)` Creates a table with a skin, which enables the `add(String)` and `add(String, String)` methods to be used.

Method Summary

Methods
Modifier and Type	Method and Description
`Cell`	`add()` Adds a cell without an actor.
`void`	`add(Actor... actors)`
`Cell<Label>`	`add(String text)` Adds a new cell with a label.
`Cell<Label>`	`add(String text, String labelStyleName)` Adds a new cell with a label.
`Cell<Label>`	`add(String text, String fontName, Color color)` Adds a new cell with a label.
`Cell<Label>`	`add(String text, String fontName, String colorName)` Adds a new cell with a label.
`<T extends Actor> Cell<T>`	`add(T actor)` Adds a new cell to the table with the specified actor.
`Table`	`align(int align)` Alignment of the logical table within the table actor.
`Table`	`background(Drawable background)`
`Table`	`background(String drawableName)`
`Table`	`bottom()` Adds `Align.bottom` and clears `Align.top` for the alignment of the logical table within the table actor.
`Table`	`center()` Sets the alignment of the logical table within the table actor to `Align.center`.
`void`	`clearChildren()` Removes all actors and cells from the table.
`Cell`	`columnDefaults(int column)` Gets the cell values that will be used as the defaults for all cells in the specified column.
`Table`	`debug()` Calls `Actor.setDebug(boolean)` with `true`.
`Table`	`debug(Table.Debug debug)` Turns debug lines on or off.
`Table`	`debugActor()` Turns on actor debug lines.
`Table`	`debugAll()` Calls `Group.setDebug(boolean, boolean)` with `true, true`.
`Table`	`debugCell()` Turns on cell debug lines.
`Table`	`debugTable()` Turns on table debug lines.
`Cell`	`defaults()` The cell values that will be used as the defaults for all cells.
`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.
`void`	`drawDebug(ShapeRenderer shapes)` Draws this actor's debug lines if `Actor.getDebug()` is true and, regardless of `Actor.getDebug()`, calls `Actor.drawDebug(ShapeRenderer)` on each child.
`int`	`getAlign()`
`Drawable`	`getBackground()`
`<T extends Actor> Cell<T>`	`getCell(T actor)` Returns the cell for the specified actor in this table, or null.
`Array<Cell>`	`getCells()` Returns the cells for this table.
`boolean`	`getClip()`
`int`	`getColumns()`
`float`	`getMinHeight()`
`float`	`getMinWidth()`
`float`	`getPadBottom()`
`Value`	`getPadBottomValue()`
`float`	`getPadLeft()`
`Value`	`getPadLeftValue()`
`float`	`getPadRight()`
`Value`	`getPadRightValue()`
`float`	`getPadTop()`
`Value`	`getPadTopValue()`
`float`	`getPadX()` Returns `getPadLeft()` plus `getPadRight()`.
`float`	`getPadY()` Returns `getPadTop()` plus `getPadBottom()`.
`float`	`getPrefHeight()`
`float`	`getPrefWidth()`
`int`	`getRow(float y)` Returns the row index for the y coordinate, or -1 if there are no cells.
`int`	`getRows()`
`Skin`	`getSkin()`
`Table.Debug`	`getTableDebug()`
`Actor`	`hit(float x, float y, boolean touchable)` Returns the deepest actor that contains the specified point and is `touchable` and `visible`, or null if no actor was hit.
`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()` any each child whose width or height has changed, and calls `Layout.validate()` on each child.
`Table`	`left()` Adds `Align.left` and clears `Align.right` for the alignment of the logical table within the table actor.
`Table`	`pad(float pad)` Sets the padTop, padLeft, padBottom, and padRight around the table to the specified value.
`Table`	`pad(float top, float left, float bottom, float right)`
`Table`	`pad(Value pad)` Sets the padTop, padLeft, padBottom, and padRight around the table to the specified value.
`Table`	`pad(Value top, Value left, Value bottom, Value right)`
`Table`	`padBottom(float padBottom)` Padding at the bottom edge of the table.
`Table`	`padBottom(Value padBottom)` Padding at the bottom edge of the table.
`Table`	`padLeft(float padLeft)` Padding at the left edge of the table.
`Table`	`padLeft(Value padLeft)` Padding at the left edge of the table.
`Table`	`padRight(float padRight)` Padding at the right edge of the table.
`Table`	`padRight(Value padRight)` Padding at the right edge of the table.
`Table`	`padTop(float padTop)` Padding at the top edge of the table.
`Table`	`padTop(Value padTop)` Padding at the top edge of the table.
`boolean`	`removeActor(Actor actor)` Calls `Group.removeActor(Actor, boolean)` with true.
`boolean`	`removeActor(Actor actor, boolean unfocus)` Removes an actor from this group.
`void`	`reset()` Removes all actors and cells from the table (same as `Group.clear()`) and additionally resets all table properties and cell, column, and row defaults.
`Table`	`right()` Adds `Align.right` and clears `Align.left` for the alignment of the logical table within the table actor.
`Cell`	`row()` Indicates that subsequent cells should be added to a new row and returns the cell values that will be used as the defaults for all cells in the new row.
`void`	`setBackground(Drawable background)`
`void`	`setBackground(String drawableName)` Sets the background drawable from the skin and adjusts the table's padding to match the background.
`void`	`setClip(boolean enabled)` Causes the contents to be clipped if they exceed the table actor's bounds.
`void`	`setDebug(boolean enabled)` If true, `Actor.drawDebug(ShapeRenderer)` will be called for this actor.
`void`	`setRound(boolean round)` If true (the default), positions and sizes are rounded to integers.
`void`	`setSkin(Skin skin)`
`Cell<Stack>`	`stack(Actor... actors)` Adds a new cell to the table with the specified actors in a `Stack`.
`Table`	`top()` Adds `Align.top` and clears `Align.bottom` for the alignment of the logical table within the table actor.

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup
getMaxHeight, getMaxWidth, invalidateHierarchy, needsLayout, pack, setFillParent, setLayoutEnabled, validate

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Group
act, addActor, addActorAfter, addActorAt, addActorBefore, clear, findActor, getChildren, getCullingArea, hasChildren, isTransform, localToDescendantCoordinates, setCullingArea, setDebug, setTransform, swapActor, swapActor, toString

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor
addAction, addCaptureListener, addListener, clearActions, clearListeners, clipBegin, clipBegin, clipEnd, fire, getActions, getCaptureListeners, getColor, getDebug, getHeight, getListeners, getName, getOriginX, getOriginY, getParent, getRight, getRotation, getScaleX, getScaleY, getStage, getTop, getTouchable, getUserObject, getWidth, getX, getX, getY, getY, getZIndex, hasParent, isAscendantOf, isDescendantOf, isTouchable, isVisible, localToAscendantCoordinates, localToParentCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, remove, removeAction, removeCaptureListener, removeListener, rotateBy, scaleBy, scaleBy, screenToLocalCoordinates, setBounds, setColor, setColor, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, 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
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - debugTableColor
```
public static Color debugTableColor
```
  - debugCellColor
```
public static Color debugCellColor
```
  - debugActorColor
```
public static Color debugActorColor
```
  - backgroundTop
```
public static Value backgroundTop
```
    Value that is the top padding of the table's background.
  - backgroundLeft
```
public static Value backgroundLeft
```
    Value that is the left padding of the table's background.
  - backgroundBottom
```
public static Value backgroundBottom
```
    Value that is the bottom padding of the table's background.
  - backgroundRight
```
public static Value backgroundRight
```
    Value that is the right padding of the table's background.
- Constructor Detail
  - Table
```
public Table()
```
  - Table
```
public Table(Skin skin)
```
    Creates a table with a skin, which enables the add(String) and add(String, String) methods to be used.
- Method Detail
  - 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.
  - setBackground
```
public void setBackground(String drawableName)
```
    Sets the background drawable from the skin and adjusts the table's padding to match the background. This may only be called if Table(Skin) or setSkin(Skin) was used.
    
    See Also:
    setBackground(Drawable)
  - setBackground
```
public void setBackground(Drawable background)
```
    Parameters:
    background - May be null to clear the background.
  - background
```
public Table background(Drawable background)
```
    See Also:
    setBackground(Drawable)
  - background
```
public Table background(String drawableName)
```
    See Also:
    setBackground(String)
  - getBackground
```
public Drawable getBackground()
```
  - hit
```
public Actor hit(float x,
        float y,
        boolean touchable)
```
    Description copied from class: Actor
    
    Returns the deepest actor that contains the specified point and is touchable and visible, or null if no actor was hit. The point is specified in the actor's local coordinate system (0,0 is the bottom left of the actor and width,height is the upper right).
    This method is used to delegate touchDown, mouse, and enter/exit events. If this method returns null, those events will not occur on this Actor.
    The default implementation returns this actor if the point is within this actor's bounds.
    
    Overrides:
    
    hit in class Group
    
    touchable - If true, the hit detection will respect the touchability.
    See Also:
    Touchable
  - setClip
```
public void setClip(boolean enabled)
```
    Causes the contents to be clipped if they exceed the table actor's bounds. Enabling clipping will set Group.setTransform(boolean) to true.
  - getClip
```
public boolean getClip()
```
  - 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
  - add
```
public <T extends Actor> Cell<T> add(T actor)
```
    Adds a new cell to the table with the specified actor.
  - add
```
public void add(Actor... actors)
```
  - add
```
public Cell<Label> add(String text)
```
    Adds a new cell with a label. This may only be called if Table(Skin) or setSkin(Skin) was used.
  - add
```
public Cell<Label> add(String text,
              String labelStyleName)
```
    Adds a new cell with a label. This may only be called if Table(Skin) or setSkin(Skin) was used.
  - add
```
public Cell<Label> add(String text,
              String fontName,
              Color color)
```
    Adds a new cell with a label. This may only be called if Table(Skin) or setSkin(Skin) was used.
  - add
```
public Cell<Label> add(String text,
              String fontName,
              String colorName)
```
    Adds a new cell with a label. This may only be called if Table(Skin) or setSkin(Skin) was used.
  - add
```
public Cell add()
```
    Adds a cell without an actor.
  - stack
```
public Cell<Stack> stack(Actor... actors)
```
    Adds a new cell to the table with the specified actors in a Stack.
    
    Parameters:
    actors - May be null to add a stack without any actors.
  - removeActor
```
public boolean removeActor(Actor actor)
```
    Description copied from class: Group
    
    Calls Group.removeActor(Actor, boolean) with true.
    
    Overrides:
    
    removeActor in class Group
  - removeActor
```
public boolean removeActor(Actor actor,
                  boolean unfocus)
```
    Description copied from class: Group
    
    Removes an actor from this group. If the actor will not be used again and has actions, they should be cleared so the actions will be returned to their pool, if any. This is not done automatically.
    
    Overrides:
    
    removeActor in class Group
    
    unfocus - If true, Stage.unfocus(Actor) is called.
    
    Returns:
    true if the actor was removed from this group.
  - clearChildren
```
public void clearChildren()
```
    Removes all actors and cells from the table.
    
    Overrides:
    
    clearChildren in class Group
  - reset
```
public void reset()
```
    Removes all actors and cells from the table (same as Group.clear()) and additionally resets all table properties and cell, column, and row defaults.
  - row
```
public Cell row()
```
    Indicates that subsequent cells should be added to a new row and returns the cell values that will be used as the defaults for all cells in the new row.
  - columnDefaults
```
public Cell columnDefaults(int column)
```
    Gets the cell values that will be used as the defaults for all cells in the specified column. Columns are indexed starting at 0.
  - getCell
```
public <T extends Actor> Cell<T> getCell(T actor)
```
    Returns the cell for the specified actor in this table, or null.
  - getCells
```
public Array<Cell> getCells()
```
    Returns the cells for this table.
  - 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
  - getMinWidth
```
public float getMinWidth()
```
    Specified by:
    
    getMinWidth in interface Layout
    
    Overrides:
    
    getMinWidth in class WidgetGroup
  - getMinHeight
```
public float getMinHeight()
```
    Specified by:
    
    getMinHeight in interface Layout
    
    Overrides:
    
    getMinHeight in class WidgetGroup
  - defaults
```
public Cell defaults()
```
    The cell values that will be used as the defaults for all cells.
  - pad
```
public Table pad(Value pad)
```
    Sets the padTop, padLeft, padBottom, and padRight around the table to the specified value.
  - pad
```
public Table pad(Value top,
        Value left,
        Value bottom,
        Value right)
```
  - padTop
```
public Table padTop(Value padTop)
```
    Padding at the top edge of the table.
  - padLeft
```
public Table padLeft(Value padLeft)
```
    Padding at the left edge of the table.
  - padBottom
```
public Table padBottom(Value padBottom)
```
    Padding at the bottom edge of the table.
  - padRight
```
public Table padRight(Value padRight)
```
    Padding at the right edge of the table.
  - pad
```
public Table pad(float pad)
```
    Sets the padTop, padLeft, padBottom, and padRight around the table to the specified value.
  - pad
```
public Table pad(float top,
        float left,
        float bottom,
        float right)
```
  - padTop
```
public Table padTop(float padTop)
```
    Padding at the top edge of the table.
  - padLeft
```
public Table padLeft(float padLeft)
```
    Padding at the left edge of the table.
  - padBottom
```
public Table padBottom(float padBottom)
```
    Padding at the bottom edge of the table.
  - padRight
```
public Table padRight(float padRight)
```
    Padding at the right edge of the table.
  - align
```
public Table align(int align)
```
    Alignment of the logical table within the table actor. Set to Align.center, Align.top, Align.bottom , Align.left, Align.right, or any combination of those.
  - center
```
public Table center()
```
    Sets the alignment of the logical table within the table actor to Align.center. This clears any other alignment.
  - top
```
public Table top()
```
    Adds Align.top and clears Align.bottom for the alignment of the logical table within the table actor.
  - left
```
public Table left()
```
    Adds Align.left and clears Align.right for the alignment of the logical table within the table actor.
  - bottom
```
public Table bottom()
```
    Adds Align.bottom and clears Align.top for the alignment of the logical table within the table actor.
  - right
```
public Table right()
```
    Adds Align.right and clears Align.left for the alignment of the logical table within the table actor.
  - setDebug
```
public void setDebug(boolean enabled)
```
    Description copied from class: Actor
    
    If true, Actor.drawDebug(ShapeRenderer) will be called for this actor.
    
    Overrides:
    
    setDebug in class Actor
  - debug
```
public Table debug()
```
    Description copied from class: Actor
    
    Calls Actor.setDebug(boolean) with true.
    
    Overrides:
    
    debug in class Actor
  - debugAll
```
public Table debugAll()
```
    Description copied from class: Group
    
    Calls Group.setDebug(boolean, boolean) with true, true.
    
    Overrides:
    
    debugAll in class Group
  - debugTable
```
public Table debugTable()
```
    Turns on table debug lines.
  - debugCell
```
public Table debugCell()
```
    Turns on cell debug lines.
  - debugActor
```
public Table debugActor()
```
    Turns on actor debug lines.
  - debug
```
public Table debug(Table.Debug debug)
```
    Turns debug lines on or off.
  - getTableDebug
```
public Table.Debug getTableDebug()
```
  - getPadTopValue
```
public Value getPadTopValue()
```
  - getPadTop
```
public float getPadTop()
```
  - getPadLeftValue
```
public Value getPadLeftValue()
```
  - getPadLeft
```
public float getPadLeft()
```
  - getPadBottomValue
```
public Value getPadBottomValue()
```
  - getPadBottom
```
public float getPadBottom()
```
  - getPadRightValue
```
public Value getPadRightValue()
```
  - getPadRight
```
public float getPadRight()
```
  - getPadX
```
public float getPadX()
```
    Returns getPadLeft() plus getPadRight().
  - getPadY
```
public float getPadY()
```
    Returns getPadTop() plus getPadBottom().
  - getAlign
```
public int getAlign()
```
  - getRow
```
public int getRow(float y)
```
    Returns the row index for the y coordinate, or -1 if there are no cells.
    
    Parameters:
    y - The y coordinate, where 0 is the top of the table.
  - setSkin
```
public void setSkin(Skin skin)
```
  - setRound
```
public void setRound(boolean round)
```
    If true (the default), positions and sizes are rounded to integers.
  - getRows
```
public int getRows()
```
  - getColumns
```
public int getColumns()
```
  - 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() 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
  - drawDebug
```
public void drawDebug(ShapeRenderer shapes)
```
    Description copied from class: Group
    
    Draws this actor's debug lines if Actor.getDebug() is true and, regardless of Actor.getDebug(), calls Actor.drawDebug(ShapeRenderer) on each child.
    
    Overrides:
    
    drawDebug in class Group
  - getSkin
```
public Skin getSkin()
```
    Returns:
    The skin that was passed to this table in its constructor, or null if none was given.

Class Table

Nested Class Summary

Field 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

Field Detail

debugTableColor

debugCellColor

debugActorColor

backgroundTop

backgroundLeft

backgroundBottom

backgroundRight

Constructor Detail

Table

Table

Method Detail

draw

setBackground

setBackground

background

background

getBackground

hit

setClip

getClip

invalidate

add

add

add

add

add

add

add

stack

removeActor

removeActor

clearChildren

reset

row

columnDefaults

getCell

getCells

getPrefWidth

getPrefHeight

getMinWidth

getMinHeight

defaults

pad

pad

padTop

padLeft

padBottom

padRight

pad

pad

padTop

padLeft

padBottom

padRight

align

center

top

left

bottom

right

setDebug

debug

debugAll

debugTable

debugCell

debugActor

debug

getTableDebug

getPadTopValue

getPadTop