Package io.github.cottonmc.cotton.gui.widget

Class WBox

java.lang.Object

io.github.cottonmc.cotton.gui.widget.WWidget

io.github.cottonmc.cotton.gui.widget.WPanel

io.github.cottonmc.cotton.gui.widget.WPanelWithInsets

io.github.cottonmc.cotton.gui.widget.WBox

public class WBox
extends WPanelWithInsets

Similar to the BoxLayout in Swing, this widget represents a list of widgets along an axis.

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected Axis	axis	The axis that the widgets are laid out on.
protected HorizontalAlignment	horizontalAlignment	The horizontal alignment for this box's children.
protected int	spacing	The spacing between widgets.
protected VerticalAlignment	verticalAlignment	The vertical alignment for this box's children.

Fields inherited from class io.github.cottonmc.cotton.gui.widget.WPanelWithInsets

insets

Fields inherited from class io.github.cottonmc.cotton.gui.widget.WPanel

children

Fields inherited from class io.github.cottonmc.cotton.gui.widget.WWidget

height, host, parent, width, x, y

Constructor Summary

Constructors

Constructor	Description
WBox(Axis axis)	Constructs a box.

Method Summary

Modifier and Type	Method	Description
void	add(WWidget widget)	Adds a widget to this box.
void	add(WWidget widget, int width, int height)	Adds a widget to this box.
Axis	getAxis()	Gets the axis of this box.
HorizontalAlignment	getHorizontalAlignment()	Gets the horizontal alignment of this box.
int	getSpacing()	Gets the spacing between widgets.
VerticalAlignment	getVerticalAlignment()	Gets the vertical alignment of this box.
void	layout()	Uses this Panel's layout rules to reposition and resize components to fit nicely in the panel.
WBox	setAxis(Axis axis)	Sets the axis of this box.
WBox	setHorizontalAlignment(HorizontalAlignment alignment)	Sets the horizontal alignment of this box.
WBox	setInsets(Insets insets)	Sets the layout insets of this panel.
WBox	setSpacing(int spacing)	Sets the spacing between widgets in this box.
WBox	setVerticalAlignment(VerticalAlignment alignment)	Sets the vertical alignment of this box.

Methods inherited from class io.github.cottonmc.cotton.gui.widget.WPanelWithInsets

expandToFit, getInsets

Methods inherited from class io.github.cottonmc.cotton.gui.widget.WPanel

addPainters, canResize, expandToFit, getBackgroundPainter, hit, onHidden, onShown, paint, remove, setBackgroundPainter, setHost, streamChildren, tick, toString, validate

Methods inherited from class io.github.cottonmc.cotton.gui.widget.WWidget

addNarrations, addTooltip, canFocus, canHover, getAbsoluteX, getAbsoluteY, getFocusModel, getHeight, getHost, getParent, getWidth, getX, getY, hoveredProperty, isActivationKey, isFocused, isHovered, isNarratable, isWithinBounds, onCharTyped, onClick, onFocusGained, onFocusLost, onKeyPressed, onKeyReleased, onMouseDown, onMouseDrag, onMouseMove, onMouseScroll, onMouseUp, releaseFocus, renderTooltip, requestFocus, setHovered, setLocation, setParent, setSize, shouldRenderInDarkMode

Methods inherited from class java.lang.Object

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

Field Details

spacing

protected int spacing

The spacing between widgets.

axis

protected Axis axis

The axis that the widgets are laid out on.

horizontalAlignment

protected HorizontalAlignment horizontalAlignment

The horizontal alignment for this box's children.

Since:

2.1.0

verticalAlignment

protected VerticalAlignment verticalAlignment

The vertical alignment for this box's children.

Since:

2.1.0

Constructor Details

WBox

public WBox(Axis axis)

Constructs a box.

Parameters:

axis - the box axis

Throws:

NullPointerException - if the axis is null

Method Details

add

public void add(WWidget widget,
 int width,
 int height)

Adds a widget to this box. If the widget is resizeable, resizes it to the provided dimensions.

Parameters:

widget - the widget

width - the new width of the widget

height - the new height of the widget

add

public void add(WWidget widget)

Adds a widget to this box. If the widget is resizeable, resizes it to 18x18.

Parameters:

widget - the widget

layout

public void layout()

Description copied from class: WPanel

Uses this Panel's layout rules to reposition and resize components to fit nicely in the panel.

Overrides:

layout in class WPanel

getSpacing

public int getSpacing()

Gets the spacing between widgets.

Returns:

the spacing

setSpacing

public WBox setSpacing(int spacing)

Sets the spacing between widgets in this box.

Parameters:

spacing - the new spacing

Returns:

this box

getAxis

public Axis getAxis()

Gets the axis of this box.

Returns:

the axis

setAxis

public WBox setAxis(Axis axis)

Sets the axis of this box.

Parameters:

axis - the new axis

Returns:

this box

Throws:

NullPointerException - if the axis is null

getHorizontalAlignment

public HorizontalAlignment getHorizontalAlignment()

Gets the horizontal alignment of this box.

Returns:

the alignment

Since:

2.1.0

setHorizontalAlignment

public WBox setHorizontalAlignment(HorizontalAlignment alignment)

Sets the horizontal alignment of this box.

Parameters:

alignment - the new alignment

Returns:

this box

Throws:

NullPointerException - if the alignment is null

Since:

2.1.0

getVerticalAlignment

public VerticalAlignment getVerticalAlignment()

Gets the vertical alignment of this box.

Returns:

the alignment

Since:

2.1.0

setVerticalAlignment

public WBox setVerticalAlignment(VerticalAlignment alignment)

Sets the vertical alignment of this box.

Parameters:

alignment - the new alignment

Returns:

this box

Throws:

NullPointerException - if the alignment is null

Since:

2.1.0

setInsets

public WBox setInsets(Insets insets)

Description copied from class: WPanelWithInsets

Sets the layout insets of this panel. Subclasses are encouraged to override this method to return their more specific type (such as WGridPanel).

If there are already widgets in this panel when the insets are modified, the panel is resized and the widgets are moved according to the insets.

Overrides:

setInsets in class WPanelWithInsets

Parameters:

insets - the insets, should not be null

Returns:

this panel