com.jgoodies.forms.builder
Class ButtonBarBuilder

java.lang.Object
  com.jgoodies.forms.builder.AbstractBuilder
      com.jgoodies.forms.builder.AbstractButtonPanelBuilder
          com.jgoodies.forms.builder.ButtonBarBuilder

public final class ButtonBarBuilder
extends AbstractButtonPanelBuilder

A non-visual builder for building consistent button bars that compl with popular style guides. Utilizes the JGoodies FormLayoutLayoutStyle regarding button sizes and gaps.

Examples:

Since:
  
1.6
Version:
  
$Revision: 1.18 $
Author:
  
Karsten Lentzsch
See Also:
ButtonStackBuilder, 
LayoutStyle






Field Summary

 
Fields inherited from class com.jgoodies.forms.builder.AbstractButtonPanelBuilder
focusGrouped
 
Fields inherited from class com.jgoodies.forms.builder.AbstractBuilder
currentCellConstraints
 



Constructor Summary
ButtonBarBuilder()



          Constructs an empty ButtonBarBuilder on a JPanel.
ButtonBarBuilder(JPanel panel)



          Constructs an empty ButtonBarBuilder on the given panel.
 



Method Summary




 ButtonBarBuilder
addButton(Action... actions)



          Constructs an array of JButtons from the given Action array
 and adds them as a sequence of related buttons separated by a default gap.



 ButtonBarBuilder
addButton(JComponent... buttons)



          Adds one or many sequences of related buttons.



 ButtonBarBuilder
addButton(JComponent button)



          Adds a button component that has a minimum widt
 specified by the LayoutStyle.getDefaultButtonWidth().



 ButtonBarBuilder
addFixed(JComponent component)



          Adds a fixed size component with narrow margin.



 ButtonBarBuilder
addGlue()



          Adds a glue that will be given the extra space
 if this button bar is larger than its preferred size.



 ButtonBarBuilder
addGrowing(JComponent component)



          Adds a component that grows if the container grows.



 ButtonBarBuilder
addRelatedGap()



          Adds the standard horizontal gap for related components.



 ButtonBarBuilder
addStrut(ConstantSize width)



          Adds a horizontal strut of the specified width.



 ButtonBarBuilder
addUnrelatedGap()



          Adds the standard horizontal gap for unrelated components.



 ButtonBarBuilder
background(Color background)



          Sets the panel's background color and makes the panel opaque.



 ButtonBarBuilder
border(Border border)



          Sets the panel's border.



 ButtonBarBuilder
opaque(boolean b)



          Sets the panel's opaque state.


 
Methods inherited from class com.jgoodies.forms.builder.AbstractButtonPanelBuilder
add, appendColumn, appendGlueColumn, appendGlueRow, appendRelatedComponentsGapColumn, appendRelatedComponentsGapRow, appendRow, appendUnrelatedComponentsGapColumn, appendUnrelatedComponentsGapRow, build, createButton, getColumn, getPanel, getRow, isLeftToRight, nextColumn, nextRow, setBackground, setBorder, setLeftToRight, setOpaque
 
Methods inherited from class com.jgoodies.forms.builder.AbstractBuilder
createComponentFactory, getColumnCount, getComponentFactory, getComponentFactoryDefault, getContainer, getLayout, getRowCount, setComponentFactory, setComponentFactoryDefault
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 





Constructor Detail



ButtonBarBuilder
public ButtonBarBuilder()

Constructs an empty ButtonBarBuilder on a JPanel.





ButtonBarBuilder
public ButtonBarBuilder(JPanel panel)

Constructs an empty ButtonBarBuilder on the given panel.


Parameters:
panel - the layout container





Method Detail



addButton
public ButtonBarBuilder addButton(JComponent button)

Adds a button component that has a minimum widt
 specified by the LayoutStyle.getDefaultButtonWidth().


Specified by:
addButton in class AbstractButtonPanelBuilder


Parameters:
button - the component to add
Returns:
this builder
Throws:
NullPointerException - if button is null





addButton
public ButtonBarBuilder addButton(JComponent... buttons)

Description copied from class: AbstractButtonPanelBuilder
Adds one or many sequences of related buttons. A new sequence start
 when a button is null. The next sequence is separated by a
 unrelated gap
 Each button has the minimum width as specified b
 LayoutStyle.getDefaultButtonWidth(). The gap width betwee
 the buttons is LayoutStyle.getRelatedComponentsPadX().
Examples:


Overrides:
addButton in class AbstractButtonPanelBuilder


Parameters:
buttons - the buttons to add
Returns:
this builder
See Also:
AbstractButtonPanelBuilder.addButton(JComponent)





addButton
public ButtonBarBuilder addButton(Action... actions)

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 class AbstractButtonPanelBuilder


Parameters:
actions - an array of buttons to add





addFixed
public ButtonBarBuilder addFixed(JComponent component)

Adds a fixed size component with narrow margin. Unlike the buttons
 this component is laid out without a minimum width. In other words
 the width is determined only by the component's preferred width.


Parameters:
component - the component to add
Returns:
this builder





addGrowing
public ButtonBarBuilder addGrowing(JComponent component)

Adds a component that grows if the container grows
 The component's initial size (before it grows) is specifie
 by the LayoutStyle.getDefaultButtonWidth().


Parameters:
component - the component to add
Returns:
this builder





addGlue
public ButtonBarBuilder addGlue()

Adds a glue that will be given the extra space
 if this button bar is larger than its preferred size.



Returns:
this builder





addRelatedGap
public ButtonBarBuilder addRelatedGap()

Adds the standard horizontal gap for related components.


Specified by:
addRelatedGap in class AbstractButtonPanelBuilder



Returns:
this builder
See Also:
LayoutStyle.getRelatedComponentsPadX()





addUnrelatedGap
public ButtonBarBuilder addUnrelatedGap()

Adds the standard horizontal gap for unrelated components.


Specified by:
addUnrelatedGap in class AbstractButtonPanelBuilder



Returns:
this builder
See Also:
LayoutStyle.getUnrelatedComponentsPadX()





addStrut
public ButtonBarBuilder addStrut(ConstantSize width)

Adds a horizontal strut of the specified width
 For related and unrelated components use addRelatedGap()addUnrelatedGap() respectively.


Parameters:
width - describes the gap width
Returns:
this builder
See Also:
ColumnSpec.createGap(ConstantSize)





background
public ButtonBarBuilder background(Color background)

Description copied from class: AbstractButtonPanelBuilder
Sets the panel's background color and makes the panel opaque.


Overrides:
background in class AbstractButtonPanelBuilder


Parameters:
background - the color to set as new background
See Also:
JComponent.setBackground(Color)





border
public ButtonBarBuilder border(Border border)

Description copied from class: AbstractButtonPanelBuilder
Sets the panel's border.


Overrides:
border in class AbstractButtonPanelBuilder


Parameters:
border - the border to set
See Also:
JComponent.setBorder(Border)





opaque
public ButtonBarBuilder opaque(boolean b)

Description copied from class: AbstractButtonPanelBuilder
Sets the panel's opaque state.


Overrides:
opaque in class AbstractButtonPanelBuilder


Parameters:
b - true for opaque, false for non-opaque
See Also:
JComponent.setOpaque(boolean)