Package 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); RowSpec.parse("14dlu"); RowSpec.parse("14dlu:0"); RowSpec.parse("center:14dlu:0");
The
FormSpecs
provides predefined frequently used RowSpec instances.- Version:
- $Revision: 1.20 $
- See Also:
FormSpecs
, 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 Description static FormSpec.DefaultAlignment
BOTTOM
By default put the components in the bottom.private static java.util.Map<java.lang.String,RowSpec>
CACHE
Maps encoded row specifications to RowSpec instances.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_ALIGN, NO_GROW, RIGHT_ALIGN, TOP_ALIGN
-
-
Constructor Summary
Constructors Modifier Constructor 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.private
RowSpec(java.lang.String encodedDescription)
Constructs a RowSpec from the specified encoded description.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RowSpec
createGap(ConstantSize gapHeight)
Creates and returns aRowSpec
that represents a gap with the specifiedConstantSize
.static RowSpec
decode(java.lang.String encodedRowSpec)
Parses the encoded row specification and returns a RowSpec object that represents the string.static RowSpec
decode(java.lang.String encodedRowSpec, LayoutMap layoutMap)
Parses the encoded row specifications and returns a RowSpec object that represents the string.(package private) static RowSpec
decodeExpanded(java.lang.String expandedTrimmedLowerCaseSpec)
Decodes an expanded, trimmed, lower case row spec.static RowSpec[]
decodeSpecs(java.lang.String encodedRowSpecs)
Parses and splits encoded row specifications using the defaultLayoutMap
and returns an array of RowSpec objects.static RowSpec[]
decodeSpecs(java.lang.String encodedRowSpecs, LayoutMap layoutMap)
Parses and splits encoded row specifications using the givenLayoutMap
and returns an array of RowSpec objects.protected boolean
isHorizontal()
Returns if this is a horizontal specification (vs.-
Methods inherited from class com.jgoodies.forms.layout.FormSpec
canGrow, encode, getDefaultAlignment, getDefaultAlignmentExplictlySet, getResizeWeight, getSize, maximumSize, setDefaultAlignment, setResizeWeight, setSize, toShortString, toString
-
-
-
-
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.
-
CACHE
private static final java.util.Map<java.lang.String,RowSpec> CACHE
Maps encoded row specifications to RowSpec instances.
-
-
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 alignmentsize
- constant size, component size, or bounded sizeresizeWeight
- 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
private RowSpec(java.lang.String encodedDescription)
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.- Parameters:
encodedDescription
- the encoded description
-
-
Method Detail
-
createGap
public static RowSpec createGap(ConstantSize gapHeight)
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:
java.lang.NullPointerException
- ifgapHeight
isnull
- Since:
- 1.2
-
decode
public static RowSpec decode(java.lang.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:
java.lang.NullPointerException
- ifencodedRowSpec
isnull
- Since:
- 1.2
- See Also:
decode(String, LayoutMap)
,LayoutMap.getRoot()
-
decode
public static RowSpec decode(java.lang.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 specificationlayoutMap
- expands layout row variables- Returns:
- a RowSpec instance for the given specification
- Throws:
java.lang.NullPointerException
- ifencodedRowSpec
orlayoutMap
isnull
- Since:
- 1.2
- See Also:
decodeSpecs(String, LayoutMap)
-
decodeExpanded
static RowSpec decodeExpanded(java.lang.String expandedTrimmedLowerCaseSpec)
Decodes an expanded, trimmed, lower case row spec. Called by the public RowSpec factory methods. Looks up and returns the RowSpec object from the cache - if any, or constructs and returns a new RowSpec instance.- Parameters:
expandedTrimmedLowerCaseSpec
- the encoded column specification- Returns:
- a RowSpec for the given encoded row spec
-
decodeSpecs
public static RowSpec[] decodeSpecs(java.lang.String encodedRowSpecs)
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:
java.lang.NullPointerException
- ifencodedRowSpecs
isnull
- See Also:
decodeSpecs(String, LayoutMap)
,decode(String)
,LayoutMap.getRoot()
-
decodeSpecs
public static RowSpec[] decodeSpecs(java.lang.String encodedRowSpecs, LayoutMap layoutMap)
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:
java.lang.NullPointerException
-encodedRowSpecs
orlayoutMap
isnull
- Since:
- 1.2
- See Also:
RowSpec(String)
-
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 classFormSpec
- Returns:
- always
false
(for vertical)
-
-