net.lenni0451.commons.swing

Class GBC

java.lang.Object

net.lenni0451.commons.swing.GBC

public class GBC
extends java.lang.Object

A wrapper for GridBagConstraints to make it easier to use.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ABOVE_BASELINE
static int	ABOVE_BASELINE_LEADING
static int	ABOVE_BASELINE_TRAILING
static int	BASELINE
static int	BASELINE_LEADING
static int	BASELINE_TRAILING
static int	BELOW_BASELINE
static int	BELOW_BASELINE_LEADING
static int	BELOW_BASELINE_TRAILING
static int	BOTH
static int	CENTER
static int	EAST
static int	FIRST_LINE_END
static int	FIRST_LINE_START
static int	HORIZONTAL
static int	LAST_LINE_END
static int	LAST_LINE_START
static int	LINE_END
static int	LINE_START
static int	NONE
static int	NORTH
static int	NORTHEAST
static int	NORTHWEST
static int	PAGE_END
static int	PAGE_START
static int	RELATIVE
static int	REMAINDER
static int	SOUTH
static int	SOUTHEAST
static int	SOUTHWEST
static int	VERTICAL
static int	WEST

Method Summary

Modifier and Type	Method and Description
<C extends java.awt.Component> GBC	add(C component, java.util.function.Consumer<C> consumer) Add the specified component to the parent container with the constraints.
GBC	add(java.awt.Component component) Add the specified component to the parent container with the constraints.
GBC	add(java.awt.Component component, java.lang.Runnable runnable) Add the specified component to the parent container with the constraints.
GBC	add(java.util.function.Supplier<java.awt.Component> supplier) Add the component created by the supplier to the parent container with the constraints.
GBC	anchor(int anchor) Set the anchor of the constraints.
static GBC	create() Create a new GBC with the parent set to null.
static GBC	create(java.awt.Container parent) Create a new GBC with the parent set to the specified container.
static java.util.OptionalInt	currentGridX(java.awt.Container container) Get the current gridx value for the specified container.
static java.util.OptionalInt	currentGridY(java.awt.Container container) Get the current gridy value for the specified container.
GBC	fill(int fill) Set the fill of the constraints.
static int	fillVerticalSpace(java.awt.Container parent) Add a filler component that will fill the remaining horizontal space.
static void	fillVerticalSpace(java.awt.Container parent, int gridy) Add a filler component that will fill the remaining horizontal space.
java.awt.GridBagConstraints	get()
GBC	grid(int gridx, int gridy) Set the gridx and gridy of the constraints.
GBC	gridx(int gridx) Set the gridx of the constraints.
GBC	gridy(int gridy) Set the gridy of the constraints.
GBC	height(int gridheight) Set the gridheight of the constraints.
GBC	insets(java.awt.Insets insets) Set the insets of the constraints.
GBC	insets(int all) Set the insets of the constraints to the same value for all sides.
GBC	insets(int topBottom, int leftRight) Set the insets of the constraints to the same value for the top and bottom and the same value for the left and right.
GBC	insets(int top, int left, int bottom, int right) Set the insets of the constraints.
GBC	ipad(int ipadx, int ipady) Set the ipadx and ipady of the constraints.
GBC	ipadx(int ipadx) Set the ipadx of the constraints.
GBC	ipady(int ipady) Set the ipady of the constraints.
GBC	nextColumn() Set the gridx and gridy of the constraints to the next column.
GBC	nextRow() Set the gridx and gridy of the constraints to the next row.
GBC	size(int gridwidth, int gridheight) Set the gridwidth and gridheight of the constraints.
GBC	weight(double weightx, double weighty) Set the weightx and weighty of the constraints.
GBC	weightx(double weightx) Set the weightx of the constraints.
GBC	weighty(double weighty) Set the weighty of the constraints.
GBC	width(int gridwidth) Set the gridwidth of the constraints.

Methods inherited from class java.lang.Object

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

Field Detail

RELATIVE

public static final int RELATIVE

See Also:

Constant Field Values

REMAINDER

public static final int REMAINDER

See Also:

Constant Field Values

HORIZONTAL

public static final int HORIZONTAL

See Also:

Constant Field Values

NONE

public static final int NONE

See Also:

Constant Field Values

BOTH

public static final int BOTH

See Also:

Constant Field Values

VERTICAL

public static final int VERTICAL

See Also:

Constant Field Values

CENTER

public static final int CENTER

See Also:

Constant Field Values

NORTH

public static final int NORTH

See Also:

Constant Field Values

NORTHEAST

public static final int NORTHEAST

See Also:

Constant Field Values

EAST

public static final int EAST

See Also:

Constant Field Values

SOUTHEAST

public static final int SOUTHEAST

See Also:

Constant Field Values

SOUTH

public static final int SOUTH

See Also:

Constant Field Values

SOUTHWEST

public static final int SOUTHWEST

See Also:

Constant Field Values

WEST

public static final int WEST

See Also:

Constant Field Values

NORTHWEST

public static final int NORTHWEST

See Also:

Constant Field Values

PAGE_START

public static final int PAGE_START

See Also:

Constant Field Values

PAGE_END

public static final int PAGE_END

See Also:

Constant Field Values

LINE_START

public static final int LINE_START

See Also:

Constant Field Values

LINE_END

public static final int LINE_END

See Also:

Constant Field Values

FIRST_LINE_START

public static final int FIRST_LINE_START

See Also:

Constant Field Values

FIRST_LINE_END

public static final int FIRST_LINE_END

See Also:

Constant Field Values

LAST_LINE_START

public static final int LAST_LINE_START

See Also:

Constant Field Values

LAST_LINE_END

public static final int LAST_LINE_END

See Also:

Constant Field Values

BASELINE

public static final int BASELINE

See Also:

Constant Field Values

BASELINE_LEADING

public static final int BASELINE_LEADING

See Also:

Constant Field Values

BASELINE_TRAILING

public static final int BASELINE_TRAILING

See Also:

Constant Field Values

ABOVE_BASELINE

public static final int ABOVE_BASELINE

See Also:

Constant Field Values

ABOVE_BASELINE_LEADING

public static final int ABOVE_BASELINE_LEADING

See Also:

Constant Field Values

ABOVE_BASELINE_TRAILING

public static final int ABOVE_BASELINE_TRAILING

See Also:

Constant Field Values

BELOW_BASELINE

public static final int BELOW_BASELINE

See Also:

Constant Field Values

BELOW_BASELINE_LEADING

public static final int BELOW_BASELINE_LEADING

See Also:

Constant Field Values

BELOW_BASELINE_TRAILING

public static final int BELOW_BASELINE_TRAILING

See Also:

Constant Field Values

Method Detail

create

public static GBC create()

Create a new GBC with the parent set to null.
The add methods will throw an IllegalStateException if used.

Returns:

The new GBC

create

public static GBC create(java.awt.Container parent)

Create a new GBC with the parent set to the specified container.

Parameters:

parent - The parent container

Returns:

The new GBC

currentGridX

public static java.util.OptionalInt currentGridX(java.awt.Container container)

Get the current gridx value for the specified container.
This will return the highest gridx for the last gridy.

Parameters:

container - The container

Returns:

The current gridx value or empty if there are no components

currentGridY

public static java.util.OptionalInt currentGridY(java.awt.Container container)

Get the current gridy value for the specified container.

Parameters:

container - The container

Returns:

The current gridy value or empty if there are no components

fillVerticalSpace

public static int fillVerticalSpace(java.awt.Container parent)

Add a filler component that will fill the remaining horizontal space.
This will align all components to the top of the container.
This will return the new gridy value.

Parameters:

parent - The parent container

Returns:

The new gridy value

See Also:

currentGridY(Container), Box.createHorizontalGlue()

fillVerticalSpace

public static void fillVerticalSpace(java.awt.Container parent,
                                     int gridy)

Add a filler component that will fill the remaining horizontal space.
This will align all components to the top of the container.

Parameters:

parent - The parent container

gridy - The gridy value

See Also:

currentGridY(Container), Box.createHorizontalGlue()

nextColumn

public GBC nextColumn()

Set the gridx and gridy of the constraints to the next column.

Returns:

This GBC

nextRow

public GBC nextRow()

Set the gridx and gridy of the constraints to the next row.

Returns:

This GBC

gridx

public GBC gridx(int gridx)

Set the gridx of the constraints.

Parameters:

gridx - The gridx

Returns:

This GBC

See Also:

GridBagConstraints.gridx

gridy

public GBC gridy(int gridy)

Set the gridy of the constraints.

Parameters:

gridy - The gridy

Returns:

This GBC

See Also:

GridBagConstraints.gridy

grid

public GBC grid(int gridx,
                int gridy)

Set the gridx and gridy of the constraints.

Parameters:

gridx - The gridx

gridy - The gridy

Returns:

This GBC

See Also:

GridBagConstraints.gridx, GridBagConstraints.gridy

width

public GBC width(int gridwidth)

Set the gridwidth of the constraints.

Parameters:

gridwidth - The gridwidth

Returns:

This GBC

See Also:

GridBagConstraints.gridwidth

height

public GBC height(int gridheight)

Set the gridheight of the constraints.

Parameters:

gridheight - The gridheight

Returns:

This GBC

See Also:

GridBagConstraints.gridheight

size

public GBC size(int gridwidth,
                int gridheight)

Set the gridwidth and gridheight of the constraints.

Parameters:

gridwidth - The gridwidth

gridheight - The gridheight

Returns:

This GBC

See Also:

GridBagConstraints.gridwidth, GridBagConstraints.gridheight

weightx

public GBC weightx(double weightx)

Set the weightx of the constraints.

Parameters:

weightx - The weightx

Returns:

This GBC

See Also:

GridBagConstraints.weightx

weighty

public GBC weighty(double weighty)

Set the weighty of the constraints.

Parameters:

weighty - The weighty

Returns:

This GBC

See Also:

GridBagConstraints.weighty

weight

public GBC weight(double weightx,
                  double weighty)

Set the weightx and weighty of the constraints.

Parameters:

weightx - The weightx

weighty - The weighty

Returns:

This GBC

See Also:

GridBagConstraints.weightx, GridBagConstraints.weighty

anchor

public GBC anchor(int anchor)

Set the anchor of the constraints.

Parameters:

anchor - The anchor

Returns:

This GBC

See Also:

GridBagConstraints.anchor

fill

public GBC fill(int fill)

Set the fill of the constraints.

Parameters:

fill - The fill

Returns:

This GBC

See Also:

GridBagConstraints.fill

insets

public GBC insets(java.awt.Insets insets)

Set the insets of the constraints.

Parameters:

insets - The insets

Returns:

This GBC

See Also:

GridBagConstraints.insets

insets

public GBC insets(int all)

Set the insets of the constraints to the same value for all sides.

Parameters:

all - The value for all sides

Returns:

This GBC

See Also:

GridBagConstraints.insets

insets

public GBC insets(int topBottom,
                  int leftRight)

Set the insets of the constraints to the same value for the top and bottom and the same value for the left and right.

Parameters:

topBottom - The value for the top and bottom

leftRight - The value for the left and right

Returns:

This GBC

See Also:

GridBagConstraints.insets

insets

public GBC insets(int top,
                  int left,
                  int bottom,
                  int right)

Set the insets of the constraints.

Parameters:

top - The value for the top

left - The value for the left

bottom - The value for the bottom

right - The value for the right

Returns:

This GBC

See Also:

GridBagConstraints.insets

ipadx

public GBC ipadx(int ipadx)

Set the ipadx of the constraints.

Parameters:

ipadx - The ipadx

Returns:

This GBC

See Also:

GridBagConstraints.ipadx

ipady

public GBC ipady(int ipady)

Set the ipady of the constraints.

Parameters:

ipady - The ipady

Returns:

This GBC

See Also:

GridBagConstraints.ipady

ipad

public GBC ipad(int ipadx,
                int ipady)

Set the ipadx and ipady of the constraints.

Parameters:

ipadx - The ipadx

ipady - The ipady

Returns:

This GBC

See Also:

GridBagConstraints.ipadx, GridBagConstraints.ipady

add

public GBC add(java.awt.Component component)

Add the specified component to the parent container with the constraints.

Parameters:

component - The component to add

Returns:

This GBC

add

public GBC add(java.awt.Component component,
               java.lang.Runnable runnable)

Add the specified component to the parent container with the constraints.
The runnable will be called before the component is added to the parent container.

Parameters:

component - The component to add

runnable - The runnable to configure the component

Returns:

This GBC

add

public <C extends java.awt.Component> GBC add(C component,
                                              java.util.function.Consumer<C> consumer)

Add the specified component to the parent container with the constraints.
The consumer will be called before the component is added to the parent container.

Type Parameters:

C - The type of the component

Parameters:

component - The component to add

consumer - The consumer to configure the component

Returns:

This GBC

add

public GBC add(java.util.function.Supplier<java.awt.Component> supplier)

Add the component created by the supplier to the parent container with the constraints.

Parameters:

supplier - The supplier to create the component

Returns:

This GBC

get

public java.awt.GridBagConstraints get()

Returns:

The constraints