com.jgoodies.forms.factories

Class Forms

java.lang.Object

com.jgoodies.forms.factories.Forms

public final class Forms
extends Object

Provides convenience behavior for building forms.

Since:

1.6

Version:

$Revision: 1.1 $

Author:

Karsten Lentzsch

Method Summary

Methods

Modifier and Type	Method and Description
static JComponent	border(Border border, JComponent component) Creates and returns a panel where component is surrounde by the given border.
static JComponent	border(String emptyBorderSpec, JComponent component) Creates and returns a panel where component is surrounde by an empty border as described by emptyBorderSpec.
static JComponent	buttonBar(JComponent... buttons) Creates and returns a panel where the given button are laid out horizontally using a ButtonBarBuilder.
static JComponent	buttonStack(JComponent... buttons) Creates and returns a panel where the given button are laid out vertically using a ButtonStackBuilder.
static JComponent	centered(JComponent component) Creates and returns a panel where component is centered.
static JComponent	checkBoxBar(JCheckBox... checkBoxes) Builds and returns a panel where the given check boxe are laid out horizontally.
static JComponent	checkBoxStack(JCheckBox... checkBoxes) Builds and returns a panel where the given check boxe are laid out vertically.
static JComponent	horizontal(String gapColSpec, JComponent... components) Builds and returns a panel where the given components are laid ou horizontally separated by gaps as described by the give FormLayout gap (column) specification.
static JComponent	radioButtonBar(JRadioButton... radioButtons) Builds and returns a panel where the given radio button are laid horizontally.
static JComponent	radioButtonStack(JRadioButton... radioButtons) Builds and returns a panel where the given radio button are laid vertically.
static JComponent	single(String columnSpec, String rowSpec, JComponent component) Creates and returns a panel where component is laid ou using a FormLayout with the given column and row specifications.
static JComponent	vertical(String gapRowSpec, JComponent... components) Builds and returns a panel where the given components are laid ou vertically separated by gaps as described by the give FormLayout gap (row) specification.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

single

public static JComponent single(String columnSpec,
                String rowSpec,
                JComponent component)

Creates and returns a panel where component is laid ou using a FormLayout with the given column and row specifications

Parameters:

columnSpec - a FormLayout column specification for a single column

rowSpec - a FormLayout row specification for a single row

component - the component to lay out

Returns:

the built panel

Throws:

NullPointerException - if columnSpec, rowSpec or component is null

IllegalArgumentException - if columnSpec or rowSpec

centered

public static JComponent centered(JComponent component)

Creates and returns a panel where component is centered The panel grows both horizontally and vertically as its container grows

Parameters:

component - the component to center

Returns:

the built panel

Throws:

NullPointerException - if component is null

border

public static JComponent border(Border border,
                JComponent component)

Creates and returns a panel where component is surrounde by the given border

Parameters:

border - the border used to surround the component

component - the component to wrap

Returns:

the built panel

Throws:

NullPointerException - if border or componentnull

border

public static JComponent border(String emptyBorderSpec,
                JComponent component)

Creates and returns a panel where component is surrounde by an empty border as described by emptyBorderSpec

Parameters:

component - the component to wrap

Returns:

the built panel

Throws:

NullPointerException - if emptyBorderSpeccomponent is null

horizontal

public static JComponent horizontal(String gapColSpec,
                    JComponent... components)

Builds and returns a panel where the given components are laid ou horizontally separated by gaps as described by the give FormLayout gap (column) specification

Parameters:

gapColSpec - describes the horizontal gap between the components

components - the components to be laid out

Returns:

the built panel

Throws:

NullPointerException - if components is null

IllegalArgumentException - if components is empty

vertical

public static JComponent vertical(String gapRowSpec,
                  JComponent... components)

Builds and returns a panel where the given components are laid ou vertically separated by gaps as described by the give FormLayout gap (row) specification

Parameters:

gapRowSpec - describes the vertical gap between the components

components - the components to be laid out

Returns:

the built panel

Throws:

NullPointerException - if components is null

IllegalArgumentException - if components is empty

buttonBar

public static JComponent buttonBar(JComponent... buttons)

Creates and returns a panel where the given button are laid out horizontally using a ButtonBarBuilder Equivalent to

com.jgoodies.jsdl.common.focus.FocusTraversalUtils

Parameters:

buttons - the buttons to add to the button bar

Returns:

the built button bar

Throws:

NullPointerException - if buttons is null

IllegalArgumentException - if buttons is empty

See Also:

ButtonBarBuilder

buttonStack

public static JComponent buttonStack(JComponent... buttons)

Creates and returns a panel where the given button are laid out vertically using a ButtonStackBuilder Equivalent to

com.jgoodies.jsdl.common.focus.FocusTraversalUtils

Parameters:

buttons - the buttons to add to the button stack

Returns:

the built button stack

Throws:

NullPointerException - if buttons is null

IllegalArgumentException - if buttons is empty

Since:

1.8

See Also:

ButtonStackBuilder

checkBoxBar

public static JComponent checkBoxBar(JCheckBox... checkBoxes)

Builds and returns a panel where the given check boxe are laid out horizontally.

com.jgoodies.jsdl.common.focus.FocusTraversalUtils

Parameters:

checkBoxes - the check boxes to lay out in a row

Returns:

the built panel

Throws:

NullPointerException - if checkBoxes is null

IllegalArgumentException - if checkBoxes is empty

checkBoxStack

public static JComponent checkBoxStack(JCheckBox... checkBoxes)

Builds and returns a panel where the given check boxe are laid out vertically.

com.jgoodies.jsdl.common.focus.FocusTraversalUtils

Parameters:

checkBoxes - the check boxes to lay out in a stack

Returns:

the built panel

Throws:

NullPointerException - if checkBoxes is null

IllegalArgumentException - if checkBoxes is empty

Since:

1.8

radioButtonBar

public static JComponent radioButtonBar(JRadioButton... radioButtons)

Builds and returns a panel where the given radio button are laid horizontally.

com.jgoodies.jsdl.common.focus.FocusTraversalUtils

Parameters:

radioButtons - the radio buttons to lay out in a row

Returns:

the built panel

Throws:

NullPointerException - if radioButtons is null

IllegalArgumentException - if radioButtons is empty

radioButtonStack

public static JComponent radioButtonStack(JRadioButton... radioButtons)

Builds and returns a panel where the given radio button are laid vertically.

com.jgoodies.jsdl.common.focus.FocusTraversalUtils

Parameters:

radioButtons - the radio buttons to lay out in a stack

Returns:

the built panel

Throws:

NullPointerException - if radioButtons is null

IllegalArgumentException - if radioButtons is empty

Since:

1.8