001: /*
002: * Copyright (c) 2002-2007 JGoodies Karsten Lentzsch. All Rights Reserved.
003: *
004: * Redistribution and use in source and binary forms, with or without
005: * modification, are permitted provided that the following conditions are met:
006: *
007: * o Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: *
010: * o Redistributions in binary form must reproduce the above copyright notice,
011: * this list of conditions and the following disclaimer in the documentation
012: * and/or other materials provided with the distribution.
013: *
014: * o Neither the name of JGoodies Karsten Lentzsch nor the names of
015: * its contributors may be used to endorse or promote products derived
016: * from this software without specific prior written permission.
017: *
018: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
019: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
020: * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
021: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
022: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
023: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
024: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
025: * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
026: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
027: * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
028: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029: */
030:
031: package com.jgoodies.forms.layout;
032:
033: import java.util.StringTokenizer;
034:
035: /**
036: * Specifies rows in FormLayout by their default orientation,
037: * start size and resizing behavior.<p>
038: *
039: * <strong>Examples:</strong><br>
040: * The following examples specify a centered row with a size of 14 dlu
041: * that won't grow.
042: * <pre>
043: * new RowSpec(Sizes.dluX(14));
044: * new RowSpec(RowSpec.CENTER, Sizes.dluX(14), 0.0);
045: * new RowSpec(rowSpec.CENTER, Sizes.dluX(14), RowSpec.NO_GROW);
046: * new RowSpec("14dlu");
047: * new RowSpec("14dlu:0");
048: * new RowSpec("center:14dlu:0");
049: * </pre><p>
050: *
051: * The {@link com.jgoodies.forms.factories.FormFactory} provides
052: * predefined frequently used RowSpec instances.
053: *
054: * @author Karsten Lentzsch
055: * @version $Revision: 1.2 $
056: *
057: * @see com.jgoodies.forms.factories.FormFactory
058: */
059:
060: public final class RowSpec extends FormSpec {
061:
062: // Vertical Orientations ************************************************
063:
064: /**
065: * By default put the components in the top.
066: */
067: public static final DefaultAlignment TOP = FormSpec.TOP_ALIGN;
068:
069: /**
070: * By default put the components in the center.
071: */
072: public static final DefaultAlignment CENTER = FormSpec.CENTER_ALIGN;
073:
074: /**
075: * By default put the components in the bottom.
076: */
077: public static final DefaultAlignment BOTTOM = FormSpec.BOTTOM_ALIGN;
078:
079: /**
080: * By default fill the component into the row.
081: */
082: public static final DefaultAlignment FILL = FormSpec.FILL_ALIGN;
083:
084: /**
085: * Unless overridden the default alignment for a row is CENTER.
086: */
087: public static final DefaultAlignment DEFAULT = CENTER;
088:
089: // Instance Creation ****************************************************
090:
091: /**
092: * Constructs a RowSpec from the given default orientation,
093: * size, and resize weight.<p>
094: *
095: * The resize weight must be a non-negative double; you can use
096: * <code>NO_FILL</code> as a convenience value for no resize.
097: *
098: * @param defaultAlignment the row's default alignment
099: * @param size constant size, component size, or bounded size
100: * @param resizeWeight the row's non-negative resize weight
101: * @throws IllegalArgumentException if the size is invalid or
102: * the resize weight is negative
103: */
104: public RowSpec(DefaultAlignment defaultAlignment, Size size,
105: double resizeWeight) {
106: super (defaultAlignment, size, resizeWeight);
107: }
108:
109: /**
110: * Constructs a RowSpec for the given size using the
111: * default alignment, and no resizing.
112: *
113: * @param size constant size, component size, or bounded size
114: * @throws IllegalArgumentException if the size is invalid
115: */
116: public RowSpec(Size size) {
117: super (DEFAULT, size, NO_GROW);
118: }
119:
120: /**
121: * Constructs a RowSpec from the specified encoded
122: * description. The description will be parsed to set initial values.
123: *
124: * @param encodedDescription the encoded description
125: */
126: public RowSpec(String encodedDescription) {
127: super (DEFAULT, encodedDescription);
128: }
129:
130: // Implementing Abstract Behavior ***************************************
131:
132: /**
133: * Returns if this is a horizontal specification (vs. vertical).
134: * Used to distinct between horizontal and vertical dialog units,
135: * which have different conversion factors.
136: *
137: * @return true for horizontal, false for vertical
138: */
139: protected boolean isHorizontal() {
140: return false;
141: }
142:
143: // Parsing and Decoding of Row Descriptions *****************************
144:
145: /**
146: * Parses and splits encoded row specifications and returns
147: * an array of RowSpec objects.
148: *
149: * @param encodedRowSpecs comma separated encoded row specifications
150: * @return an array of decoded row specifications
151: * @throws NullPointerException if the encoded row specifications string
152: * is <code>null</code>
153: *
154: * @see RowSpec#RowSpec(String)
155: */
156: public static RowSpec[] decodeSpecs(String encodedRowSpecs) {
157: if (encodedRowSpecs == null)
158: throw new NullPointerException(
159: "The row specification must not be null.");
160:
161: StringTokenizer tokenizer = new StringTokenizer(
162: encodedRowSpecs, ", ");
163: int rowCount = tokenizer.countTokens();
164: RowSpec[] rowSpecs = new RowSpec[rowCount];
165: for (int i = 0; i < rowCount; i++) {
166: rowSpecs[i] = new RowSpec(tokenizer.nextToken());
167: }
168: return rowSpecs;
169: }
170:
171: }
|