com.jgoodies.forms.builder
Class ButtonStackBuilder

java.lang.Object
  extended by com.jgoodies.forms.builder.AbstractFormBuilder
      extended by com.jgoodies.forms.builder.PanelBuilder
          extended by com.jgoodies.forms.builder.ButtonStackBuilder

public final class ButtonStackBuilder
extends PanelBuilder

A non-visual builder that assists you in building consistent button stacks using the FormLayout.

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) {
     ButtonStackBuilder builder = new ButtonStackBuilder();
     builder.addGridded(close);
     builder.addUnrelatedGap();
     builder.addGridded(up);
     builder.addRelatedGap();
     builder.addGridded(down);
     return builder.getPanel();
 }
 

Version:
$Revision: 1.1 $
Author:
Karsten Lentzsch

Constructor Summary
ButtonStackBuilder()
          Constructs an instance of ButtonStackBuilder on a default JPanel.
ButtonStackBuilder(javax.swing.JPanel panel)
          Constructs an instance of ButtonStackBuilder on the given panel.
 
Method Summary
 void addButtons(javax.swing.JButton[] buttons)
          Adds a sequence of related buttons separated by a default gap.
 void addFixed(javax.swing.JComponent component)
          Adds a fixed size component.
 void addGlue()
          Adds a glue that will be given the extra space, if this box is larger than its preferred size.
 void addGridded(javax.swing.JComponent component)
          Adds a gridded component.
 void addGriddedNarrow(javax.swing.JComponent component)
          Adds a gridded narrow component.
 void addRelatedGap()
          Adds the standard gap for related components.
 void addStrut(ConstantSize size)
          Adds a strut of a specified size.
 void addUnrelatedGap()
          Adds the standard gap for unrelated components.
 
Methods inherited from class com.jgoodies.forms.builder.PanelBuilder
add, addLabel, addLabel, addLabel, addLabel, addSeparator, addSeparator, addSeparator, addSeparator, addTitle, addTitle, addTitle, getPanel, setBorder, setDefaultDialogBorder
 
Methods inherited from class com.jgoodies.forms.builder.AbstractFormBuilder
add, add, add, appendColumn, appendColumn, appendGlueColumn, appendGlueRow, appendRelatedComponentsGapColumn, appendRelatedComponentsGapRow, appendRow, appendRow, appendUnrelatedComponentsGapColumn, appendUnrelatedComponentsGapRow, getColumn, getColumnCount, getContainer, getLayout, getRow, getRowCount, isLeftToRight, nextColumn, nextColumn, nextLine, nextLine, nextRow, nextRow, setAlignment, setBounds, setColumn, setColumnSpan, setExtent, setHAlignment, setLeftToRight, setOrigin, setRow, setRowSpan, setVAlignment
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ButtonStackBuilder

public ButtonStackBuilder(javax.swing.JPanel panel)
Constructs an instance of ButtonStackBuilder on the given panel.

Parameters:
panel - the layout container

ButtonStackBuilder

public ButtonStackBuilder()
Constructs an instance of ButtonStackBuilder on a default JPanel.

Method Detail

addButtons

public void addButtons(javax.swing.JButton[] buttons)
Adds a sequence of related buttons separated by a default gap.

Parameters:
buttons - an array of buttons to add

addFixed

public void addFixed(javax.swing.JComponent component)
Adds a fixed size component.

Parameters:
component - the component to add

addGridded

public void addGridded(javax.swing.JComponent component)
Adds a gridded component.

Parameters:
component - the component to add

addGriddedNarrow

public void addGriddedNarrow(javax.swing.JComponent component)
Adds a gridded narrow component.

Parameters:
component - the component to add

addGlue

public void addGlue()
Adds a glue that will be given the extra space, if this box is larger than its preferred size.


addRelatedGap

public void addRelatedGap()
Adds the standard gap for related components.


addUnrelatedGap

public void addUnrelatedGap()
Adds the standard gap for unrelated components.


addStrut

public void addStrut(ConstantSize size)
Adds a strut of a specified size.

Parameters:
size - a constant that describes the gap