com.darwinsys.swingui.layout.EntryLayout Maven / Gradle / Ivy
Show all versions of darwinsys-api Show documentation
package com.darwinsys.swingui.layout;
import java.awt.Component;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.LayoutManager;
import java.awt.Rectangle;
import com.darwinsys.util.Debug;
/** A simple layout manager, for "Entry" areas ith e.g., a list of labels
* and their corresponding JTextFields. These typically look like:
*
* Login: _______________
* Password: _______________
*
* Basically two (or more) columns of different, but constant, widths.
* Note: all columns must be the same height!.
*
* Construct instances by passing an array of the column width percentages
* (as doubles, fractions from 0.1 to 0.9, so 40%,60% would be {0.4, 0.6}).
* The length of this array uniquely determines the number of columns.
* Columns are forced to be the relevant widths.
* Note: As with GridLayout, the number of items
* added must be an even
* multiple of the number of columns. If not, exceptions may be thrown!
* @author Ian F. Darwin, http://www.darwinsys.com/
*/
// tag::main[]
// package com.darwinsys.swingui.layout;
public class EntryLayout implements LayoutManager {
/** The array of widths, as decimal fractions (0.4 == 40%, etc.). */
protected final double[] widthPercentages;
/** The number of columns. */
protected final int COLUMNS;
/** The default padding */
protected final static int HPAD = 5, VPAD = 5;
/** The actual padding */
protected final int hpad, vpad;
/** True if the list of widths was valid. */
protected boolean validWidths = false;
/** Construct an EntryLayout with widths and padding specified.
* @param relWidths Array of doubles specifying relative column widths.
* @param h Horizontal padding between items
* @param v Vertical padding between items
*/
public EntryLayout(double[] relWidths, int h, int v) {
COLUMNS = relWidths.length;
widthPercentages = new double[COLUMNS];
for (int i=0; i= 1.0)
throw new IllegalArgumentException(
"EntryLayout: widths must be fractions < 1");
widthPercentages[i] = relWidths[i];
}
validWidths = true;
hpad = h;
vpad = v;
}
/** Construct an EntryLayout with widths and with default padding amounts.
* @param relWidths Array of doubles specifying column widths.
*/
public EntryLayout(double[] relWidths) {
this(relWidths, HPAD, VPAD);
}
/** Adds the specified component with the specified constraint
* to the layout; required by LayoutManager but not used.
*/
public void addLayoutComponent(String name, Component comp) {
// nothing to do
}
/** Removes the specified component from the layout;
* required by LayoutManager, but does nothing.
*/
public void removeLayoutComponent(Component comp) {
// nothing to do
}
/** Calculates the preferred size dimensions for the specified panel
* given the components in the specified parent container. */
public Dimension preferredLayoutSize(Container parent) {
// System.out.println("preferredLayoutSize");
return computeLayoutSize(parent, hpad, vpad);
}
/** Find the minimum Dimension for the
* specified container given the components therein.
*/
public Dimension minimumLayoutSize(Container parent) {
// System.out.println("minimumLayoutSize");
return computeLayoutSize(parent, 0, 0);
}
/** The width of each column, as found by computLayoutSize(). */
int[] widths;
/** The height of each row, as found by computLayoutSize(). */
int[] heights;
/** Compute the size of the whole mess. Serves as the guts of
* preferredLayoutSize() and minimumLayoutSize().
* @param parent The container in which to do the layout.
* @param hp The horizontal padding (may be zero)
* @param vp The Vertical Padding (may be zero).
* @return The computed size
*/
protected Dimension computeLayoutSize(Container parent, int hp, int vp) {
if (!validWidths)
return null;
Component[] components = parent.getComponents();
int preferredWidth = 0, preferredHeight = 0;
widths = new int[COLUMNS];
heights = new int[components.length / COLUMNS];
// System.out.println("Grid: " + widths.length + ", " + heights.length);
int i;
// Pass One: Compute largest widths and heights.
for (i=0; i