Package com.jgoodies.forms.layout
Class RowSpec
java.lang.Object
com.jgoodies.forms.layout.FormSpec
com.jgoodies.forms.layout.RowSpec
- All Implemented Interfaces:
Serializable
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.17 $
- Author:
- Karsten Lentzsch
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.jgoodies.forms.layout.FormSpec
FormSpec.DefaultAlignment
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final FormSpec.DefaultAlignment
By default put the components in the bottom.static final FormSpec.DefaultAlignment
By default put the components in the center.static final FormSpec.DefaultAlignment
Unless overridden the default alignment for a row is CENTER.static final FormSpec.DefaultAlignment
By default fill the component into the row.static final FormSpec.DefaultAlignment
By default put the components in the top.Fields inherited from class com.jgoodies.forms.layout.FormSpec
DEFAULT_GROW, NO_GROW
-
Constructor Summary
ConstructorsConstructorDescriptionRowSpec
(FormSpec.DefaultAlignment defaultAlignment, Size size, double resizeWeight) Constructs a RowSpec from the given default orientation, size, and resize weight.Constructs a RowSpec for the given size using the default alignment, and no resizing.Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionstatic RowSpec
createGap
(ConstantSize gapHeight) Creates and returns aRowSpec
that represents a gap with the specifiedConstantSize
.static RowSpec
Parses the encoded row specification and returns a RowSpec object that represents the string.static RowSpec
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 defaultLayoutMap
and returns an array of RowSpec objects.static RowSpec[]
decodeSpecs
(String encodedRowSpecs, LayoutMap layoutMap) Parses and splits encoded row specifications using the givenLayoutMap
and returns an array of RowSpec objects.protected boolean
Returns if this is a horizontal specification (vs.Methods inherited from class com.jgoodies.forms.layout.FormSpec
encode, getDefaultAlignment, getResizeWeight, getSize, toShortString, toString
-
Field Details
-
TOP
By default put the components in the top. -
CENTER
By default put the components in the center. -
BOTTOM
By default put the components in the bottom. -
FILL
By default fill the component into the row. -
DEFAULT
Unless overridden the default alignment for a row is CENTER.
-
-
Constructor Details
-
RowSpec
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 alignmentsize
- constant size, component size, or bounded sizeresizeWeight
- the row's non-negative resize weight- Throws:
IllegalArgumentException
- if the size is invalid or the resize weight is negative
-
RowSpec
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
Deprecated.Replaced bydecode(String)
.Constructs a RowSpec from the specified encoded description. The description will be parsed to set initial values.Unlike the factory method
decode(String)
, this constructor does not expand layout variables, and it cannot vend cached objects..Note: This constructor will become private in the next Forms version.
- Parameters:
encodedDescription
- the encoded description
-
-
Method Details
-
createGap
Creates and returns aRowSpec
that represents a gap with the specifiedConstantSize
.- Parameters:
gapHeight
- specifies the gap height- Returns:
- a RowSpec that describes a vertical gap with the given height
- Throws:
NullPointerException
- ifgapHeight
isnull
- Since:
- 1.2
-
decode
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
- ifencodedRowSpec
isnull
- Since:
- 1.2
- See Also:
-
decode
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 specificationlayoutMap
- expands layout row variables- Returns:
- a RowSpec instance for the given specification
- Throws:
NullPointerException
- ifencodedRowSpec
orlayoutMap
isnull
- Since:
- 1.2
- See Also:
-
decodeSpecs
Parses and splits encoded row specifications using the defaultLayoutMap
and returns an array of RowSpec objects.- Parameters:
encodedRowSpecs
- comma separated encoded row specifications- Returns:
- an array of decoded row specifications
- Throws:
NullPointerException
- ifencodedRowSpecs
isnull
- See Also:
-
decodeSpecs
Parses and splits encoded row specifications using the givenLayoutMap
and returns an array of RowSpec objects.- Parameters:
encodedRowSpecs
- comma separated encoded row specificationslayoutMap
- expands layout row variables- Returns:
- an array of decoded row specifications
- Throws:
NullPointerException
-encodedRowSpecs
orlayoutMap
isnull
- 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
false
(for vertical)
-
decode(String)
.