Package io.github.thecsdev.tcdcommons.api.client.gui.layout

Class UIHorizontalGridLayout

java.lang.Object

io.github.thecsdev.tcdcommons.api.client.gui.layout.UILayout

io.github.thecsdev.tcdcommons.api.client.gui.layout.UIHorizontalGridLayout

public class UIHorizontalGridLayout
extends UILayout

A UILayout that arranges a TParentElement's children in a horizontal grid-like order, where the children are placed next to one another, continuing on the next "line" once the current "line" runs out of space.

Field Summary

Fields

Modifier and Type	Field	Description
protected final HorizontalAlignment	hAlignment
protected final Point	margin
protected final VerticalAlignment	vAlignment

Fields inherited from class io.github.thecsdev.tcdcommons.api.client.gui.layout.UILayout

defaultPsp

Constructor Summary

Constructors

Constructor	Description
UIHorizontalGridLayout()
UIHorizontalGridLayout(HorizontalAlignment hAlignment)
UIHorizontalGridLayout(HorizontalAlignment hAlignment, VerticalAlignment vAlignment)
UIHorizontalGridLayout(VerticalAlignment vAlignment)

Method Summary

Modifier and Type	Method	Description
void	apply(TParentElement parent)	Applies this UILayout to a given TParentElement.
protected void	applyHAlignment(TParentElement parent)
protected void	applyVAlignment(TParentElement parent)
UIHorizontalGridLayout	setMargin(int x, int y)	Sets the margin that will be applied to a TParentElement's children as they get arranged into a grid.

Methods inherited from class io.github.thecsdev.tcdcommons.api.client.gui.layout.UILayout

getDefaultPSP, getElementScrollPadding, nextChildBottomY, nextChildBottomY, nextChildVerticalRect, nextChildVerticalRect, setDefaultPSP

Methods inherited from class java.lang.Object

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

Field Details

hAlignment

protected final HorizontalAlignment hAlignment

vAlignment

protected final VerticalAlignment vAlignment

margin

protected final Point margin

Constructor Details

UIHorizontalGridLayout

public UIHorizontalGridLayout()

UIHorizontalGridLayout

public UIHorizontalGridLayout(HorizontalAlignment hAlignment)

UIHorizontalGridLayout

public UIHorizontalGridLayout(VerticalAlignment vAlignment)

UIHorizontalGridLayout

public UIHorizontalGridLayout(HorizontalAlignment hAlignment,
 VerticalAlignment vAlignment)
                       throws NullPointerException

Throws:

NullPointerException

Method Details

setMargin

public UIHorizontalGridLayout setMargin(int x,
 int y)

Sets the margin that will be applied to a TParentElement's children as they get arranged into a grid. The margin is the gap left between children.

Parameters:

x - The horizontal margin.

y - The vertical margin.

Returns:

this

apply

public void apply(TParentElement parent)

Description copied from class: UILayout

Applies this UILayout to a given TParentElement.

Specified by:

apply in class UILayout

applyHAlignment

protected void applyHAlignment(TParentElement parent)

applyVAlignment

protected void applyVAlignment(TParentElement parent)