com.jgoodies.forms.layout

Class RowSpec

java.lang.Object

com.jgoodies.forms.layout.FormSpec

com.jgoodies.forms.layout.RowSpec

All Implemented Interfaces:

java.io.Serializable

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);
 new RowSpec("14dlu");
 new RowSpec("14dlu:0");
 new RowSpec("center:14dlu:0");
 

The FormFactory provides predefined frequently used RowSpec instances.

Version:

$Revision$

Author:

Karsten Lentzsch

See Also:

FormFactory, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.jgoodies.forms.layout.FormSpec

FormSpec.DefaultAlignment

Field Summary

Fields

Modifier and Type	Field and Description
static FormSpec.DefaultAlignment	BOTTOM By default put the components in the bottom.
static FormSpec.DefaultAlignment	CENTER By default put the components in the center.
static FormSpec.DefaultAlignment	DEFAULT Unless overridden the default alignment for a row is CENTER.
static FormSpec.DefaultAlignment	FILL By default fill the component into the row.
static FormSpec.DefaultAlignment	TOP By default put the components in the top.

Fields inherited from class com.jgoodies.forms.layout.FormSpec

BOTTOM_ALIGN, CENTER_ALIGN, DEFAULT_GROW, FILL_ALIGN, LEFT_ALIGN, NO_GROW, RIGHT_ALIGN, TOP_ALIGN

Constructor Summary

Constructors

Constructor and Description
RowSpec(FormSpec.DefaultAlignment defaultAlignment, Size size, double resizeWeight) Constructs a RowSpec from the given default orientation, size, and resize weight.
RowSpec(Size size) Constructs a RowSpec for the given size using the default alignment, and no resizing.
RowSpec(java.lang.String encodedDescription) Constructs a RowSpec from the specified encoded description.

Method Summary

Modifier and Type	Method and Description
static RowSpec[]	decodeSpecs(java.lang.String encodedRowSpecs) Parses and splits encoded row specifications and returns an array of RowSpec objects.
protected boolean	isHorizontal() Returns if this is a horizontal specification (vs. vertical).

Methods inherited from class com.jgoodies.forms.layout.FormSpec

canGrow, getDefaultAlignment, getResizeWeight, getSize, maximumSize, toShortString, toString

Methods inherited from class java.lang.Object

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

Field Detail

TOP

public static final FormSpec.DefaultAlignment TOP

By default put the components in the top.

CENTER

public static final FormSpec.DefaultAlignment CENTER

By default put the components in the center.

BOTTOM

public static final FormSpec.DefaultAlignment BOTTOM

By default put the components in the bottom.

FILL

public static final FormSpec.DefaultAlignment FILL

By default fill the component into the row.

DEFAULT

public static final FormSpec.DefaultAlignment DEFAULT

Unless overridden the default alignment for a row is CENTER.

Constructor Detail

RowSpec

public RowSpec(FormSpec.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:

java.lang.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:

java.lang.IllegalArgumentException - if the size is invalid

RowSpec

public RowSpec(java.lang.String encodedDescription)

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

Parameters:

encodedDescription - the encoded description

Method Detail

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.

Specified by:

isHorizontal in class FormSpec

Returns:

true for horizontal, false for vertical

decodeSpecs

public static RowSpec[] decodeSpecs(java.lang.String encodedRowSpecs)

Parses and splits encoded row specifications and returns an array of RowSpec objects.

Parameters:

encodedRowSpecs - comma separated encoded row specifications

Returns:

an array of decoded row specifications

Throws:

java.lang.NullPointerException - if the encoded row specifications string is null

See Also:

RowSpec(String)