com.jgoodies.forms.builder

Class AbstractButtonPanelBuilder

public abstract class AbstractButtonPanelBuilder extends Object

The abstract superclass for {@link ButtonBarBuilder2}. Provides a cell cursor for traversing the button bar/stack while components are added. It also offers convenience methods to append logical columns and rows.

TODO: Mention the ButtonStackBuilder2 subclass as soon as it is available.

Since: 1.2

Version: $Revision: 1.3 $

Author: Karsten Lentzsch

Constructor Summary
protected AbstractButtonPanelBuilder(FormLayout layout, JPanel container)
Constructs a AbstractFormBuilder for the given FormLayout and layout container.
Method Summary
protected Componentadd(Component component)
Adds a component to the container using the default cell constraints.
protected voidappendColumn(ColumnSpec columnSpec)
Appends the given column specification to the builder's layout.
protected voidappendGlueColumn()
Appends a glue column.
protected voidappendGlueRow()
Appends a glue row.
protected voidappendRelatedComponentsGapColumn()
Appends a column that is the default gap for related components.
protected voidappendRelatedComponentsGapRow()
Appends a row that is the default gap for related components.
protected voidappendRow(RowSpec rowSpec)
Appends the given row specification to the builder's layout.
protected voidappendUnrelatedComponentsGapColumn()
Appends a column that is the default gap for unrelated components.
protected voidappendUnrelatedComponentsGapRow()
Appends a row that is the default gap for unrelated components.
JPanelgetContainer()
Returns the container used to build the form.
FormLayoutgetLayout()
Returns the instance of {@link FormLayout} used to build this form.
JPanelgetPanel()
Returns the panel used to build the form.
booleanisLeftToRight()
Returns whether this builder fills the form left-to-right or right-to-left.
protected voidnextColumn()
Moves to the next column, does the same as #nextColumn(1).
protected voidnextRow()
Increases the row by one; does the same as #nextRow(1).
voidsetBackground(Color background)
Sets the panel's background color.
voidsetBorder(Border border)
Sets the panel's border.
voidsetLeftToRight(boolean b)
Sets the form fill direction to left-to-right or right-to-left.
voidsetOpaque(boolean b)
Sets the panel's opaque state.

Constructor Detail

AbstractButtonPanelBuilder

protected AbstractButtonPanelBuilder(FormLayout layout, JPanel container)
Constructs a AbstractFormBuilder for the given FormLayout and layout container.

Parameters: layout the {@link FormLayout} to use container the layout container

Throws: NullPointerException if the layout or container is null

Method Detail

add

protected final Component add(Component component)
Adds a component to the container using the default cell constraints. Note that when building from left to right, this method won't adjust the cell constraints if the column span is larger than 1.

Parameters: component the component to add

Returns: the added component

appendColumn

protected final void appendColumn(ColumnSpec columnSpec)
Appends the given column specification to the builder's layout.

Parameters: columnSpec the column specification object to append

appendGlueColumn

protected final void appendGlueColumn()
Appends a glue column.

See Also: appendRelatedComponentsGapColumn appendUnrelatedComponentsGapColumn

appendGlueRow

protected final void appendGlueRow()
Appends a glue row.

See Also: appendRelatedComponentsGapRow appendUnrelatedComponentsGapRow

appendRelatedComponentsGapColumn

protected final void appendRelatedComponentsGapColumn()
Appends a column that is the default gap for related components.

See Also: appendGlueColumn appendUnrelatedComponentsGapColumn

appendRelatedComponentsGapRow

protected final void appendRelatedComponentsGapRow()
Appends a row that is the default gap for related components.

See Also: appendGlueRow appendUnrelatedComponentsGapRow

appendRow

protected final void appendRow(RowSpec rowSpec)
Appends the given row specification to the builder's layout.

Parameters: rowSpec the row specification object to append

appendUnrelatedComponentsGapColumn

protected final void appendUnrelatedComponentsGapColumn()
Appends a column that is the default gap for unrelated components.

See Also: appendGlueColumn appendRelatedComponentsGapColumn

appendUnrelatedComponentsGapRow

protected final void appendUnrelatedComponentsGapRow()
Appends a row that is the default gap for unrelated components.

See Also: appendGlueRow appendRelatedComponentsGapRow

getContainer

public final JPanel getContainer()
Returns the container used to build the form.

Returns: the layout container, a {code JPanel}.

getLayout

public final FormLayout getLayout()
Returns the instance of {@link FormLayout} used to build this form.

Returns: the FormLayout

getPanel

public final JPanel getPanel()
Returns the panel used to build the form.

Returns: the panel used by this builder to build the form

isLeftToRight

public final boolean isLeftToRight()
Returns whether this builder fills the form left-to-right or right-to-left. The initial value of this property is set during the builder construction from the layout container's componentOrientation property.

Returns: true indicates left-to-right, false indicates right-to-left

See Also: AbstractButtonPanelBuilder ComponentOrientation

nextColumn

protected final void nextColumn()
Moves to the next column, does the same as #nextColumn(1).

nextRow

protected final void nextRow()
Increases the row by one; does the same as #nextRow(1).

setBackground

public final void setBackground(Color background)
Sets the panel's background color.

Parameters: background the color to set as new background

See Also: JComponent#setBackground(Color)

setBorder

public final void setBorder(Border border)
Sets the panel's border.

Parameters: border the border to set

See Also: JComponent#setBorder(Border)

setLeftToRight

public final void setLeftToRight(boolean b)
Sets the form fill direction to left-to-right or right-to-left. The initial value of this property is set during the builder construction from the layout container's componentOrientation property.

Parameters: b true indicates left-to-right, false right-to-left

See Also: isLeftToRight ComponentOrientation

setOpaque

public final void setOpaque(boolean b)
Sets the panel's opaque state.

Parameters: b true for opaque, false for non-opaque

Since: 1.1

See Also: JComponent#setOpaque(boolean)

Copyright © 2002-2008 JGoodies Karsten Lentzsch. All Rights Reserved.