Package com.jgoodies.forms.layout
Class FormSpec
java.lang.Object
com.jgoodies.forms.layout.FormSpec
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
ColumnSpec
,RowSpec
An abstract class that specifies columns and rows in FormLayout
by their default alignment, start size and resizing behavior.
API users will use the subclasses
ColumnSpec
and RowSpec
.Also implements the parser for encoded column and row specifications and provides parser convenience behavior for its subclasses ColumnSpec and RowSpec.
TODO: Consider extracting the parser role to a separate class.
- Version:
- $Revision: 1.22 $
- Author:
- Karsten Lentzsch
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
An ordinal-based serializable typesafe enumeration for the column and row default alignment types. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final double
The default resize weight.static final double
Gives a column or row a fixed size. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
FormSpec
(FormSpec.DefaultAlignment defaultAlignment, Size size, double resizeWeight) Constructs aFormSpec
for the given default alignment, size, and resize weight.protected
FormSpec
(FormSpec.DefaultAlignment defaultAlignment, String encodedDescription) Constructs a FormSpec from the specified encoded description. -
Method Summary
Modifier and TypeMethodDescriptionfinal String
encode()
Returns a short and parseable string representation of this form specification.Returns the default alignment.final double
Returns the current resize weight.final Size
getSize()
Returns the size.final String
Returns a string representation of this form specification.final String
toString()
Returns a string representation of this form specification.
-
Field Details
-
NO_GROW
public static final double NO_GROWGives a column or row a fixed size.- See Also:
-
DEFAULT_GROW
public static final double DEFAULT_GROWThe default resize weight.- See Also:
-
-
Constructor Details
-
FormSpec
Constructs aFormSpec
for the given default alignment, size, and resize weight. The resize weight must be a non-negative double; you can useNONE
as a convenience value for no resize.- Parameters:
defaultAlignment
- the spec's default alignmentsize
- a constant, component or bounded sizeresizeWeight
- the spec resize weight- Throws:
NullPointerException
- if thesize
isnull
IllegalArgumentException
- if theresizeWeight
is negative
-
FormSpec
Constructs a FormSpec from the specified encoded description. The description will be parsed to set initial values.- Parameters:
defaultAlignment
- the default alignmentencodedDescription
- the encoded description
-
-
Method Details
-
getDefaultAlignment
Returns the default alignment.- Returns:
- the default alignment
-
getSize
Returns the size.- Returns:
- the size
-
getResizeWeight
public final double getResizeWeight()Returns the current resize weight.- Returns:
- the resize weight.
-
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.This method does not return an encoded version of this object; the contrary is the case. Many instances will return a string that cannot be parsed.
Note: The string representation may change at any time. For parsing use
encode()
instead. -
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.This method does not return an encoded version of this object; the contrary is the case. Many instances will return a string that cannot be parsed.
Note: The string representation may change at any time. For parsing use
encode()
instead.- Returns:
- a string representation of the form specification.
-
encode
Returns a short and parseable string representation of this form specification. The string will omit the alignment and resize specifications if these are the default values.- Returns:
- a string representation of the form specification.
- Since:
- 1.2
- See Also:
-