Class ColumnSpec

java.lang.Object
com.jgoodies.forms.layout.FormSpec
com.jgoodies.forms.layout.ColumnSpec
All Implemented Interfaces:
Serializable
public final class ColumnSpec extends FormSpec
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.decode("10dlu");
ColumnSpec.decode("10dlu:0");
ColumnSpec.decode("fill:10dlu:0");

The FormSpecs provides predefined frequently used ColumnSpec instances.

Version:
$Revision: 1.20 $
See Also:

  • Field Details

    • LEFT

      public static final FormSpec.DefaultAlignment LEFT
      By default put components in the left.

    • CENTER

      public static final FormSpec.DefaultAlignment CENTER
      By default put the components in the center.

    • FILL

      public static final FormSpec.DefaultAlignment FILL
      By default fill the component into the column.

    • NONE

      public static final FormSpec.DefaultAlignment NONE
      A special alignment value for table column alignment specifications. Some cell renderers shall not be aligned during the renderer preparation.
      Since:
      1.8

    • DEFAULT

      public static final FormSpec.DefaultAlignment DEFAULT
      Unless overridden the default alignment for a column is FILL.

    • CACHE

      private static final Map<String, ColumnSpec> CACHE
      Maps encoded column specifications to ColumnSpec instances.

  • Constructor Details

    • ColumnSpec

      public ColumnSpec(FormSpec.DefaultAlignment defaultAlignment, Size size, double resizeWeight)
      Constructs a ColumnSpec for the given default alignment, size and resize weight.

      The resize weight must be a non-negative double; you can use NO_GROW as a convenience value for no resize.

      Parameters:
      defaultAlignment - the column's default alignment
      size - constant, component size or bounded size
      resizeWeight - the column's non-negative resize weight
      Throws:
      NullPointerException - if the size is null
      IllegalArgumentException - if the size is invalid or the resizeWeight is negative

    • ColumnSpec

      public ColumnSpec(Size size)
      Constructs a ColumnSpec 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

    • ColumnSpec

      private ColumnSpec(String encodedDescription)
      Constructs a ColumnSpec 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 Details

    • createGap

      public static ColumnSpec createGap(ConstantSize gapWidth)
      Creates and returns a ColumnSpec that represents a gap with the specified ConstantSize.
      Parameters:
      gapWidth - specifies the gap width
      Returns:
      a ColumnSpec that describes a horizontal gap
      Throws:
      NullPointerException - if gapWidth is null
      Since:
      1.2

    • decode

      public static ColumnSpec decode(String encodedColumnSpec)
      Parses the encoded column specification and returns a ColumnSpec object that represents the string. Variables are expanded using the default LayoutMap.
      Parameters:
      encodedColumnSpec - the encoded column specification
      Returns:
      a ColumnSpec instance for the given specification
      Throws:
      NullPointerException - if encodedColumnSpec is null
      Since:
      1.2
      See Also:

    • decode

      public static ColumnSpec decode(String encodedColumnSpec, LayoutMap layoutMap)
      Parses the encoded column specifications and returns a ColumnSpec object that represents the string. Variables are expanded using the given LayoutMap.
      Parameters:
      encodedColumnSpec - the encoded column specification
      layoutMap - expands layout column variables
      Returns:
      a ColumnSpec instance for the given specification
      Throws:
      NullPointerException - if encodedColumnSpec or layoutMap is null
      IllegalArgumentException - if encodedColumnSpec is empty or whitespace
      Since:
      1.2
      See Also:

    • decodeExpanded

      static ColumnSpec decodeExpanded(String expandedTrimmedLowerCaseSpec)
      Decodes an expanded, trimmed, lower case column spec. Called by the public ColumnSpec factory methods. Looks up and returns the ColumnSpec object from the cache - if any, or constructs and returns a new ColumnSpec instance.
      Parameters:
      expandedTrimmedLowerCaseSpec - the encoded column specification
      Returns:
      a ColumnSpec for the given encoded column spec

    • decodeSpecs

      public static ColumnSpec[] decodeSpecs(String encodedColumnSpecs)
      Parses and splits encoded column specifications using the default LayoutMap and returns an array of ColumnSpec objects.
      Parameters:
      encodedColumnSpecs - comma separated encoded column specifications
      Returns:
      an array of decoded column specifications
      Throws:
      NullPointerException - if encodedColumnSpecs is null
      See Also:

    • decodeSpecs

      public static ColumnSpec[] decodeSpecs(String encodedColumnSpecs, LayoutMap layoutMap)
      Splits and parses the encoded column specifications using the given LayoutMap and returns an array of ColumnSpec objects.
      Parameters:
      encodedColumnSpecs - comma separated encoded column specifications
      layoutMap - expands layout column variables
      Returns:
      an array of decoded column specifications
      Throws:
      NullPointerException - if encodedColumnSpecs or layoutMap is null
      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.
      Specified by:
      isHorizontal in class FormSpec
      Returns:
      always true (for horizontal)