Package com.jgoodies.forms.layout

Class ColumnSpec

  • All Implemented Interfaces:
    java.io.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:
    FormSpecs, Serialized Form

    • Field Detail

      • 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 java.util.Map<java.lang.String,​ColumnSpec> CACHE
        Maps encoded column specifications to ColumnSpec instances.

    • Constructor Detail

      • 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:
        java.lang.NullPointerException - if the size is null
        java.lang.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:
        java.lang.IllegalArgumentException - if the size is invalid

      • ColumnSpec

        private ColumnSpec​(java.lang.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 Detail

      • 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:
        java.lang.NullPointerException - if gapWidth is null
        Since:
        1.2

      • decode

        public static ColumnSpec decode​(java.lang.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:
        java.lang.NullPointerException - if encodedColumnSpec is null
        Since:
        1.2
        See Also:
        decode(String, LayoutMap), LayoutMap.getRoot()

      • decode

        public static ColumnSpec decode​(java.lang.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:
        java.lang.NullPointerException - if encodedColumnSpec or layoutMap is null
        java.lang.IllegalArgumentException - if encodedColumnSpec is empty or whitespace
        Since:
        1.2
        See Also:
        decodeSpecs(String, LayoutMap)

      • decodeExpanded

        static ColumnSpec decodeExpanded​(java.lang.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​(java.lang.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:
        java.lang.NullPointerException - if encodedColumnSpecs is null
        See Also:
        decodeSpecs(String, LayoutMap), decode(String), LayoutMap.getRoot()

      • decodeSpecs

        public 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.
        Parameters:
        encodedColumnSpecs - comma separated encoded column specifications
        layoutMap - expands layout column variables
        Returns:
        an array of decoded column specifications
        Throws:
        java.lang.NullPointerException - if encodedColumnSpecs or layoutMap is null
        Since:
        1.2
        See Also:
        decodeSpecs(String), decode(String, LayoutMap)

      • 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)