com.jgoodies.forms.layout
Class RowSpec

java.lang.Object
  com.jgoodies.forms.layout.RowSpec

public class RowSpec
extends java.lang.Object

Specifies rows in 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: 1.1 $

Author:

Karsten Lentzsch

See Also:

FormFactory

Nested Class Summary

static class

FormSpec.DefaultAlignment A typesafe enumeration for the column and row default alignment types.

Field Summary

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 double	DEFAULT_GROW The default resize weight.
static FormSpec.DefaultAlignment	FILL By default fill the component into the row.
static double	NO_GROW Gives a column or row a fixed size.
static FormSpec.DefaultAlignment	TOP By default put the components in the top.

Constructor Summary

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

RowSpec	asUnmodifyable() Creates and answers an unmodifyable version of this RowSpec.
FormSpec.DefaultAlignment	getDefaultAlignment() Answers the default alignment.
double	getResizeWeight() Answers the current resize weight.
Size	getSize() Returns the size.
void	setDefaultAlignment(FormSpec.DefaultAlignment newDefaultAlignment) Sets the default alignment.
void	setResizeWeight(double weight) Sets a new resize weight.
void	setSize(Size size) Sets the size.
java.lang.String	toShortString() Returns a string representation of this form specification.
java.lang.String	toString() Returns a string representation of this form specification.

Methods inherited from class java.lang.Object

equals, 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.

NO_GROW

public static final double NO_GROW

Gives a column or row a fixed size.

See Also:

Constant Field Values

DEFAULT_GROW

public static final double DEFAULT_GROW

The default resize weight.

See Also:

Constant Field Values

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 - the row's size as value with unit

resizeWeight - the row's resize weight

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 pixel size is invalid or the resize weight is negative

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

asUnmodifyable

public RowSpec asUnmodifyable()

Creates and answers an unmodifyable version of this RowSpec.

Returns:

an unmodifyable version of this RowSpec

getDefaultAlignment

public final FormSpec.DefaultAlignment getDefaultAlignment()

Answers the default alignment.

setDefaultAlignment

public void setDefaultAlignment(FormSpec.DefaultAlignment newDefaultAlignment)

Sets the default alignment.

Parameters:

newDefaultAlignment - the new default alignment

getSize

public final Size getSize()

Returns the size.

Returns:

the size

setSize

public void setSize(Size size)

Sets the size.

Parameters:

size - the new size

getResizeWeight

public final double getResizeWeight()

Answers the current resize weight.

Returns:

the resize weight.

setResizeWeight

public void setResizeWeight(double weight)

Sets a new resize weight.

Parameters:

weight - the new resize weight

toString

public final java.lang.String toString()

Returns a string representation of this form specification. The string representation consists of three elements separated by a colon (":"), first the alignment, second the size, and third the resize spec.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the form specification.

toShortString

public final java.lang.String toShortString()

Returns a string representation of this form specification. The string representation consists of three elements separated by a colon (":"), first the alignment, second the size, and third the resize spec.

Returns:

a string representation of the form specification.