Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.component.button

Interface ButtonPanelBuilder

All Superinterfaces:

ComponentBuilder<JPanel,ButtonPanelBuilder>, ControlPanelBuilder<JPanel,ButtonPanelBuilder>, Supplier<JPanel>

public interface ButtonPanelBuilder
extends ControlPanelBuilder<JPanel,ButtonPanelBuilder>

Builds a JPanel with buttons, in a row or a column.

The buttons are stretched across the panel, and share any extra space along it.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ButtonPanelBuilder.Separator	Specifies how separators are presented in a button panel.

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<ButtonPanelBuilder.Separator>	SEPARATORS	Specifies how separators are presented in button panels by default.

Method Summary

Modifier and Type	Method	Description
static ButtonPanelBuilder	builder()
ButtonPanelBuilder	buttonGap(int buttonGap)	Default is Layouts.GAP.
ButtonPanelBuilder	buttonGroup(@Nullable ButtonGroup buttonGroup)	Note that components added via ControlPanelBuilder.add(javax.swing.JComponent) are not added to the button group.
ButtonPanelBuilder	fixedButtonSize(boolean fixedButtonSize)	Specifies whether the buttons are all sized like the largest one, or each by its own preferred size.
ButtonPanelBuilder	separators(ButtonPanelBuilder.Separator separators)	Specifies how separators are presented, the space on each side of them being Layouts.GAP, in addition to the button gap.

Methods inherited from interface is.codion.swing.common.ui.component.builder.ComponentBuilder

ancestorListener, background, border, build, build, clientProperty, componentListener, componentOrientation, enabled, enabled, focusable, focusable, focusCycleRoot, focusListener, font, font, foreground, get, hierarchyListener, keyEvent, keyListener, label, label, label, maximumHeight, maximumSize, maximumWidth, minimumHeight, minimumSize, minimumWidth, mouseListener, mouseMotionListener, mouseWheelListener, name, onBuild, onSetVisible, opaque, popupControl, popupControls, popupControls, popupMenu, preferredHeight, preferredSize, preferredWidth, propertyChangeListener, propertyChangeListener, scrollPane, toolTipText, toolTipText, transferFocusOnEnter, transferFocusOnEnter, transferHandler, visible, visible

Methods inherited from interface is.codion.swing.common.ui.component.button.ControlPanelBuilder

action, add, add, buttons, buttonsFocusable, checkBoxes, control, control, controls, controls, includeButtonText, orientation, preferredButtonSize, radioButtons, separator, toggleButtons, toggleButtonType

Field Details

SEPARATORS

static final PropertyValue<ButtonPanelBuilder.Separator> SEPARATORS

Specifies how separators are presented in button panels by default.

• Value type: ButtonPanelBuilder.Separator
• Default value: ButtonPanelBuilder.Separator.LINE

See Also:

• separators(Separator)

Method Details

buttonGap

ButtonPanelBuilder buttonGap(int buttonGap)

Default is Layouts.GAP.

Parameters:

buttonGap - the gap between buttons in pixels

Returns:

this builder instance

fixedButtonSize

ButtonPanelBuilder fixedButtonSize(boolean fixedButtonSize)

Specifies whether the buttons are all sized like the largest one, or each by its own preferred size. Separators and nested controls keep their own size either way. Default true.

Parameters:

fixedButtonSize - true if the buttons should all be sized like the largest one

Returns:

this builder instance

separators

ButtonPanelBuilder separators(ButtonPanelBuilder.Separator separators)

Specifies how separators are presented, the space on each side of them being Layouts.GAP, in addition to the button gap. Default SEPARATORS.

Parameters:

separators - the separator presentation

Returns:

this builder instance

buttonGroup

ButtonPanelBuilder buttonGroup(@Nullable ButtonGroup buttonGroup)

Note that components added via ControlPanelBuilder.add(javax.swing.JComponent) are not added to the button group.

Parameters:

buttonGroup - the button group to add the buttons based on the controls to

Returns:

this builder instance

builder

static ButtonPanelBuilder builder()

Returns:

a new button panel builder