|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jgoodies.forms.layout.FormSpec
com.jgoodies.forms.layout.ColumnSpec
public final class ColumnSpec
Specifies columns in FormLayout by their default orientation, start size and resizing behavior.
Examples:
The following examples specify a column with FILL alignment, a size of
10 dlu that won't grow.
new ColumnSpec(Sizes.dluX(10)); new ColumnSpec(ColumnSpec.FILL, Sizes.dluX(10), 0.0); new ColumnSpec(ColumnSpec.FILL, Sizes.dluX(10), ColumnSpec.NO_GROW); ColumnSpec.parse("10dlu"); ColumnSpec.parse("10dlu:0"); ColumnSpec.parse("fill:10dlu:0");
The FormFactory
provides
predefined frequently used ColumnSpec instances.
FormFactory
,
Serialized FormNested Class Summary |
---|
Nested classes/interfaces inherited from class com.jgoodies.forms.layout.FormSpec |
---|
FormSpec.DefaultAlignment |
Field Summary | |
---|---|
static FormSpec.DefaultAlignment |
CENTER
By default put the components in the center. |
static FormSpec.DefaultAlignment |
DEFAULT
Unless overridden the default alignment for a column is FILL. |
static FormSpec.DefaultAlignment |
FILL
By default fill the component into the column. |
static FormSpec.DefaultAlignment |
LEFT
By default put components in the left. |
static FormSpec.DefaultAlignment |
MIDDLE
By default put components in the middle. |
static FormSpec.DefaultAlignment |
RIGHT
By default put components in the right. |
Fields inherited from class com.jgoodies.forms.layout.FormSpec |
---|
DEFAULT_GROW, NO_GROW |
Constructor Summary | |
---|---|
ColumnSpec(FormSpec.DefaultAlignment defaultAlignment,
Size size,
double resizeWeight)
Constructs a ColumnSpec for the given default alignment, size and resize weight. |
|
ColumnSpec(Size size)
Constructs a ColumnSpec for the given size using the default alignment, and no resizing. |
|
ColumnSpec(java.lang.String encodedDescription)
Deprecated. Replaced by decode(String) |
Method Summary | |
---|---|
static ColumnSpec |
createGap(ConstantSize gapWidth)
Creates and returns a ColumnSpec that represents a gap with the
specified ConstantSize . |
static ColumnSpec |
decode(java.lang.String encodedColumnSpec)
Parses the encoded column specification and returns a ColumnSpec object that represents the string. |
static ColumnSpec |
decode(java.lang.String encodedColumnSpec,
LayoutMap layoutMap)
Parses the encoded column specifications and returns a ColumnSpec object that represents the string. |
static ColumnSpec[] |
decodeSpecs(java.lang.String encodedColumnSpecs)
Parses and splits encoded column specifications using the default LayoutMap and returns an array of ColumnSpec objects. |
static ColumnSpec[] |
decodeSpecs(java.lang.String encodedColumnSpecs,
LayoutMap layoutMap)
Splits and parses the encoded column specifications using the given LayoutMap and returns an array of ColumnSpec objects. |
protected boolean |
isHorizontal()
Returns if this is a horizontal specification (vs. |
Methods inherited from class com.jgoodies.forms.layout.FormSpec |
---|
encode, getDefaultAlignment, getResizeWeight, getSize, toShortString, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final FormSpec.DefaultAlignment LEFT
public static final FormSpec.DefaultAlignment CENTER
public static final FormSpec.DefaultAlignment MIDDLE
public static final FormSpec.DefaultAlignment RIGHT
public static final FormSpec.DefaultAlignment FILL
public static final FormSpec.DefaultAlignment DEFAULT
Constructor Detail |
---|
public ColumnSpec(FormSpec.DefaultAlignment defaultAlignment, Size size, double resizeWeight)
The resize weight must be a non-negative double; you can use
NO_GROW
as a convenience value for no resize.
defaultAlignment
- the column's default alignmentsize
- constant, component size or bounded sizeresizeWeight
- the column's non-negative resize weight
java.lang.NullPointerException
- if the size
is null
java.lang.IllegalArgumentException
- if the size is invalid or
the resizeWeight
is negativepublic ColumnSpec(Size size)
size
- constant size, component size, or bounded size
java.lang.IllegalArgumentException
- if the size is invalidpublic ColumnSpec(java.lang.String encodedDescription)
decode(String)
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.
encodedDescription
- the encoded descriptionMethod Detail |
---|
public static ColumnSpec createGap(ConstantSize gapWidth)
ColumnSpec
that represents a gap with the
specified ConstantSize
.
gapWidth
- specifies the gap width
java.lang.NullPointerException
- if gapWidth
is null
public static ColumnSpec decode(java.lang.String encodedColumnSpec)
encodedColumnSpec
- the encoded column specification
java.lang.NullPointerException
- if encodedColumnSpec
is null
decode(String, LayoutMap)
,
LayoutMap.getRoot()
public static ColumnSpec decode(java.lang.String encodedColumnSpec, LayoutMap layoutMap)
encodedColumnSpec
- the encoded column specificationlayoutMap
- expands layout column variables
java.lang.NullPointerException
- if encodedColumnSpec
or
layoutMap
is null
decodeSpecs(String, LayoutMap)
public static ColumnSpec[] decodeSpecs(java.lang.String encodedColumnSpecs)
LayoutMap
and returns an array of ColumnSpec objects.
encodedColumnSpecs
- comma separated encoded column specifications
java.lang.NullPointerException
- if encodedColumnSpecs
is null
decodeSpecs(String, LayoutMap)
,
decode(String)
,
LayoutMap.getRoot()
public static ColumnSpec[] decodeSpecs(java.lang.String encodedColumnSpecs, LayoutMap layoutMap)
LayoutMap
and returns an array of ColumnSpec objects.
encodedColumnSpecs
- comma separated encoded column specificationslayoutMap
- expands layout column variables
java.lang.NullPointerException
- if encodedColumnSpecs
or
layoutMap
is null
decodeSpecs(String)
,
decode(String, LayoutMap)
protected boolean isHorizontal()
true
(for horizontal)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |