com.jgoodies.forms.layout.ColumnSpec Maven / Gradle / Ivy
/*
* Copyright (c) 2002-2015 JGoodies Software GmbH. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of JGoodies Software GmbH nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.jgoodies.forms.layout;
import static com.jgoodies.common.base.Preconditions.checkNotBlank;
import static com.jgoodies.common.base.Preconditions.checkNotNull;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
/**
* 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 {@link com.jgoodies.forms.layout.FormSpecs} provides
* predefined frequently used ColumnSpec instances.
*
* @author Karsten Lentzsch
* @version $Revision: 1.20 $
*
* @see com.jgoodies.forms.layout.FormSpecs
*/
public final class ColumnSpec extends FormSpec {
// Horizontal Orientations *********************************************
/**
* By default put components in the left.
*/
public static final DefaultAlignment LEFT = FormSpec.LEFT_ALIGN;
/**
* By default put the components in the center.
*/
public static final DefaultAlignment CENTER = FormSpec.CENTER_ALIGN;
/**
* By default put components in the right.
*/
public static final DefaultAlignment RIGHT = FormSpec.RIGHT_ALIGN;
/**
* By default fill the component into the column.
*/
public static final DefaultAlignment FILL = FormSpec.FILL_ALIGN;
/**
* A special alignment value for table column alignment specifications.
* Some cell renderers shall not be aligned during the renderer
* preparation.
*
* @since 1.8
*/
public static final DefaultAlignment NONE = FormSpec.NO_ALIGN;
/**
* Unless overridden the default alignment for a column is FILL.
*/
public static final DefaultAlignment DEFAULT = FILL;
// Cache ******************************************************************
/**
* Maps encoded column specifications to ColumnSpec instances.
*/
private static final Map CACHE =
new HashMap();
// Instance Creation ****************************************************
/**
* Constructs a ColumnSpec for the given default alignment,
* size and resize weight.
*
* The resize weight must be a non-negative double; you can use
* {@code NO_GROW} as a convenience value for no resize.
*
* @param defaultAlignment the column's default alignment
* @param size constant, component size or bounded size
* @param resizeWeight the column's non-negative resize weight
*
* @throws NullPointerException if the {@code size} is {@code null}
* @throws IllegalArgumentException if the size is invalid or
* the {@code resizeWeight} is negative
*/
public ColumnSpec(DefaultAlignment defaultAlignment,
Size size,
double resizeWeight) {
super(defaultAlignment, size, resizeWeight);
}
/**
* Constructs a ColumnSpec for the given size using the
* default alignment, and no resizing.
*
* @param size constant size, component size, or bounded size
* @throws IllegalArgumentException if the size is invalid
*/
public ColumnSpec(Size size) {
super(DEFAULT, size, NO_GROW);
}
/**
* Constructs a ColumnSpec from the specified encoded description.
* The description will be parsed to set initial values.
*
* Unlike the factory method {@link #decode(String)}, this constructor
* does not expand layout variables, and it cannot vend cached objects.
*
* @param encodedDescription the encoded description
*/
private ColumnSpec(String encodedDescription) {
super(DEFAULT, encodedDescription);
}
// Factory Methods ********************************************************
/**
* Creates and returns a {@link ColumnSpec} that represents a gap with the
* specified {@link ConstantSize}.
*
* @param gapWidth specifies the gap width
* @return a ColumnSpec that describes a horizontal gap
*
* @throws NullPointerException if {@code gapWidth} is {@code null}
*
* @since 1.2
*/
public static ColumnSpec createGap(ConstantSize gapWidth) {
return new ColumnSpec(DEFAULT, gapWidth, FormSpec.NO_GROW);
}
/**
* Parses the encoded column specification and returns a ColumnSpec object
* that represents the string. Variables are expanded using the default
* LayoutMap.
*
* @param encodedColumnSpec the encoded column specification
*
* @return a ColumnSpec instance for the given specification
* @throws NullPointerException if {@code encodedColumnSpec} is {@code null}
*
* @see #decode(String, LayoutMap)
* @see LayoutMap#getRoot()
*
* @since 1.2
*/
public static ColumnSpec decode(String encodedColumnSpec) {
return decode(encodedColumnSpec, LayoutMap.getRoot());
}
/**
* Parses the encoded column specifications and returns a ColumnSpec object
* that represents the string. Variables are expanded using the given
* LayoutMap.
*
* @param encodedColumnSpec the encoded column specification
* @param layoutMap expands layout column variables
*
* @return a ColumnSpec instance for the given specification
* @throws NullPointerException if {@code encodedColumnSpec} or
* {@code layoutMap} is {@code null}
* @throws IllegalArgumentException if {@code encodedColumnSpec} is empty
* or whitespace
*
* @see #decodeSpecs(String, LayoutMap)
*
* @since 1.2
*/
public static ColumnSpec decode(String encodedColumnSpec, LayoutMap layoutMap) {
checkNotBlank(encodedColumnSpec,
"The encoded column specification must not be null, empty or whitespace.");
checkNotNull(layoutMap, "The LayoutMap must not be null.");
String trimmed = encodedColumnSpec.trim();
String lower = trimmed.toLowerCase(Locale.ENGLISH);
return decodeExpanded(layoutMap.expand(lower, true));
}
/**
* 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.
*
* @param expandedTrimmedLowerCaseSpec the encoded column specification
* @return a ColumnSpec for the given encoded column spec
*/
static ColumnSpec decodeExpanded(String expandedTrimmedLowerCaseSpec) {
ColumnSpec spec = CACHE.get(expandedTrimmedLowerCaseSpec);
if (spec == null) {
spec = new ColumnSpec(expandedTrimmedLowerCaseSpec);
CACHE.put(expandedTrimmedLowerCaseSpec, spec);
}
return spec;
}
/**
* Parses and splits encoded column specifications using the default
* {@link LayoutMap} and returns an array of ColumnSpec objects.
*
* @param encodedColumnSpecs comma separated encoded column specifications
* @return an array of decoded column specifications
* @throws NullPointerException if {@code encodedColumnSpecs} is {@code null}
*
* @see #decodeSpecs(String, LayoutMap)
* @see #decode(String)
* @see LayoutMap#getRoot()
*/
public static ColumnSpec[] decodeSpecs(String encodedColumnSpecs) {
return decodeSpecs(encodedColumnSpecs, LayoutMap.getRoot());
}
/**
* Splits and parses the encoded column specifications using the given
* {@link LayoutMap} and returns an array of ColumnSpec objects.
*
* @param encodedColumnSpecs comma separated encoded column specifications
* @param layoutMap expands layout column variables
* @return an array of decoded column specifications
* @throws NullPointerException if {@code encodedColumnSpecs} or
* {@code layoutMap} is {@code null}
*
* @see #decodeSpecs(String)
* @see #decode(String, LayoutMap)
*
* @since 1.2
*/
public static ColumnSpec[] decodeSpecs(String encodedColumnSpecs, LayoutMap layoutMap) {
return FormSpecParser.parseColumnSpecs(encodedColumnSpecs, layoutMap);
}
// Implementing Abstract Behavior ***************************************
/**
* Returns if this is a horizontal specification (vs. vertical).
* Used to distinct between horizontal and vertical dialog units,
* which have different conversion factors.
*
* @return always {@code true} (for horizontal)
*/
@Override
protected boolean isHorizontal() {
return true;
}
}