Class ButtonStackBuilder
FormLayout
and honors the platform's
LayoutStyle
regarding button sizes, and gaps.This builder sets a hint for narrow margin for the gridded buttons. This can reduce the button stack's width if some buttons have long texts. For example, a stack with 'OK', 'Cancel', 'Configure…' will likely exceed the minimum button width. The narrow margins help getting narrow stacks. Note that some look&feels do not support the narrow margin feature, and conversely, others have only narrow margins. The JGoodies look&feels honor the setting, the Mac Aqua l&f uses narrow margins all the time.
Example:
The following example builds a button stack with Close, Up and
Down, where Up and Down are related, and Close is not related
to the other buttons, which makes a wide gap for the unrelated and
a smaller gap for the related buttons.
private JPanel createCloseUpDownButtonStack( JButton close, JButton up, JButton down) { return ButtonStackBuilder().create() .addGridded(close) .addUnrelatedGap() .addGridded(up) .addRelatedGap() .addGridded(down) .build(); }
- Version:
- $Revision: 1.15 $
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final ColumnSpec[]
Specifies the FormLayout's the single button stack column.private static final RowSpec[]
Specifies the rows of the initial FormLayout used in constructors.Fields inherited from class com.jgoodies.forms.internal.AbstractButtonPanelBuilder
focusGrouped
Fields inherited from class com.jgoodies.forms.internal.AbstractBuilder
currentCellConstraints
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a ButtonStackBuilder on a default JPanel using a pre-configured FormLayout as layout manager.ButtonStackBuilder
(JPanel panel) Constructs a ButtonStackBuilder on the given panel using a pre-configured FormLayout as layout manager. -
Method Summary
Modifier and TypeMethodDescriptionConstructs an array of JButtons from the given Action array, and adds them as a sequence of related buttons separated by a default gap.addButton
(JComponent button) Adds a button component that has a minimum width specified by theLayoutStyle.getDefaultButtonWidth()
.addButton
(JComponent... buttons) Adds one or many sequences of related buttons.addFixed
(JComponent component) Adds a fixed size component.addGlue()
Adds a glue that will be given the extra space, if this box is larger than its preferred size.Adds the standard gap for related components.addStrut
(ConstantSize size) Adds a strut of a specified size.Adds the standard gap for unrelated components.static ButtonStackBuilder
create()
Creates and returns an empty ButtonStackBuilder.Methods inherited from class com.jgoodies.forms.internal.AbstractButtonPanelBuilder
add, appendColumn, appendGlueColumn, appendGlueRow, appendRelatedComponentsGapColumn, appendRelatedComponentsGapRow, appendRow, appendUnrelatedComponentsGapColumn, appendUnrelatedComponentsGapRow, build, createButton, getColumn, getRow, isLeftToRight, nextColumn, nextRow, setBackground, setBorder, setLeftToRight, setOpaque
Methods inherited from class com.jgoodies.forms.internal.AbstractBuilder
background, border, border, createComponentFactory, getColumnCount, getComponentFactory, getContainer, getLayout, getPanel, getRowCount, opaque, padding, padding, setComponentFactory
-
Field Details
-
COL_SPECS
Specifies the FormLayout's the single button stack column. -
ROW_SPECS
Specifies the rows of the initial FormLayout used in constructors.
-
-
Constructor Details
-
ButtonStackBuilder
public ButtonStackBuilder()Constructs a ButtonStackBuilder on a default JPanel using a pre-configured FormLayout as layout manager. -
ButtonStackBuilder
Constructs a ButtonStackBuilder on the given panel using a pre-configured FormLayout as layout manager.- Parameters:
panel
- the layout container
-
-
Method Details
-
create
Creates and returns an empty ButtonStackBuilder.- Returns:
- the created builder
- Since:
- 1.8
-
addButton
Adds a button component that has a minimum width specified by theLayoutStyle.getDefaultButtonWidth()
.Although a JButton is expected, any JComponent is accepted to allow custom button component types.
- Specified by:
addButton
in classAbstractButtonPanelBuilder<ButtonStackBuilder>
- Parameters:
button
- the component to add- Returns:
- this builder
- Throws:
NullPointerException
- ifbutton
isnull
-
addButton
Description copied from class:AbstractButtonPanelBuilder
Adds one or many sequences of related buttons. A new sequence starts when a button isnull
. The next sequence is separated by an unrelated gap. Each button has the minimum width as specified byLayoutStyle.getDefaultButtonWidth()
. The gap width between the buttons isLayoutStyle.getRelatedComponentsPadX()
.Although JButtons are expected, general JComponents are accepted to allow custom button component types.
Examples:
builder.addButtons(newButton, editButton, deleteButton); builder.addButtons(newButton, editButton, deleteButton, null, printButton);
- Overrides:
addButton
in classAbstractButtonPanelBuilder<ButtonStackBuilder>
- Parameters:
buttons
- the buttons to add- Returns:
- this builder
- See Also:
-
addButton
Description copied from class:AbstractButtonPanelBuilder
Constructs an array of JButtons from the given Action array, and adds them as a sequence of related buttons separated by a default gap.- Overrides:
addButton
in classAbstractButtonPanelBuilder<ButtonStackBuilder>
- Parameters:
actions
- an array of buttons to add
-
addFixed
Adds a fixed size component.- Parameters:
component
- the component to add
-
addGlue
Adds a glue that will be given the extra space, if this box is larger than its preferred size. -
addRelatedGap
Description copied from class:AbstractButtonPanelBuilder
Adds the standard gap for related components.- Specified by:
addRelatedGap
in classAbstractButtonPanelBuilder<ButtonStackBuilder>
-
addStrut
Adds a strut of a specified size.- Parameters:
size
- a constant that describes the gap
-