| java.lang.Object
 com.jgoodies.forms.layout.FormSpec
All known Subclasses: com.jgoodies.forms.layout.RowSpec, com.jgoodies.forms.layout.ColumnSpec,
| FormSpec | | abstract public class FormSpec implements Serializable(Code) | | 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 .
author:
Karsten Lentzsch
version:
$Revision: 1.4 $
See Also: ColumnSpec
See Also: RowSpec
See Also: FormLayout
See Also: CellConstraints |
| Inner Class :final public static class DefaultAlignment implements Serializable | |
| Field Summary | |
| final static DefaultAlignment | BOTTOM_ALIGN
By default put the components in the bottom. | | final static DefaultAlignment | CENTER_ALIGN
By default put the components in the center. | | final public static double | DEFAULT_GROW
The default resize weight. | | final static DefaultAlignment | FILL_ALIGN
By default fill the column or row. | | final static DefaultAlignment | LEFT_ALIGN
By default put components in the left. | | final public static double | NO_GROW
Gives a column or row a fixed size. | | final static DefaultAlignment | RIGHT_ALIGN
By default put components in the right. | | final static DefaultAlignment | TOP_ALIGN
By default put the components in the top. |
| Constructor Summary | |
| protected | FormSpec(DefaultAlignment defaultAlignment, Size size, double resizeWeight)
Constructs a FormSpec for the given default alignment,
size, and resize weight. | | protected | FormSpec(DefaultAlignment defaultAlignment, String encodedDescription)
Constructs a FormSpec from the specified encoded
description. |
| Method Summary | |
| final boolean | canGrow()
Checks and answers whether this spec can grow or not. | | final public DefaultAlignment | getDefaultAlignment()
Returns the default alignment. | | final public double | getResizeWeight()
Returns the current resize weight. | | final public Size | getSize()
Returns the size. | | abstract boolean | isHorizontal()
Returns if this is a horizontal specification (vs. | | final int | maximumSize(Container container, List components, FormLayout.Measure minMeasure, FormLayout.Measure prefMeasure, FormLayout.Measure defaultMeasure)
| | final public 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.
This method does not return a decoded version
of this object; the contrary is the case. | | final public 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.
This method does not return a decoded version
of this object; the contrary is the case. |
| BOTTOM_ALIGN | | final static DefaultAlignment BOTTOM_ALIGN(Code) | | By default put the components in the bottom.
|
| CENTER_ALIGN | | final static DefaultAlignment CENTER_ALIGN(Code) | | By default put the components in the center.
|
| DEFAULT_GROW | | final public static double DEFAULT_GROW(Code) | | The default resize weight.
|
| FILL_ALIGN | | final static DefaultAlignment FILL_ALIGN(Code) | | By default fill the column or row.
|
| LEFT_ALIGN | | final static DefaultAlignment LEFT_ALIGN(Code) | | By default put components in the left.
|
| NO_GROW | | final public static double NO_GROW(Code) | | Gives a column or row a fixed size.
|
| RIGHT_ALIGN | | final static DefaultAlignment RIGHT_ALIGN(Code) | | By default put components in the right.
|
| TOP_ALIGN | | final static DefaultAlignment TOP_ALIGN(Code) | | By default put the components in the top.
|
| FormSpec | | protected FormSpec(DefaultAlignment defaultAlignment, Size size, double resizeWeight)(Code) | | Constructs a FormSpec for the given default alignment,
size, and resize weight. The resize weight must be a non-negative
double; you can use NONE as a convenience value for no
resize.
Parameters:
defaultAlignment - the spec's default alignment
Parameters:
size - a constant, component or bounded size
Parameters:
resizeWeight - the spec resize weight
throws:
IllegalArgumentException - if the resize weight is negative |
| FormSpec | | protected FormSpec(DefaultAlignment defaultAlignment, String encodedDescription)(Code) | | Constructs a FormSpec from the specified encoded
description. The description will be parsed to set initial values.
Parameters:
defaultAlignment - the default alignment
Parameters:
encodedDescription - the encoded description |
| canGrow | | final boolean canGrow()(Code) | | Checks and answers whether this spec can grow or not.
That is the case if and only if the resize weight is
!= NO_GROW.
true if it can grow, false if it can't grow |
| getDefaultAlignment | | final public DefaultAlignment getDefaultAlignment()(Code) | | Returns the default alignment.
the default alignment |
| getResizeWeight | | final public double getResizeWeight()(Code) | | Returns the current resize weight.
the resize weight. |
| getSize | | final public Size getSize()(Code) | | Returns the size.
the size |
| isHorizontal | | abstract boolean isHorizontal()(Code) | | Returns if this is a horizontal specification (vs. vertical).
Used to distinct between horizontal and vertical dialog units,
which have different conversion factors.
true for horizontal, false for vertical |
| maximumSize | | final int maximumSize(Container container, List components, FormLayout.Measure minMeasure, FormLayout.Measure prefMeasure, FormLayout.Measure defaultMeasure)(Code) | | Computes the maximum size for the given list of components, using
this form spec and the specified measure.
Invoked by FormLayout to determine the size of one of my elements
Parameters:
container - the layout container
Parameters:
components - the list of components to measure
Parameters:
minMeasure - the measure used to determine the minimum size
Parameters:
prefMeasure - the measure used to determine the preferred size
Parameters:
defaultMeasure - the measure used to determine the default size the maximum size in pixels |
| toShortString | | final public String toShortString()(Code) | | 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 a decoded 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. It is strongly recommended to not use this string
for parsing purposes.
a string representation of the form specification. |
| toString | | final public String toString()(Code) | | 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 a decoded 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. It is strongly recommended to not use this string
for parsing purposes.
a string representation of the form specification. |
|
|