com.kotcrab.vis.ui.building.utilities

Class Padding

java.lang.Object

com.kotcrab.vis.ui.building.utilities.Padding

public class Padding
extends java.lang.Object

A simple helper class that holds informations about padding on each side of an object. Static methods can be used to quickly set padding or spacing of a cell or a table using this class' object.

When padding is set for a table, its cells will be separated from its borders by the given value. When padding is set for a window, additionally to the table's padding effect, top padding will be a draggable area, allowing to move the window.

When padding is set for a cell, it will be separated from other cells and table's border by the given value. When spacing is set for a cell, it will be separated by at least as many pixels from other cells as specified. If spacing or padding with the same values is used on every cell in a table, padding will provide twice as big distances between cells, since spacings can overlap.

Field Summary

Fields

Modifier and Type	Field and Description
static Padding	PAD_0 Common padding sizes.
static Padding	PAD_2 Common padding sizes.
static Padding	PAD_4 Common padding sizes.
static Padding	PAD_8 Common padding sizes.

Constructor Summary

Constructors

Constructor and Description
Padding(float padding)
Padding(float horizontal, float vertical)
Padding(float top, float left, float bottom, float right)

Method Summary

Modifier and Type	Method and Description
Padding	add(Padding padding)
com.badlogic.gdx.scenes.scene2d.ui.Cell<?>	applyPadding(com.badlogic.gdx.scenes.scene2d.ui.Cell<?> cell) Allows to set Cell's padding with the Padding object, which has be done externally, as it's not part of the standard libGDX API.
com.badlogic.gdx.scenes.scene2d.ui.Table	applyPadding(com.badlogic.gdx.scenes.scene2d.ui.Table table) Allows to set Table's padding with the Padding object, which has be done externally, as it's not part of the standard libGDX API.
com.badlogic.gdx.scenes.scene2d.ui.Cell<?>	applySpacing(com.badlogic.gdx.scenes.scene2d.ui.Cell<?> cell) Allows to set Cell's spacing with the Padding object, which has be done externally, as it's not part of the standard libGDX API.
float	getBottom()
float	getLeft()
float	getRight()
float	getTop()
static Padding	of(float padding)
static Padding	of(float horizontal, float vertical)
static Padding	of(float top, float left, float bottom, float right)
Padding	reverse()
static com.badlogic.gdx.scenes.scene2d.ui.Cell<?>	setPadding(Padding padding, com.badlogic.gdx.scenes.scene2d.ui.Cell<?> cell) Allows to set Cell's padding with the Padding object, which has be done externally, as it's not part of the standard libGDX API.
static com.badlogic.gdx.scenes.scene2d.ui.Table	setPadding(Padding padding, com.badlogic.gdx.scenes.scene2d.ui.Table table) Allows to set Table's padding with the Padding object, which has be done externally, as it's not part of the standard libGDX API.
static com.badlogic.gdx.scenes.scene2d.ui.Cell<?>	setSpacing(Padding spacing, com.badlogic.gdx.scenes.scene2d.ui.Cell<?> cell) Allows to set Cell's spacing with the Padding object, which has be done externally, as it's not part of the standard libGDX API.
Padding	subtract(Padding padding)

Methods inherited from class java.lang.Object

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

Field Detail

PAD_0

public static final Padding PAD_0

Common padding sizes.

PAD_2

public static final Padding PAD_2

Common padding sizes.

PAD_4

public static final Padding PAD_4

Common padding sizes.

PAD_8

public static final Padding PAD_8

Common padding sizes.

Constructor Detail

Padding

public Padding(float padding)

Parameters:

padding - will be set as padding for all directions.

Padding

public Padding(float horizontal,
               float vertical)

Parameters:

horizontal - will be set as left and right padding.

vertical - will be set as top and bottom padding.

Padding

public Padding(float top,
               float left,
               float bottom,
               float right)

Parameters:

top - top padding value.

left - left padding value.

bottom - bottom padding value.

right - right padding value.

Method Detail

of

public static Padding of(float padding)

Parameters:

padding - will be set as padding for all directions.

of

public static Padding of(float horizontal,
                         float vertical)

Parameters:

horizontal - will be set as left and right padding.

vertical - will be set as top and bottom padding.

of

public static Padding of(float top,
                         float left,
                         float bottom,
                         float right)

Parameters:

top - top padding value.

left - left padding value.

bottom - bottom padding value.

right - right padding value.

getTop

public float getTop()

Returns:

top padding value.

getLeft

public float getLeft()

Returns:

left padding value.

getBottom

public float getBottom()

Returns:

bottom padding value.

getRight

public float getRight()

Returns:

right padding value.

add

public Padding add(Padding padding)

Parameters:

padding - will be added to the given padding.

Returns:

new Padding object with summed pad values.

subtract

public Padding subtract(Padding padding)

Parameters:

padding - will be subtracted from the given padding.

Returns:

new Padding object with subtracted pad values.

reverse

public Padding reverse()

Returns:

new Padding object with reversed pad values.

applyPadding

public com.badlogic.gdx.scenes.scene2d.ui.Table applyPadding(com.badlogic.gdx.scenes.scene2d.ui.Table table)

Allows to set Table's padding with the Padding object, which has be done externally, as it's not part of the standard libGDX API.

Parameters:

table - will have the padding set according to the this object's data.

Returns:

the given table for chaining.

applyPadding

public com.badlogic.gdx.scenes.scene2d.ui.Cell<?> applyPadding(com.badlogic.gdx.scenes.scene2d.ui.Cell<?> cell)

Allows to set Cell's padding with the Padding object, which has be done externally, as it's not part of the standard libGDX API.

Parameters:

cell - will have the padding set according to the this object's data.

Returns:

the given cell for chaining.

applySpacing

public com.badlogic.gdx.scenes.scene2d.ui.Cell<?> applySpacing(com.badlogic.gdx.scenes.scene2d.ui.Cell<?> cell)

Allows to set Cell's spacing with the Padding object, which has be done externally, as it's not part of the standard libGDX API. Padding holds 4 floats for each direction, so it's compatible with both padding and spacing settings without any additional changes.

Parameters:

cell - will have the padding set according to the this object's data.

Returns:

the given cell for chaining.

setPadding

public static com.badlogic.gdx.scenes.scene2d.ui.Table setPadding(Padding padding,
                                                                  com.badlogic.gdx.scenes.scene2d.ui.Table table)

Allows to set Table's padding with the Padding object, which has be done externally, as it's not part of the standard libGDX API.

Parameters:

padding - contains data of padding sizes.

table - will have the padding set according to the given data.

Returns:

the given table for chaining.

setPadding

public static com.badlogic.gdx.scenes.scene2d.ui.Cell<?> setPadding(Padding padding,
                                                                    com.badlogic.gdx.scenes.scene2d.ui.Cell<?> cell)

Allows to set Cell's padding with the Padding object, which has be done externally, as it's not part of the standard libGDX API.

Parameters:

padding - contains data of padding sizes.

cell - will have the padding set according to the given data.

Returns:

the given cell for chaining.

setSpacing

public static com.badlogic.gdx.scenes.scene2d.ui.Cell<?> setSpacing(Padding spacing,
                                                                    com.badlogic.gdx.scenes.scene2d.ui.Cell<?> cell)

Allows to set Cell's spacing with the Padding object, which has be done externally, as it's not part of the standard libGDX API. Padding holds 4 floats for each direction, so it's compatible with both padding and spacing settings without any additional changes.

Parameters:

spacing - contains data of spacing sizes.

cell - will have the padding set according to the given data.

Returns:

the given cell for chaining.