com.jgoodies.forms.layout

Class ColumnSpec

public final class ColumnSpec extends FormSpec

Specifies columns in FormLayout by their default orientation, start size and resizing behavior.

Examples:
The following examples specify a column with FILL alignment, a size of 10 dlu that won't grow.

 new ColumnSpec(Sizes.dluX(10));
 new ColumnSpec(ColumnSpec.FILL, Sizes.dluX(10), 0.0);
 new ColumnSpec(ColumnSpec.FILL, Sizes.dluX(10), ColumnSpec.NO_GROW);
 ColumnSpec.parse("10dlu");
 ColumnSpec.parse("10dlu:0");
 ColumnSpec.parse("fill:10dlu:0");

The {@link com.jgoodies.forms.factories.FormFactory} provides predefined frequently used ColumnSpec instances.

Version: $Revision: 1.15 $

Author: Karsten Lentzsch

See Also: FormFactory

Field Summary
static DefaultAlignment	CENTER By default put the components in the center.
static DefaultAlignment	DEFAULT Unless overridden the default alignment for a column is FILL.
static DefaultAlignment	FILL By default fill the component into the column.
static DefaultAlignment	LEFT By default put components in the left.
static DefaultAlignment	MIDDLE By default put components in the middle.
static DefaultAlignment	RIGHT By default put components in the right.

Constructor Summary
	ColumnSpec(DefaultAlignment defaultAlignment, Size size, double resizeWeight) Constructs a ColumnSpec for the given default alignment, size and resize weight. The resize weight must be a non-negative double; you can use `NO_GROW` as a convenience value for no resize.
	ColumnSpec(Size size) Constructs a ColumnSpec for the given size using the default alignment, and no resizing.
	ColumnSpec(String encodedDescription) Constructs a ColumnSpec from the specified encoded description.

Method Summary
static ColumnSpec	createGap(ConstantSize gapWidth) Creates and returns a {@link ColumnSpec} that represents a gap with the specified {@link ConstantSize}.
static ColumnSpec	decode(String encodedColumnSpec) Parses the encoded column specification and returns a ColumnSpec object that represents the string.
static ColumnSpec	decode(String encodedColumnSpec, LayoutMap layoutMap) Parses the encoded column specifications and returns a ColumnSpec object that represents the string.
static ColumnSpec[]	decodeSpecs(String encodedColumnSpecs) Parses and splits encoded column specifications using the default {@link LayoutMap} and returns an array of ColumnSpec objects.
static ColumnSpec[]	decodeSpecs(String encodedColumnSpecs, LayoutMap layoutMap) Splits and parses the encoded column specifications using the given {@link LayoutMap} and returns an array of ColumnSpec objects.
protected boolean	isHorizontal() Returns if this is a horizontal specification (vs. vertical).

Field Detail

CENTER

public static final DefaultAlignment CENTER

By default put the components in the center.

DEFAULT

public static final DefaultAlignment DEFAULT

Unless overridden the default alignment for a column is FILL.

FILL

public static final DefaultAlignment FILL

By default fill the component into the column.

LEFT

public static final DefaultAlignment LEFT

By default put components in the left.

MIDDLE

public static final DefaultAlignment MIDDLE

By default put components in the middle.

RIGHT

public static final DefaultAlignment RIGHT

By default put components in the right.

Constructor Detail

ColumnSpec

public ColumnSpec(DefaultAlignment defaultAlignment, Size size, double resizeWeight)

Constructs a ColumnSpec for the given default alignment, size and resize weight.

The resize weight must be a non-negative double; you can use NO_GROW as a convenience value for no resize.

Parameters: defaultAlignment the column's default alignment size constant, component size or bounded size resizeWeight the column's non-negative resize weight

Throws: NullPointerException if the {@code size} is {@code null} IllegalArgumentException if the size is invalid or the {@code resizeWeight} is negative

ColumnSpec

public ColumnSpec(Size size)

Constructs a ColumnSpec for the given size using the default alignment, and no resizing.

Parameters: size constant size, component size, or bounded size

Throws: IllegalArgumentException if the size is invalid

ColumnSpec

public ColumnSpec(String encodedDescription)

Deprecated: Replaced by {@link #decode(String)}

Constructs a ColumnSpec from the specified encoded description. The description will be parsed to set initial values.

Unlike the factory method {@link #decode(String)}, this constructor does not expand layout variables, and it cannot vend cached objects.

Note: This constructor will become private in the Forms 2.0.

Parameters: encodedDescription the encoded description

Method Detail

createGap

public static ColumnSpec createGap(ConstantSize gapWidth)

Creates and returns a {@link ColumnSpec} that represents a gap with the specified {@link ConstantSize}.

Parameters: gapWidth specifies the gap width

Returns: a ColumnSpec that describes a horizontal gap

Throws: NullPointerException if {@code gapWidth} is {@code null}

Since: 1.2

decode

public static ColumnSpec decode(String encodedColumnSpec)

Parses the encoded column specification and returns a ColumnSpec object that represents the string. Variables are expanded using the default LayoutMap.

Parameters: encodedColumnSpec the encoded column specification

Returns: a ColumnSpec instance for the given specification

Throws: NullPointerException if {@code encodedColumnSpec} is {@code null}

Since: 1.2

decode

public static ColumnSpec decode(String encodedColumnSpec, LayoutMap layoutMap)

Parses the encoded column specifications and returns a ColumnSpec object that represents the string. Variables are expanded using the given LayoutMap.

Parameters: encodedColumnSpec the encoded column specification layoutMap expands layout column variables

Returns: a ColumnSpec instance for the given specification

Throws: NullPointerException if {@code encodedColumnSpec} or {@code layoutMap} is {@code null}

Since: 1.2

decodeSpecs

public static ColumnSpec[] decodeSpecs(String encodedColumnSpecs)

Parses and splits encoded column specifications using the default {@link LayoutMap} and returns an array of ColumnSpec objects.

Parameters: encodedColumnSpecs comma separated encoded column specifications

Returns: an array of decoded column specifications

Throws: NullPointerException if {@code encodedColumnSpecs} is {@code null}

decodeSpecs

public static ColumnSpec[] decodeSpecs(String encodedColumnSpecs, LayoutMap layoutMap)

Splits and parses the encoded column specifications using the given {@link LayoutMap} and returns an array of ColumnSpec objects.

Parameters: encodedColumnSpecs comma separated encoded column specifications layoutMap expands layout column variables

Returns: an array of decoded column specifications

Throws: NullPointerException if {@code encodedColumnSpecs} or {@code layoutMap} is {@code null}

Since: 1.2

isHorizontal

protected boolean isHorizontal()

Returns if this is a horizontal specification (vs. vertical). Used to distinct between horizontal and vertical dialog units, which have different conversion factors.

Returns: always {@code true} (for horizontal)