com.jgoodies.forms.layout

Class RowSpec

public final class RowSpec extends FormSpec

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

Examples:
The following examples specify a centered row with a size of 14 dlu that won't grow.

 new RowSpec(Sizes.dluX(14));
 new RowSpec(RowSpec.CENTER, Sizes.dluX(14), 0.0);
 new RowSpec(rowSpec.CENTER, Sizes.dluX(14), RowSpec.NO_GROW);
 RowSpec.parse("14dlu");
 RowSpec.parse("14dlu:0");
 RowSpec.parse("center:14dlu:0");
 

The FormFactory provides predefined frequently used RowSpec instances.

Version: $Revision: 1.15 $

Author: Karsten Lentzsch

See Also: FormFactory

Field Summary
static DefaultAlignmentBOTTOM
By default put the components in the bottom.
static DefaultAlignmentCENTER
By default put the components in the center.
static DefaultAlignmentDEFAULT
Unless overridden the default alignment for a row is CENTER.
static DefaultAlignmentFILL
By default fill the component into the row.
static DefaultAlignmentTOP
By default put the components in the top.
Constructor Summary
RowSpec(DefaultAlignment defaultAlignment, Size size, double resizeWeight)
Constructs a RowSpec from the given default orientation, size, and resize weight.

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

RowSpec(Size size)
Constructs a RowSpec for the given size using the default alignment, and no resizing.
RowSpec(String encodedDescription)
Constructs a RowSpec from the specified encoded description.
Method Summary
static RowSpeccreateGap(ConstantSize gapHeight)
Creates and returns a RowSpec that represents a gap with the specified ConstantSize.
static RowSpecdecode(String encodedRowSpec)
Parses the encoded row specification and returns a RowSpec object that represents the string.
static RowSpecdecode(String encodedRowSpec, LayoutMap layoutMap)
Parses the encoded row specifications and returns a RowSpec object that represents the string.
static RowSpec[]decodeSpecs(String encodedRowSpecs)
Parses and splits encoded row specifications using the default LayoutMap and returns an array of RowSpec objects.
static RowSpec[]decodeSpecs(String encodedRowSpecs, LayoutMap layoutMap)
Parses and splits encoded row specifications using the given LayoutMap and returns an array of RowSpec objects.
protected booleanisHorizontal()
Returns if this is a horizontal specification (vs. vertical).

Field Detail

BOTTOM

public static final DefaultAlignment BOTTOM
By default put the components in the bottom.

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 row is CENTER.

FILL

public static final DefaultAlignment FILL
By default fill the component into the row.

TOP

public static final DefaultAlignment TOP
By default put the components in the top.

Constructor Detail

RowSpec

public RowSpec(DefaultAlignment defaultAlignment, Size size, double resizeWeight)
Constructs a RowSpec from the given default orientation, size, and resize weight.

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

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

Throws: IllegalArgumentException if the size is invalid or the resize weight is negative

RowSpec

public RowSpec(Size size)
Constructs a RowSpec 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

RowSpec

public RowSpec(String encodedDescription)

Deprecated: Replaced by decode.

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

Unlike the factory method decode, 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 RowSpec createGap(ConstantSize gapHeight)
Creates and returns a RowSpec that represents a gap with the specified ConstantSize.

Parameters: gapHeight specifies the gap height

Returns: a RowSpec that describes a vertical gap with the given height

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

Since: 1.2

decode

public static RowSpec decode(String encodedRowSpec)
Parses the encoded row specification and returns a RowSpec object that represents the string. Variables are expanded using the default LayoutMap.

Parameters: encodedRowSpec the encoded row specification

Returns: a RowSpec instance for the given specification

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

Since: 1.2

See Also: RowSpec

decode

public static RowSpec decode(String encodedRowSpec, LayoutMap layoutMap)
Parses the encoded row specifications and returns a RowSpec object that represents the string. Variables are expanded using the given LayoutMap.

Parameters: encodedRowSpec the encoded column specification layoutMap expands layout row variables

Returns: a RowSpec instance for the given specification

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

Since: 1.2

See Also:

decodeSpecs

public static RowSpec[] decodeSpecs(String encodedRowSpecs)
Parses and splits encoded row specifications using the default LayoutMap and returns an array of RowSpec objects.

Parameters: encodedRowSpecs comma separated encoded row specifications

Returns: an array of decoded row specifications

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

See Also: RowSpec decode getRoot

decodeSpecs

public static RowSpec[] decodeSpecs(String encodedRowSpecs, LayoutMap layoutMap)
Parses and splits encoded row specifications using the given LayoutMap and returns an array of RowSpec objects.

Parameters: encodedRowSpecs comma separated encoded row specifications layoutMap expands layout row variables

Returns: an array of decoded row specifications

Throws: NullPointerException {@code encodedRowSpecs} or {@code layoutMap} is {@code null}

Since: 1.2

See Also:

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 false} (for vertical)

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