Package arc.scene.ui.layout

Class Table

java.lang.Object

arc.scene.Element

arc.scene.Group

arc.scene.ui.layout.WidgetGroup

arc.scene.ui.layout.Table

All Implemented Interfaces:

Cullable

Direct Known Subclasses:

Button, ChatFragment, ConsoleFragment, CoreItemsDisplay, Dialog, ItemDisplay, ItemsDisplay, LCanvas, LCanvas.StatementElem, LiquidDisplay, MapObjectivesCanvas.ObjectiveTilemap.ObjectiveTile, Minimap, SettingsMenuDialog.SettingsTable, WaveGraph

public class Table
extends WidgetGroup

A group that sizes and positions children using table constraints. By default, touchable is Touchable.childrenOnly.

The preferred and minimum sizes are that of the children when laid out in columns and rows.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Table.DrawRect

Field Summary

Fields inherited from class arc.scene.Group

children, cullingArea, transform

Fields inherited from class arc.scene.Element

color, cullable, fillParent, height, name, originX, originY, parent, parentAlpha, rotation, scaleX, scaleY, touchable, touchablility, translation, userObject, visibility, visible, width, x, y

Constructor Summary

Constructors

Constructor	Description
Table()
Table(Cons<Table> cons)
Table(Drawable background)
Table(Drawable background, Cons<Table> cons)

Method Summary

Modifier and Type	Method	Description
Cell	add()	Adds a cell without an element.
void	add(Element... elements)
Cell<Label>	add(CharSequence text)	Adds a new cell with a label.
Cell<Label>	add(CharSequence text, float scl)	Adds a new cell with a label.
Cell<Label>	add(CharSequence text, Color color)	Adds a new cell with a label.
Cell<Label>	add(CharSequence text, Color color, float scl)
Cell<Label>	add(CharSequence text, Label.LabelStyle labelStyle)	Adds a new cell with a label.
Cell<Label>	add(CharSequence text, Label.LabelStyle labelStyle, float scl)	Adds a new cell with a label.
<T extends Element> Cell<T>	add(T element)	Adds a new cell to the table with the specified element.
Table	align(int align)	Alignment of the logical table within the table actor.
Cell<TextArea>	area(String text, Cons<String> listener)
Cell<TextArea>	area(String text, TextField.TextFieldStyle style, Cons<String> listener)
Table	background(Drawable background)
Table	bottom()	Adds Align.bottom and clears Align.top for the alignment of the logical table within the table actor.
Cell<Button>	button(Cons<Button> cons, Button.ButtonStyle style, Runnable listener)
Cell<Button>	button(Cons<Button> cons, Runnable listener)
Cell<ImageButton>	button(Drawable icon, float isize, Runnable listener)
Cell<ImageButton>	button(Drawable icon, ImageButton.ImageButtonStyle style, float isize, Runnable listener)
Cell<ImageButton>	button(Drawable icon, ImageButton.ImageButtonStyle style, Runnable listener)
Cell<ImageButton>	button(Drawable icon, Runnable listener)
Cell<TextButton>	button(String text, Drawable image, float imagesize, Runnable clicked)
Cell<TextButton>	button(String text, Drawable image, TextButton.TextButtonStyle style, float imagesize, Runnable clicked)
Cell<TextButton>	button(String text, Drawable image, TextButton.TextButtonStyle style, Runnable clicked)
Cell<TextButton>	button(String text, Drawable image, Runnable clicked)
Cell<TextButton>	button(String text, TextButton.TextButtonStyle style, Runnable listener)
Cell<TextButton>	button(String text, Runnable listener)
Cell<TextButton>	buttonCenter(String text, Drawable image, float imagesize, Runnable clicked)
Cell<TextButton>	buttonCenter(String text, Drawable image, TextButton.TextButtonStyle style, float imagesize, Runnable clicked)
Cell<TextButton>	buttonCenter(String text, Drawable image, Runnable clicked)
Cell<TextButton>	buttonRow(String text, Drawable image, Runnable clicked)
Table	center()	Sets the alignment of the logical table within the table actor to Align.center.
Cell<CheckBox>	check(String text, boolean checked, Boolc listener)
Cell<CheckBox>	check(String text, float imagesize, boolean checked, Boolc listener)
Cell<CheckBox>	check(String text, Boolc listener)
void	clearChildren()	Removes all actors and cells from the table.
Cell<Collapser>	collapser(Cons<Table> cons, boolean animate, Boolp shown)
Cell<Collapser>	collapser(Cons<Table> cons, Boolp shown)
Cell<Collapser>	collapser(Table table, boolean animate, Boolp shown)
Cell<Collapser>	collapser(Table table, Boolp shown)
Cell	defaults()	The cell values that will be used as the defaults for all cells.
void	draw()	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(float x, float y)	Called to draw the background, before clipping is applied (if enabled).
Cell<TextField>	field(String text, Cons<String> listener)
Cell<TextField>	field(String text, TextField.TextFieldFilter filter, Cons<String> listener)
Cell<TextField>	field(String text, TextField.TextFieldStyle style, Cons<String> listener)
Table	fill()	Adds and fills a new table within this one.
int	getAlign()
Drawable	getBackground()
<T extends Element> Cell	getCell(T actor)	Returns the cell for the specified actor in this table, or null.
Seq<Cell>	getCells()	Returns the cells for this table.
boolean	getClip()
int	getColumns()
float	getColumnWidth(int columnIndex)	Returns the width of the specified column.
float	getMarginBottom()
float	getMarginLeft()
float	getMarginRight()
float	getMarginTop()
float	getMinHeight()
float	getMinWidth()
float	getPrefHeight()
float	getPrefWidth()
int	getRow(float y)	Returns the row index for the y coordinate, or -1 if there are no cells.
float	getRowHeight(int rowIndex)	Returns the height of the specified row.
int	getRows()
Element	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.
Cell<Image>	image()
Cell<Image>	image(Prov<TextureRegion> reg)
Cell<Image>	image(TextureRegion region)
Cell<Image>	image(Drawable name)
Cell<Image>	image(Drawable name, Color color)
Cell<Image>	imageDraw(Prov<Drawable> reg)
void	invalidate()	Invalidates this actor's layout, causing Element.layout() to happen the next time Element.validate() is called.
Cell<Label>	label(Prov<CharSequence> text)
Cell<Label>	labelWrap(Prov<CharSequence> text)
Cell<Label>	labelWrap(String text)
void	layout()	Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls Element.invalidate() on any each child whose width or height has changed, and calls Element.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	margin(float pad)	Sets the marginTop, marginLeft, marginBottom, and marginRight around the table to the specified value.
Table	margin(float top, float left, float bottom, float right)
Table	marginBottom(float padBottom)	Padding at the bottom edge of the table.
Table	marginLeft(float padLeft)	Padding at the left edge of the table.
Table	marginRight(float padRight)	Padding at the right edge of the table.
Table	marginTop(float padTop)	Padding at the top edge of the table.
Cell<ScrollPane>	pane(Cons<Table> consumer)
Cell<ScrollPane>	pane(Element element)
Cell<ScrollPane>	pane(ScrollPane.ScrollPaneStyle style, Cons<Table> consumer)
Cell<ScrollPane>	pane(ScrollPane.ScrollPaneStyle style, Element element)
Cell<?>	rect(Table.DrawRect draw)
boolean	removeChild(Element element)	Removes an actor from this group and unfocuses it.
boolean	removeChild(Element element, boolean unfocus)	Removes an actor from this group.
void	reset()	Removes all actors and cells from the table (same as clearChildren()) 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.
Table	row()	Indicates that subsequent cells should be added to a new row and returns this table.
void	setBackground(Drawable background)
void	setClip(boolean enabled)	Causes the contents to be clipped if they exceed the table element's bounds.
void	setRound(boolean round)	If true (the default), positions and sizes are rounded to integers.
Cell<Slider>	slider(float min, float max, float step, float defvalue, boolean onUp, Floatc listener)
Cell<Slider>	slider(float min, float max, float step, float defvalue, Floatc listener)
Cell<Slider>	slider(float min, float max, float step, Floatc listener)
Cell<Stack>	stack(Element... elements)	Adds a new cell to the table with the specified elements in a Stack.
Cell<Table>	table()
Cell<Table>	table(Cons<Table> cons)
Cell<Table>	table(Drawable background)
Cell<Table>	table(Drawable background, int align, Cons<Table> cons)
Cell<Table>	table(Drawable background, Cons<Table> cons)
Table	top()	Adds Align.top and clears Align.bottom for the alignment of the logical table within the table actor.

Methods inherited from class arc.scene.ui.layout.WidgetGroup

childrenChanged, invalidateHierarchy, needsLayout, pack, setFillParent, setLayoutEnabled, sizeChanged, validate

Methods inherited from class arc.scene.Group

act, addChild, addChildAfter, addChildAt, addChildBefore, applyTransform, clear, computeTransform, drawChildren, fill, fill, fill, find, find, findVisible, forEach, getChildren, getCullingArea, hasChildren, isTransform, localToDescendantCoordinates, resetTransform, setCullingArea, setScene, setTransform, swapActor, swapActor, toString

Methods inherited from class arc.scene.Element

actions, addAction, addCaptureListener, addListener, change, changed, clearActions, clearListeners, clicked, clicked, clicked, clicked, clipBegin, clipBegin, clipEnd, dragged, exited, fire, fireClick, getActions, getCaptureListeners, getHeight, getListeners, getMaxHeight, getMaxWidth, getRight, getRotation, getScene, getTop, getWidth, getX, getY, getZIndex, hasActions, hasKeyboard, hasMouse, hasParent, hasScroll, hovered, isAscendantOf, isDescendantOf, isDescendantOf, isTouchable, keepInStage, keyDown, keyDown, localToAscendantCoordinates, localToParentCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, released, remove, removeAction, removeCaptureListener, removeListener, requestKeyboard, requestScroll, rotateBy, rotationChanged, scaleBy, scaleBy, screenToLocalCoordinates, scrolled, setBounds, setColor, setColor, setHeight, setOrigin, setOrigin, setPosition, setPosition, setRotation, setRotationOrigin, setScale, setScale, setSize, setSize, setTranslation, setWidth, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, tapped, toBack, toFront, touchable, update, updateVisibility, visible

Methods inherited from class java.lang.Object

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

Constructor Details

Table

public Table()

Table

public Table(Drawable background)

Table

public Table(Drawable background,
 Cons<Table> cons)

Table

public Table(Cons<Table> cons)

Method Details

fill

public Table fill()

Adds and fills a new table within this one.

draw

public void draw()

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

drawBackground

protected void drawBackground(float x,
 float y)

Called to draw the background, before clipping is applied (if enabled). Default implementation draws the background drawable.

background

public Table background(Drawable background)

See Also:

• setBackground(Drawable)

getBackground

public Drawable getBackground()

setBackground

public void setBackground(Drawable background)

Parameters:

background - May be null to clear the background.

hit

public Element hit(float x,
 float y,
 boolean touchable)

Description copied from class: Element

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

getClip

public boolean getClip()

setClip

public void setClip(boolean enabled)

Causes the contents to be clipped if they exceed the table element's bounds. Enabling clipping will set Group.setTransform(boolean) to true.

invalidate

public void invalidate()

Description copied from class: Element

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

Overrides:

invalidate in class WidgetGroup

add

public <T extends Element> Cell<T> add(T element)

Adds a new cell to the table with the specified element.

add

public void add(Element... elements)

collapser

public Cell<Collapser> collapser(Cons<Table> cons,
 Boolp shown)

collapser

public Cell<Collapser> collapser(Table table,
 Boolp shown)

collapser

public Cell<Collapser> collapser(Cons<Table> cons,
 boolean animate,
 Boolp shown)

collapser

public Cell<Collapser> collapser(Table table,
 boolean animate,
 Boolp shown)

table

public Cell<Table> table()

table

public Cell<Table> table(Drawable background)

table

public Cell<Table> table(Cons<Table> cons)

table

public Cell<Table> table(Drawable background,
 Cons<Table> cons)

table

public Cell<Table> table(Drawable background,
 int align,
 Cons<Table> cons)

label

public Cell<Label> label(Prov<CharSequence> text)

labelWrap

public Cell<Label> labelWrap(Prov<CharSequence> text)

labelWrap

public Cell<Label> labelWrap(String text)

pane

public Cell<ScrollPane> pane(Cons<Table> consumer)

pane

public Cell<ScrollPane> pane(ScrollPane.ScrollPaneStyle style,
 Cons<Table> consumer)

pane

public Cell<ScrollPane> pane(ScrollPane.ScrollPaneStyle style,
 Element element)

pane

public Cell<ScrollPane> pane(Element element)

add

public Cell<Label> add(CharSequence text)

Adds a new cell with a label.

add

public Cell<Label> add(CharSequence text,
 float scl)

Adds a new cell with a label.

add

public Cell<Label> add(CharSequence text,
 Label.LabelStyle labelStyle,
 float scl)

Adds a new cell with a label.

add

public Cell<Label> add(CharSequence text,
 Color color,
 float scl)

add

public Cell<Label> add(CharSequence text,
 Label.LabelStyle labelStyle)

Adds a new cell with a label.

add

public Cell<Label> add(CharSequence text,
 Color color)

Adds a new cell with a label.

add

public Cell add()

Adds a cell without an element.

stack

public Cell<Stack> stack(Element... elements)

Adds a new cell to the table with the specified elements in a Stack.

Parameters:

elements - May be null to add a stack without any elements.

image

public Cell<Image> image(Prov<TextureRegion> reg)

imageDraw

public Cell<Image> imageDraw(Prov<Drawable> reg)

image

public Cell<Image> image()

image

public Cell<Image> image(Drawable name)

image

public Cell<Image> image(Drawable name,
 Color color)

image

public Cell<Image> image(TextureRegion region)

check

public Cell<CheckBox> check(String text,
 Boolc listener)

check

public Cell<CheckBox> check(String text,
 boolean checked,
 Boolc listener)

check

public Cell<CheckBox> check(String text,
 float imagesize,
 boolean checked,
 Boolc listener)

button

public Cell<Button> button(Cons<Button> cons,
 Runnable listener)

button

public Cell<Button> button(Cons<Button> cons,
 Button.ButtonStyle style,
 Runnable listener)

button

public Cell<TextButton> button(String text,
 Runnable listener)

button

public Cell<TextButton> button(String text,
 TextButton.TextButtonStyle style,
 Runnable listener)

button

public Cell<ImageButton> button(Drawable icon,
 Runnable listener)

button

public Cell<ImageButton> button(Drawable icon,
 float isize,
 Runnable listener)

button

public Cell<ImageButton> button(Drawable icon,
 ImageButton.ImageButtonStyle style,
 float isize,
 Runnable listener)

button

public Cell<ImageButton> button(Drawable icon,
 ImageButton.ImageButtonStyle style,
 Runnable listener)

field

public Cell<TextField> field(String text,
 Cons<String> listener)

area

public Cell<TextArea> area(String text,
 Cons<String> listener)

area

public Cell<TextArea> area(String text,
 TextField.TextFieldStyle style,
 Cons<String> listener)

field

public Cell<TextField> field(String text,
 TextField.TextFieldFilter filter,
 Cons<String> listener)

field

public Cell<TextField> field(String text,
 TextField.TextFieldStyle style,
 Cons<String> listener)

rect

public Cell<?> rect(Table.DrawRect draw)

buttonRow

public Cell<TextButton> buttonRow(String text,
 Drawable image,
 Runnable clicked)

button

public Cell<TextButton> button(String text,
 Drawable image,
 Runnable clicked)

button

public Cell<TextButton> button(String text,
 Drawable image,
 float imagesize,
 Runnable clicked)

button

public Cell<TextButton> button(String text,
 Drawable image,
 TextButton.TextButtonStyle style,
 float imagesize,
 Runnable clicked)

button

public Cell<TextButton> button(String text,
 Drawable image,
 TextButton.TextButtonStyle style,
 Runnable clicked)

buttonCenter

public Cell<TextButton> buttonCenter(String text,
 Drawable image,
 float imagesize,
 Runnable clicked)

buttonCenter

public Cell<TextButton> buttonCenter(String text,
 Drawable image,
 Runnable clicked)

buttonCenter

public Cell<TextButton> buttonCenter(String text,
 Drawable image,
 TextButton.TextButtonStyle style,
 float imagesize,
 Runnable clicked)

slider

public Cell<Slider> slider(float min,
 float max,
 float step,
 Floatc listener)

slider

public Cell<Slider> slider(float min,
 float max,
 float step,
 float defvalue,
 Floatc listener)

slider

public Cell<Slider> slider(float min,
 float max,
 float step,
 float defvalue,
 boolean onUp,
 Floatc listener)

removeChild

public boolean removeChild(Element element)

Description copied from class: Group

Removes an actor from this group and unfocuses it. Calls Group.removeChild(Element, boolean) with true.

Overrides:

removeChild in class Group

removeChild

public boolean removeChild(Element element,
 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:

removeChild in class Group

unfocus - If true, Scene.unfocus(Element) 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 clearChildren()) and additionally resets all table properties and cell, column, and row defaults.

row

public Table row()

Indicates that subsequent cells should be added to a new row and returns this table.

getCell

public <T extends Element> Cell getCell(T actor)

Returns the cell for the specified actor in this table, or null.

getCells

public Seq<Cell> getCells()

Returns the cells for this table.

getPrefWidth

public float getPrefWidth()

Overrides:

getPrefWidth in class WidgetGroup

getPrefHeight

public float getPrefHeight()

Overrides:

getPrefHeight in class WidgetGroup

getMinWidth

public float getMinWidth()

Overrides:

getMinWidth in class WidgetGroup

getMinHeight

public float getMinHeight()

Overrides:

getMinHeight in class WidgetGroup

defaults

public Cell defaults()

The cell values that will be used as the defaults for all cells.

margin

public Table margin(float pad)

Sets the marginTop, marginLeft, marginBottom, and marginRight around the table to the specified value.

margin

public Table margin(float top,
 float left,
 float bottom,
 float right)

marginTop

public Table marginTop(float padTop)

Padding at the top edge of the table.

marginLeft

public Table marginLeft(float padLeft)

Padding at the left edge of the table.

marginBottom

public Table marginBottom(float padBottom)

Padding at the bottom edge of the table.

marginRight

public Table marginRight(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.

getMarginTop

public float getMarginTop()

getMarginLeft

public float getMarginLeft()

getMarginBottom

public float getMarginBottom()

getMarginRight

public float getMarginRight()

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.

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()

getRowHeight

public float getRowHeight(int rowIndex)

Returns the height of the specified row.

getColumnWidth

public float getColumnWidth(int columnIndex)

Returns the width of the specified column.

layout

public void layout()

Description copied from class: Element

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

Overrides:

layout in class WidgetGroup