Logo Search packages:      
Sourcecode: libjgoodies-forms-java version File versions  Download package

CellConstraints.java

/*
 * Copyright (c) 2002-2004 JGoodies Karsten Lentzsch. 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 Karsten Lentzsch 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 java.awt.Component;
import java.awt.Insets;
import java.awt.Rectangle;
import java.io.Serializable;
import java.util.StringTokenizer;

/**
 * Defines constraints for components that are layed out with the FormLayout.
 * Defines the components display area: grid x, grid y, 
 * grid width (column span), grid height (row span), horizontal alignment 
 * and vertical alignment.<p>
 * 
 * Most methods return <em>this</em> object to enable method chaining.<p>
 * 
 * You can set optional insets in a constructor. This is useful if you
 * need to use a pixel-size insets to align perceived component bounds
 * with pixel data, for example an icon. Anyway, this is rarely used.
 * The insets don't affect the size computation for columns and rows.
 * I consider renaming the insets to offsets to better indicate the
 * motivation for this option.<p>
 * 
 * <strong>Examples</strong>:<br>
 * The following cell constraints locate a component in the third
 * column of the fifth row; column and row span are 1; the component
 * will be aligned with the column's right-hand side and the row's
 * bottom.
 * <pre>
 * CellConstraints cc = new CellConstraints();
 * cc.xy  (3, 5);
 * cc.xy  (3, 5, CellConstraints.RIGHT, CellConstraints.BOTTOM);
 * cc.xy  (3, 5, "right, bottom");
 * 
 * cc.xyw (3, 5, 1);
 * cc.xyw (3, 5, 1, CellConstraints.RIGHT, CellConstraints.BOTTOM);
 * cc.xyw (3, 5, 1, "right, bottom");
 *  
 * cc.xywh(3, 5, 1, 1);
 * cc.xywh(3, 5, 1, 1, CellConstraints.RIGHT, CellConstraints.BOTTOM);
 * cc.xywh(3, 5, 1, 1, "right, bottom"); 
 * </pre>
 * See also the examples in the {@link FormLayout} class comment.<p>
 * 
 * TODO: Consider renaming the inset to offsets.
 *
 * @author  Karsten Lentzsch
 * @version $Revision: 1.13 $
 */
00080 public final class CellConstraints implements Cloneable, Serializable {
    
    // Alignment Constants *************************************************
    
    /*
     * Implementation Note: Do not change the order of the following constants.
     * The serialization of class Alignment is ordinal-based and relies on it.
     */
    
    /**
     * Use the column's or row's default alignment.
     */
00092     public static final Alignment DEFAULT =
        new Alignment("default", Alignment.BOTH);

    /**
     * Fill the cell either horizontally or vertically.
     */
00098     public static final Alignment FILL = 
        new Alignment("fill", Alignment.BOTH);

    /**
     * Put the component in the left.
     */
00104     public static final Alignment LEFT =
        new Alignment("left", Alignment.HORIZONTAL);

    /**
     * Put the component in the right.
     */
00110     public static final Alignment RIGHT =
        new Alignment("right", Alignment.HORIZONTAL);
    
    /**
     * Put the component in the center.
     */
00116     public static final Alignment CENTER =
        new Alignment("center", Alignment.BOTH);

    /**
     * Put the component in the top.
     */
00122     public static final Alignment TOP =
        new Alignment("top", Alignment.VERTICAL);

    /**
     * Put the component in the bottom.
     */
00128     public static final Alignment BOTTOM =
        new Alignment("bottom", Alignment.VERTICAL);

    /**
     * An array of all enumeration values used to canonicalize 
     * deserialized alignments.
     */
00135     private static final Alignment[] VALUES = 
        { DEFAULT, FILL, LEFT, RIGHT, CENTER, TOP, BOTTOM };
    
    /**
     * A reusable <code>Insets</code> object to reduce object instantiation.
     */
00141     private static final Insets EMPTY_INSETS = 
        new Insets(0, 0, 0, 0);
    
    
    // Fields ***************************************************************
    
    /**
     * Describes the component's horizontal grid origin (starts at 1).
     */
00150     public int gridX;

    /**
     * Describes the component's vertical grid origin (starts at 1).
     */
00155     public int gridY;

    /**
     * Describes the component's horizontal grid extend (number of cells).
     */
00160     public int gridWidth;

    /**
     * Describes the component's vertical grid extent (number of cells).
     */
00165     public int gridHeight;
    
    /**
     * Describes the component's horizontal alignment.
     */
00170     public Alignment hAlign;
    
    /**
     * Describes the component's vertical alignment.
     */
00175     public Alignment vAlign;
    
    /**
     * Describes the component's <code>Insets</code> in it's display area.
     */
00180     public Insets insets;
    
    
    // Instance Creation ****************************************************
    
    /**
     * Constructs a default instance of <code>CellConstraints</code>.
     */
00188     public CellConstraints() {
        this(1, 1);
    }
    

    /**
     * Constructs an instance of <code>CellConstraints</code> for the given
     * cell position.<p>
     * 
     * <strong>Examples:</strong><pre>
     * new CellConstraints(1, 3);
     * new CellConstraints(1, 3);
     * </pre>
     * 
     * @param gridX     the component's horizontal grid origin
     * @param gridY     the component's vertical grid origin
     */
00205     public CellConstraints(int gridX, int gridY) {
        this(gridX, gridY, 1, 1);
    }
    

    /**
     * Constructs an instance of <code>CellConstraints</code> for the given
     * cell position, anchor, and fill.<p>
     * 
     * <strong>Examples:</strong><pre>
     * new CellConstraints(1, 3, CellConstraints.LEFT,   CellConstraints.BOTTOM);
     * new CellConstraints(1, 3, CellConstraints.CENTER, CellConstraints.FILL);
     * </pre>
     * 
     * @param gridX     the component's horizontal grid origin
     * @param gridY     the component's vertical grid origin
     * @param hAlign    the component's horizontal alignment
     * @param vAlign    the component's vertical alignment
     */
00224     public CellConstraints(int gridX, int gridY, 
                            Alignment hAlign, Alignment vAlign) {
        this(gridX, gridY, 1, 1, hAlign, vAlign, EMPTY_INSETS);
    }

    
    /**
     * Constructs an instance of <code>CellConstraints</code> for the given
     * cell position and size.<p>
     * 
     * <strong>Examples:</strong><pre>
     * new CellConstraints(1, 3, 2, 1);
     * new CellConstraints(1, 3, 7, 3);
     * </pre>
     * 
     * @param gridX           the component's horizontal grid origin
     * @param gridY           the component's vertical grid origin
     * @param gridWidth the component's horizontal extent
     * @param gridHeight      the component's vertical extent
     */
00244     public CellConstraints(int gridX, int gridY, int gridWidth, int gridHeight) {
        this(gridX, gridY, gridWidth, gridHeight, DEFAULT, DEFAULT);
    }
    

    /**
     * Constructs an instance of <code>CellConstraints</code> for the given
     * cell position and size, anchor, and fill.<p>
     * 
     * <strong>Examples:</strong><pre>
     * new CellConstraints(1, 3, 2, 1, CellConstraints.LEFT,   CellConstraints.BOTTOM);
     * new CellConstraints(1, 3, 7, 3, CellConstraints.CENTER, CellConstraints.FILL);
     * </pre>
     * 
     * @param gridX           the component's horizontal grid origin
     * @param gridY           the component's vertical grid origin
     * @param gridWidth the component's horizontal extent
     * @param gridHeight      the component's vertical extent
     * @param hAlign          the component's horizontal alignment
     * @param vAlign          the component's vertical alignment
     */
00265     public CellConstraints(int gridX, int gridY, int gridWidth, int gridHeight,
                            Alignment hAlign, Alignment vAlign) {
        this(gridX, gridY, gridWidth, gridHeight, hAlign, vAlign, EMPTY_INSETS);
    }
    

    /**
     * Constructs an instance of <code>CellConstraints</code> for 
     * the complete set of available properties.<p>
     * 
     * <strong>Examples:</strong><pre>
     * new CellConstraints(1, 3, 2, 1, CellConstraints.LEFT,   CellConstraints.BOTTOM, new Insets(0, 1, 0, 3));
     * new CellConstraints(1, 3, 7, 3, CellConstraints.CENTER, CellConstraints.FILL,   new Insets(0, 1, 0, 0));
     * </pre>
     * 
     * @param gridX           the component's horizontal grid origin
     * @param gridY           the component's vertical grid origin
     * @param gridWidth       the component's horizontal extent
     * @param gridHeight      the component's vertical extent
     * @param hAlign          the component's horizontal alignment
     * @param vAlign          the component's vertical alignment
     * @param insets          the component's display area <code>Insets</code>
     * @throws IndexOutOfBoundsException if the grid origin or extent is negative
     * @throws NullPointerException if the horizontal or vertical alignment is null
     * @throws IllegalArgumentException if an alignment orientation is invalid
     */
00291     public CellConstraints(int gridX, int gridY, int gridWidth, int gridHeight, 
                            Alignment hAlign, Alignment vAlign, Insets insets) {
            this.gridX      = gridX;
        this.gridY      = gridY;
        this.gridWidth  = gridWidth;
        this.gridHeight = gridHeight;
        this.hAlign     = hAlign;
        this.vAlign     = vAlign;
        this.insets     = insets;
        if (gridX <= 0)
            throw new IndexOutOfBoundsException("The grid x must be a positive number.");
        if (gridY <= 0)
            throw new IndexOutOfBoundsException("The grid y must be a positive number.");
        if (gridWidth <= 0)
            throw new IndexOutOfBoundsException("The grid width must be a positive number.");
        if (gridHeight <= 0)
            throw new IndexOutOfBoundsException("The grid height must be a positive number.");
        if (hAlign == null)
            throw new NullPointerException("The horizontal alignment must not be null.");
        if (vAlign == null)
            throw new NullPointerException("The vertical alignment must not be null.");
        ensureValidOrientations(hAlign, vAlign);
    }
    
    
    /**
     * Constructs an instance of <code>CellConstraints</code> from
     * the given encoded string properties.<p>
     * 
     * <strong>Examples:</strong><pre>
     * new CellConstraints("1, 3");
     * new CellConstraints("1, 3, left, bottom");
     * new CellConstraints("1, 3, 2, 1, left, bottom");
     * new CellConstraints("1, 3, 2, 1, l, b");
     * </pre>
     * 
     * @param encodedConstraints    the constraints encoded as string
     */
00329     public CellConstraints(String encodedConstraints) {
        this();
        initFromConstraints(encodedConstraints);
    }        
      

    // Setters **************************************************************

    /**
     * Sets row and column origins; sets width and height to 1; 
     * uses the default alignments.<p>
     * 
     * <strong>Examples:</strong><pre>
     * cc.xy(1, 1);
     * cc.xy(1, 3);
     * </pre>
     * 
     * @param col     the new column index
     * @param row     the new row index
     * @return this
     */
00350     public CellConstraints xy(int col, int row) {
        return xywh(col, row, 1, 1);
    }
    
      
    /**
     * Sets row and column origins; sets width and height to 1; 
     * decodes horizontal and vertical alignments from the given string.<p>
     * 
     * <strong>Examples:</strong><pre>
     * cc.xy(1, 3, "left, bottom");
     * cc.xy(1, 3, "l, b");
     * cc.xy(1, 3, "center, fill");
     * cc.xy(1, 3, "c, f");
     * </pre>
     * 
     * @param col                the new column index
     * @param row                the new row index
     * @param encodedAlignments  describes the horizontal and vertical alignments
     * @return this
     * @throws IllegalArgumentException if an alignment orientation is invalid
     */
00372     public CellConstraints xy(int col, int row, String encodedAlignments) {
        return xywh(col, row, 1, 1, encodedAlignments);
    }

    /**
     * Sets the row and column origins; sets width and height to 1;
     * set horizontal and vertical alignment using the specified objects.<p>
     * 
     * <strong>Examples:</strong><pre>
     * cc.xy(1, 3, CellConstraints.LEFT,   CellConstraints.BOTTOM);
     * cc.xy(1, 3, CellConstraints.CENTER, CellConstraints.FILL);
     * </pre>
     *
     * @param col       the new column index
     * @param row       the new row index
     * @param colAlign  horizontal component alignment
     * @param rowAlign  vertical component alignment     
     * @return this
     */
00391     public CellConstraints xy(int col, int row, 
                              Alignment colAlign, Alignment rowAlign) {
        return xywh(col, row, 1, 1, colAlign, rowAlign);
    }
    

    /**
     * Sets the row, column, width, and height; uses a height (row span) of 1 
     * and the horizontal and vertical default alignments.<p>
     * 
     * <strong>Examples:</strong><pre>
     * cc.xyw(1, 3, 7);
     * cc.xyw(1, 3, 2);
     * </pre>
     * 
     * @param col      the new column index
     * @param row      the new row index
     * @param colSpan  the column span or grid width
     * @return this
     */
00411     public CellConstraints xyw(int col, int row, int colSpan) {
        return xywh(col, row, colSpan, 1, DEFAULT, DEFAULT);
    }
      

    /**
     * Sets the row, column, width, and height; 
     * decodes the horizontal and vertical alignments from the given string.
     * The row span (height) is set to 1.<p>
     * 
     * <strong>Examples:</strong><pre>
     * cc.xyw(1, 3, 7, "left, bottom");
     * cc.xyw(1, 3, 7, "l, b");
     * cc.xyw(1, 3, 2, "center, fill");
     * cc.xyw(1, 3, 2, "c, f");
     * </pre>
     *  
     * @param col                the new column index
     * @param row                the new row index
     * @param colSpan            the column span or grid width
     * @param encodedAlignments  describes the horizontal and vertical alignments
     * @return this
     * @throws IllegalArgumentException if an alignment orientation is invalid
     */
00435     public CellConstraints xyw(int col, int row, int colSpan,  
                                 String encodedAlignments) {
        return xywh(col, row, colSpan, 1, encodedAlignments);
    }

    
    /**
     * Sets the row, column, width, and height; sets the horizontal 
     * and vertical aligment using the specified alignment objects.
     * The row span (height) is set to 1.<p>
     * 
     * <strong>Examples:</strong><pre>
     * cc.xyw(1, 3, 2, CellConstraints.LEFT,   CellConstraints.BOTTOM);
     * cc.xyw(1, 3, 7, CellConstraints.CENTER, CellConstraints.FILL);
     * </pre>
     *
     * @param col       the new column index
     * @param row       the new row index
     * @param colSpan   the column span or grid width
     * @param colAlign  horizontal component alignment
     * @param rowAlign  vertical component alignment     
     * @return this
     * @throws IllegalArgumentException if an alignment orientation is invalid
     */
00459     public CellConstraints xyw(int col, int row, int colSpan, 
                                 Alignment colAlign, Alignment rowAlign) {
        return xywh(col, row, colSpan, 1, colAlign, rowAlign);
    }
    

    /**
     * Sets the row, column, width, and height; uses default alignments.<p>
     * 
     * <strong>Examples:</strong><pre>
     * cc.xywh(1, 3, 2, 1);
     * cc.xywh(1, 3, 7, 3);
     * </pre>
     * 
     * @param col      the new column index
     * @param row      the new row index
     * @param colSpan  the column span or grid width
     * @param rowSpan  the row span or grid height
     * @return this
     */
00479     public CellConstraints xywh(int col, int row, int colSpan, int rowSpan) {
        return xywh(col, row, colSpan, rowSpan, DEFAULT, DEFAULT);
    }
    

    /**
     * Sets the row, column, width, and height; 
     * decodes the horizontal and vertical alignments from the given string.<p>
     * 
     * <strong>Examples:</strong><pre>
     * cc.xywh(1, 3, 2, 1, "left, bottom");
     * cc.xywh(1, 3, 2, 1, "l, b");
     * cc.xywh(1, 3, 7, 3, "center, fill");
     * cc.xywh(1, 3, 7, 3, "c, f");
     * </pre>
     *  
     * @param col                the new column index
     * @param row                the new row index
     * @param colSpan            the column span or grid width
     * @param rowSpan            the row span or grid height
     * @param encodedAlignments  describes the horizontal and vertical alignments
     * @return this
     * @throws IllegalArgumentException if an alignment orientation is invalid
     */
00503     public CellConstraints xywh(int col, int row, int colSpan, int rowSpan, 
                                 String encodedAlignments) {
        CellConstraints result = xywh(col, row, colSpan, rowSpan);
        result.setAlignments(encodedAlignments);
        return result;
    }

    
    /**
     * Sets the row, column, width, and height; sets the horizontal 
     * and vertical aligment using the specified alignment objects.<p>
     * 
     * <strong>Examples:</strong><pre>
     * cc.xywh(1, 3, 2, 1, CellConstraints.LEFT,   CellConstraints.BOTTOM);
     * cc.xywh(1, 3, 7, 3, CellConstraints.CENTER, CellConstraints.FILL);
     * </pre>
     *
     * @param col       the new column index
     * @param row       the new row index
     * @param colSpan   the column span or grid width
     * @param rowSpan   the row span or grid height
     * @param colAlign  horizontal component alignment
     * @param rowAlign  vertical component alignment     
     * @return this
     * @throws IllegalArgumentException if an alignment orientation is invalid
     */
00529     public CellConstraints xywh(int col, int row, int colSpan, int rowSpan, 
                                 Alignment colAlign, Alignment rowAlign) {
        this.gridX      = col;
        this.gridY      = row;
        this.gridWidth  = colSpan;
        this.gridHeight = rowSpan;
        this.hAlign     = colAlign;
        this.vAlign     = rowAlign;
        ensureValidOrientations(hAlign, vAlign);
        return this;
    }
    

    // Parsing and Decoding String Descriptions *****************************
    
    /**
     * Decodes and returns the grid bounds and alignments for this 
     * constraints as an array of six integers. The string representation
     * is a comma separated sequence, one of
     * <pre>
     * "x, y"
     * "x, y, w, h"
     * "x, y, hAlign, vAlign"
     * "x, y, w, h, hAlign, vAlign"
     * </pre> 
     * 
     * @param encodedConstraints represents horizontal and vertical alignment
     * @throws IllegalArgumentException if the encoded constraints do not
     *     follow the constraint syntax
     */
00559     private void initFromConstraints(String encodedConstraints) {
        StringTokenizer tokenizer = new StringTokenizer(encodedConstraints, " ,");
        int argCount = tokenizer.countTokens();
        if (!(argCount == 2 || argCount == 4 || argCount == 6))
           throw new IllegalArgumentException(
                    "You must provide 2, 4 or 6 arguments.");
        
        Integer nextInt = decodeInt(tokenizer.nextToken());
        if (nextInt == null) { 
            throw new IllegalArgumentException(
                    "First cell constraint element must be a number.");
        }
        gridX = nextInt.intValue();
        if (gridX <= 0)
            throw new IndexOutOfBoundsException("The grid x must be a positive number.");
            
        nextInt = decodeInt(tokenizer.nextToken());
        if (nextInt == null) {
            throw new IllegalArgumentException(
                    "Second cell constraint element must be a number.");
        }
        gridY = nextInt.intValue();
        if (gridY <= 0)
            throw new IndexOutOfBoundsException(
                    "The grid y must be a positive number.");

        if (!tokenizer.hasMoreTokens())
            return;
            
        String token = tokenizer.nextToken();
        nextInt = decodeInt(token);
        if (nextInt != null) {
            // Case: "x, y, w, h" or
            //       "x, y, w, h, hAlign, vAlign"
            gridWidth = nextInt.intValue();
            if (gridWidth <= 0)
                throw new IndexOutOfBoundsException(
                    "The grid width must be a positive number.");
            nextInt = decodeInt(tokenizer.nextToken());
            if (nextInt == null)
                throw new IllegalArgumentException(
                    "Fourth cell constraint element must be like third.");
            gridHeight = nextInt.intValue();
            if (gridHeight <= 0)
                throw new IndexOutOfBoundsException(
                    "The grid height must be a positive number.");

            if (!tokenizer.hasMoreTokens())
                return;
            token = tokenizer.nextToken();
        }
            
        hAlign = decodeAlignment(token);
        vAlign = decodeAlignment(tokenizer.nextToken());
        ensureValidOrientations(hAlign, vAlign);
    }
    
    
    /**
     * Decodes a string description for the horizontal and vertical 
     * alignment and set the alignment values.
     * <p>
     * Valid horizontal aligmnents are: left, middle, right, default, and fill.
     * Valid vertical alignments are: top, center, bottom, default, and fill.
     * The anchor's string representation abbreviates the alignment:
     * l, m, r, d, f, t, c, and b. 
     * <p>
     * Anchor examples:
     * "mc" is centered, "lt" is northwest, "mt" is north, "rc" east.
     * "md" is horizontally centered and uses the row's default alignment.
     * "dt" is on top of the cell and uses the column's default alignment.
     * <p>
     *
     * @param encodedAlignments represents horizontal and vertical alignment
     * @throws IllegalArgumentException if an alignment orientation is invalid
     */
00635     private void setAlignments(String encodedAlignments) {
        StringTokenizer tokenizer = new StringTokenizer(encodedAlignments, " ,");
        hAlign = decodeAlignment(tokenizer.nextToken());
        vAlign = decodeAlignment(tokenizer.nextToken());
        ensureValidOrientations(hAlign, vAlign);
    }
    

    /**
     * Decodes an integer string representation and returns the
     * associated Integer or null in case of an invalid number format.
     * 
     * @param token           the encoded integer
     * @return the decoded Integer or null
     */
00650     private Integer decodeInt(String token) {
        try {
            return Integer.decode(token);
        } catch (NumberFormatException e) {
            return null;
        }
    }
    
    
    /**
     * Parses an alignment string description and 
     * returns the corresponding alignment value.
     * 
     * @param encodedAlignment      the encoded alignment
     * @return the associated <code>Alignment</code> instance
     */
00666     private Alignment decodeAlignment(String encodedAlignment) {
        return Alignment.valueOf(encodedAlignment);
    }

    
    /**
     * Checks and verifies that this constraints object has valid grid 
     * index values, i. e. the display area cells are inside the form's grid. 
     * 
     * @param colCount  number of columns in the grid
     * @param rowCount  number of rows in the grid
     * @throws IndexOutOfBoundsException if the display area described
     *     by this constraints object is not inside the grid
     */
00680     void ensureValidGridBounds(int colCount, int rowCount) {
        if (gridX <= 0) {
            throw new IndexOutOfBoundsException(
                "The column index " + gridX + " must be positive.");
        }
        if (gridX > colCount) {
            throw new IndexOutOfBoundsException(
                "The column index " + gridX + " must be less than or equal to " 
                    + colCount + ".");
        }
        if (gridX + gridWidth - 1 > colCount) {
            throw new IndexOutOfBoundsException(
                "The grid width " + gridWidth + " must be less than or equal to "
                    + (colCount - gridX + 1) + ".");
        }
        if (gridY <= 0) {
            throw new IndexOutOfBoundsException(
                "The row index " + gridY + " must be positive.");
        }
        if (gridY > rowCount) {
            throw new IndexOutOfBoundsException(
                "The row index " + gridY + " must be less than or equal to "
                    + rowCount + ".");
        }
        if (gridY + gridHeight - 1 > rowCount) {
            throw new IndexOutOfBoundsException(
                "The grid height " + gridHeight + " must be less than or equal to "
                    + (rowCount - gridY + 1) + ".");
        }
    }
    
    
    /**
     * Checks and verifies that the horizontal alignment is a horizontal
     * and the vertical alignment is vertical. 
     * 
     * @param horizontalAlignment  the horizontal alignment
     * @param verticalAlignment    the vertical alignment
     * @throws IllegalArgumentException if an alignment is invalid
     */
00720     private void ensureValidOrientations(Alignment horizontalAlignment, Alignment verticalAlignment) {
        if (!horizontalAlignment.isHorizontal())
            throw new IllegalArgumentException("The horizontal alignment must be one of: left, center, right, fill, default.");
        if (!verticalAlignment.isVertical())
            throw new IllegalArgumentException("The vertical alignment must be one of: top, center, botto, fill, default.");
    }
    
    
    // Settings Component Bounds ********************************************
    
    /**
     * Sets the component's bounds using the given component and cell bounds.
     * 
     * @param c                       the component to set bounds
     * @param layout             the FormLayout instance that computes the bounds
     * @param cellBounds              the cell's bounds
     * @param minWidthMeasure   measures the minimum width
     * @param minHeightMeasure        measures the minimum height
     * @param prefWidthMeasure        measures the preferred width
     * @param prefHeightMeasure  measures the preferred height
     */
00741     void setBounds(Component c, FormLayout layout, 
                   Rectangle cellBounds, 
                   FormLayout.Measure minWidthMeasure,
                   FormLayout.Measure minHeightMeasure,
                   FormLayout.Measure prefWidthMeasure,
                   FormLayout.Measure prefHeightMeasure) {
        ColumnSpec colSpec = gridWidth  == 1 ? layout.getColumnSpec(gridX) : null;
        RowSpec    rowSpec = gridHeight == 1 ? layout.getRowSpec(gridY) : null;
        Alignment concreteHAlign = concreteAlignment(this.hAlign, colSpec);
        Alignment concreteVAlign = concreteAlignment(this.vAlign, rowSpec);
        Insets concreteInsets = this.insets != null ? this.insets : EMPTY_INSETS;
        int cellX = cellBounds.x + concreteInsets.left;
        int cellY = cellBounds.y + concreteInsets.top;
        int cellW = cellBounds.width  - concreteInsets.left - concreteInsets.right;
        int cellH = cellBounds.height - concreteInsets.top  - concreteInsets.bottom;
        int compW = componentSize(c, colSpec, cellW, minWidthMeasure,
                                                     prefWidthMeasure);
        int compH = componentSize(c, rowSpec, cellH, minHeightMeasure,
                                                     prefHeightMeasure);
        int x = origin(concreteHAlign, cellX, cellW, compW); 
        int y = origin(concreteVAlign, cellY, cellH, compH);
        int w = extent(concreteHAlign, cellW, compW);
        int h = extent(concreteVAlign, cellH, compH);
        c.setBounds(x, y, w, h);
    }
    
    
    /**
     * Computes and returns the concrete alignment. Takes into account
     * the cell alignment and <i>the</i> <code>FormSpec</code> if applicable.<p>
     * 
     * If this constraints object doesn't belong to a single column or row,
     * the <code>formSpec</code> parameter is <code>null</code>.
     * In this case the cell alignment is answered, but <code>DEFAULT</code>
     * is mapped to <code>FILL</code>.<p>
     * 
     * If the cell belongs to a single column or row, we use the cell
     * alignment, unless it is <code>DEFAULT</code>, where the alignment 
     * is inherited from the column or row resp.
     * 
     * @param cellAlignment   this cell's aligment
     * @param formSpec        the associated column or row specification
     * @return the concrete alignment
     */
00785     private Alignment concreteAlignment(Alignment cellAlignment, FormSpec formSpec) {
        return formSpec == null 
            ? (cellAlignment == DEFAULT ? FILL : cellAlignment)
            : usedAlignment(cellAlignment, formSpec);
    }

    
    /**
     * Returns the alignment used for a given form constraints object.
     * The cell alignment overrides the column or row default, unless
     * it is <code>DEFAULT</code>. In the latter case, we use the
     * column or row alignment.
     * 
     * @param cellAlignment   this cell constraint's alignment
     * @param formSpec        the associated column or row specification
     * @return the alignment used
     */
00802     private Alignment usedAlignment(Alignment cellAlignment, FormSpec formSpec) {
        if (cellAlignment != CellConstraints.DEFAULT) {
            // Cell alignments other than DEFAULT override col/row alignments 
            return cellAlignment;
        }
        FormSpec.DefaultAlignment defaultAlignment = formSpec.getDefaultAlignment();
        if (defaultAlignment == FormSpec.FILL_ALIGN) 
            return FILL;
        if (defaultAlignment == ColumnSpec.LEFT) 
            return LEFT;
        else if (defaultAlignment == FormSpec.CENTER_ALIGN)
            return CENTER;
        else if (defaultAlignment == ColumnSpec.RIGHT) 
            return RIGHT;
        else if (defaultAlignment == RowSpec.TOP) 
            return TOP;
        else 
            return BOTTOM;    
    }
    
    
    /**
     * Computes and returns the pixel size of the given component using the
     * given form specification, measures, and cell size.
     * 
     * @param component the component to measure 
     * @param formSpec        the specification of the component's column/row
     * @param minMeasure      the measure for the minimum size
     * @param prefMeasure     the measure for the preferred size
     * @param cellSize        the cell size
     * @return the component size as measured or a constant
     */
00834     private int componentSize(Component component,
                               FormSpec formSpec,
                               int cellSize,
                               FormLayout.Measure minMeasure,
                               FormLayout.Measure prefMeasure) {
        if (formSpec == null) {
            return prefMeasure.sizeOf(component);
        } else if (formSpec.getSize() == Sizes.MINIMUM) {
            return minMeasure.sizeOf(component);
        } else if (formSpec.getSize() == Sizes.PREFERRED) {
            return prefMeasure.sizeOf(component);
        } else {  // default mode
            return Math.min(cellSize, prefMeasure.sizeOf(component)); 
        }
    }
    
    
    /**
     * Computes and returns the component's pixel origin.
     * 
     * @param alignment       the component's alignment
     * @param cellOrigin            the origin of the display area
     * @param cellSize              the extent of the display area
     * @param componentSize
     * @return the component's pixel origin
     */
00860     private int origin(Alignment alignment, 
                        int cellOrigin, 
                        int cellSize, 
                        int componentSize) {
        if (alignment == RIGHT || alignment == BOTTOM) {
            return cellOrigin + cellSize - componentSize;
        } else if (alignment == CENTER) {
            return cellOrigin + (cellSize - componentSize) / 2;
        } else {  // left, top, fill
            return cellOrigin;
        }
    }
    
    
    /**
     * Returns the component's pixel extent.
     * 
     * @param alignment       the component's alignment
     * @param cellSize              the size of the display area
     * @param componentSize   the component's size
     * @return the component's pixel extent
     */
00882     private int extent(Alignment alignment, int cellSize, int componentSize) {
        return alignment == FILL
                    ? cellSize
                    : componentSize;
    }
    
    
    // Misc *****************************************************************
    
    /**
     * Creates a copy of this cell constraints object.
     * 
     * @return          a copy of this cell constraints object
     */
00896     public Object clone() {
        try {
            CellConstraints c = (CellConstraints) super.clone();
            c.insets = (Insets) insets.clone();
            return c;
        } catch (CloneNotSupportedException e) {
            // This shouldn't happen, since we are Cloneable.
            throw new InternalError();
        }
    }
    
    
    /**
     * Constructs and returns a string representation of this constraints object.
     * 
     * @return    string representation of this constraints object
     */
00913     public String toString() {
        StringBuffer buffer = new StringBuffer("CellConstraints");
        buffer.append("[x=");
        buffer.append(gridX);
        buffer.append("; y=");
        buffer.append(gridY);
        buffer.append("; w=");
        buffer.append(gridWidth);
        buffer.append("; h=");
        buffer.append(gridHeight);
        buffer.append("; hAlign=");
        buffer.append(hAlign);
        buffer.append("; vAlign=");
        buffer.append(vAlign);
        if (!(EMPTY_INSETS.equals(insets))) {
          buffer.append("; insets=");
          buffer.append(insets);
        }
        
        buffer.append(']');
        return buffer.toString();
    }  
    
    
    /**
     * Returns a short string representation of this constraints object.
     * 
     * @return a short string representation of this constraints object
     */
00942     public String toShortString() {
        return toShortString(null);
    }
    
    
    /**
     * Returns a short string representation of this constraints object.
     * This method can use the given <code>FormLayout</code> 
     * to display extra information how default alignments
     * are mapped to concrete alignments. Therefore it asks the 
     * related column and row as specified by this constraints object. 
     * 
     * @param layout  the layout to be presented as a string
     * @return a short string representation of this constraints object
     */
00957     public String toShortString(FormLayout layout) {
        StringBuffer buffer = new StringBuffer("(");
        buffer.append(formatInt(gridX));
        buffer.append(", ");
        buffer.append(formatInt(gridY));
        buffer.append(", ");
        buffer.append(formatInt(gridWidth));
        buffer.append(", ");
        buffer.append(formatInt(gridHeight));
        buffer.append(", \"");
        buffer.append(hAlign.abbreviation());
        if (hAlign == DEFAULT && layout != null) {
            buffer.append('=');
            ColumnSpec colSpec = gridWidth == 1
                ? layout.getColumnSpec(gridX)
                : null;
            buffer.append(concreteAlignment(hAlign, colSpec).abbreviation());
        }
        buffer.append(", ");
        buffer.append(vAlign.abbreviation());
        if (vAlign == DEFAULT && layout != null) {
            buffer.append('=');
            RowSpec rowSpec = gridHeight == 1
                ? layout.getRowSpec(gridY)
                : null;
            buffer.append(concreteAlignment(vAlign, rowSpec).abbreviation());
        }
        buffer.append("\"");
        if (!(EMPTY_INSETS.equals(insets))) {
          buffer.append(", ");
          buffer.append(insets);
        }
        
        buffer.append(')');
        return buffer.toString();
    }  
    
    
    // Helper Class *********************************************************
    
    /**
     * An ordinal-based serializable typesafe enumeration for component 
     * alignment types as used by the {@link FormLayout}.
     */
01001     public static final class Alignment implements Serializable {
        
        private static final int HORIZONTAL = 0;
        private static final int VERTICAL   = 1;
        private static final int BOTH       = 2;
        
        private final transient String name;
        private final transient int    orientation;
        
        private Alignment(String name, int orientation) { 
            this.name        = name; 
            this.orientation = orientation;
        }
        
        static Alignment valueOf(String nameOrAbbreviation) {
            String str = nameOrAbbreviation.toLowerCase();
            if (str.equals("d") || str.equals("default"))
                return DEFAULT;
            else if (str.equals("f") || str.equals("fill"))
                return FILL;
            else if (str.equals("c") || str.equals("center"))
                return CENTER;
            else if (str.equals("l") || str.equals("left"))
                return LEFT;
            else if (str.equals("r") || str.equals("right"))
                return RIGHT;
            else if (str.equals("t") || str.equals("top"))
                return TOP;
            else if (str.equals("b") || str.equals("bottom"))
                return BOTTOM;
            else
                throw new IllegalArgumentException(
                    "Invalid alignment " + nameOrAbbreviation
                    + ". Must be one of: left, center, right, top, bottom, "
                    + "fill, default, l, c, r, t, b, f, d.");
        }

        /**
         * Returns this Alignment's name.
         * 
         * @return this alignment's name.
         */
01043         public String toString() {
            return name;
        }

        /**
         * Returns the first character of this Alignment's name.
         * Used to identify it in short format strings.
         * 
         * @return the name's first character.
         */
01053         public char abbreviation() {
            return name.charAt(0);
        }
        
        private boolean isHorizontal() {
            return orientation != VERTICAL;
        }

        private boolean isVertical() {
            return orientation != HORIZONTAL;
        }

        
        // Serialization *********************************************************
        
        private static int nextOrdinal = 0;
        
        private final int ordinal = nextOrdinal++;
        
        private Object readResolve() {
            return VALUES[ordinal];  // Canonicalize
        }

    }


    /**
     * Returns an integer that has a minimum of two characters.
     * 
     * @param number   the number to format
     * @return a string representation for a number with a minum of two chars
     */
01085       private String formatInt(int number) {
        String str = Integer.toString(number);
        return number < 10 ? " " + str : str;
    }
    
}


Generated by  Doxygen 1.6.0   Back to index