jas.util.layout
Class PnutsLayout

java.lang.Object
  jas.util.layout.PnutsLayout

All Implemented Interfaces:

LayoutManager, LayoutManager2, Serializable

public class PnutsLayout
extends Object
implements LayoutManager2, Serializable

The PnutsLayout is a general purpose geometry manager. It is more user-friendly than any LayoutManager out there and as flexible as GridBagLayout. e.g.

  setLayout(new PnutsLayout("cols = 3"));
  add(button1, "ipadx = 20, ipady = 20");
  add(button2, "padx = 20, pady = 20");
  add(button3, "colspan = 2");
  add(button4, "rowspan = 2");
  add(button3, "halign = left, valign = top");
  add(button3, "halign = right, valign = bottom");
  add(button3, "halign = center, valign = fill");
 

property	the meaning	default
cols	number of columns	1
uniform	if width and/or height of each columns are all same, "x", "y" or "xy"	""
colspan	number of columns the component occupies	1
rowspan	number of rows the component occupies	1
padx	external padding (x)	0
pady	external padding (y)	0
ipadx	internal padding (x)	0
ipady	internal padding (y)	0
halign	alignment of x. One of "left", "right", "center", "fill"	center
valign	alignment of y. One of "top", "bottom", "center", "fill"	center
expand	expand as the size of container changes. one of "x", "y", "xy"	""

Version:

1.2

See Also:

Serialized Form

Field Summary

protected int	align default align
static int	BOTTOM
static int	CENTER
protected int	cols The number of columns
static int	H_FIT
protected int	ipadx default ipadx
protected int	ipady default ipady
static int	LEFT
protected int	padx default padx
protected int	pady default pady
static int	RIGHT
protected int	rows The number of rows
static int	TOP
static int	V_FIT
protected boolean	xfix
protected boolean	yfix

Constructor Summary

PnutsLayout()
construct a PnutsLayout

PnutsLayout(int cols)
construct a PnutsLayout with specified number of columns

PnutsLayout(int cols, int padx, int pady)
construct a PnutsLayout

PnutsLayout(String str)

Method Summary

void	addLayoutComponent(Component comp, Object obj) Adds the specified component to the layout, using the specified constraint object.
void	addLayoutComponent(String name, Component comp) Adds the specified component with the specified name to the layout.
int	getCols() Get the number of columns
int	getColspan(Component comp)
Hashtable	getConstraints(Component comp) get a Hashtable of constraint for the specified component
String	getConstraintString(Component comp) get a string representaion of constraint for the specified component
String	getExpand(Component comp)
Point	getGridPoint(Container target, int x, int y) get left-top point of the component(x,y)
Rectangle	getGridRectangle(Container target, int idx) get bounding-box for idx'th component
String	getHAlign(Component comp)
int	getIPadX(Component comp)
int	getIPadY(Component comp)
float	getLayoutAlignmentX(Container target) Returns the alignment along the x axis.
float	getLayoutAlignmentY(Container target) Returns the alignment along the y axis.
int	getPadX(Component comp)
int	getPadY(Component comp)
int	getRows() get the number of rows
int	getRowspan(Component comp)
boolean[]	getUniform() get "uniform" property
String	getVAlign(Component comp)
void	invalidateLayout(Container target) Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
void	layoutContainer(Container target) Lays out the container.
Dimension	maximumLayoutSize(Container target) Returns the maximum size of this component.
Dimension	minimumLayoutSize(Container target) Returns the minimum dimensions needed to layout the components contained in the specified target container.
Dimension	preferredLayoutSize(Container target) Returns the preferred dimensions for this layout given the components in the specified target container.
void	removeLayoutComponent(Component comp) Removes the specified component from the layout.
void	setCols(int cols) Set the number of columns
void	setColspan(Component comp, int colspan)
void	setConstraints(Component comp, Hashtable table) Specify layout constraints with Hashtable
void	setConstraints(Component comp, String str) Specify layout constraints with comma-separated list of "=".
void	setExpand(Component comp, String ex)
void	setHAlign(Component comp, String s)
void	setIPadding(Component comp, int x, int y)
void	setPadding(Component comp, int x, int y)
void	setRowspan(Component comp, int rowspan)
void	setUniform(boolean x, boolean y) set "uniform" property
void	setVAlign(Component comp, String s)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CENTER

public static final int CENTER

See Also:

Constant Field Values

TOP

public static final int TOP

See Also:

Constant Field Values

BOTTOM

public static final int BOTTOM

See Also:

Constant Field Values

LEFT

public static final int LEFT

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

See Also:

Constant Field Values

V_FIT

public static final int V_FIT

See Also:

Constant Field Values

H_FIT

public static final int H_FIT

See Also:

Constant Field Values

align

protected int align

default align

padx

protected int padx

default padx

pady

protected int pady

default pady

ipadx

protected int ipadx

default ipadx

ipady

protected int ipady

default ipady

cols

protected int cols

The number of columns

rows

protected int rows

The number of rows

xfix

protected boolean xfix

yfix

protected boolean yfix

Constructor Detail

PnutsLayout

public PnutsLayout()

construct a PnutsLayout

PnutsLayout

public PnutsLayout(int cols)

construct a PnutsLayout with specified number of columns

Parameters:

cols - the number of columns

PnutsLayout

public PnutsLayout(int cols,
                   int padx,
                   int pady)

construct a PnutsLayout

Parameters:

cols - the number of columns

padx - default external padding

pady - default external padding

PnutsLayout

public PnutsLayout(String str)

Method Detail

addLayoutComponent

public void addLayoutComponent(Component comp,
                               Object obj)

Adds the specified component to the layout, using the specified constraint object.

Specified by:

addLayoutComponent in interface LayoutManager2

Parameters:

comp - the component to be added.

obj - an object that determines how the component is added to the layout. Usage: container.add(component, new Object[]{align, colspan, rowspan});

setConstraints

public void setConstraints(Component comp,
                           String str)

Specify layout constraints with comma-separated list of "=". halign ::= left | right | center | fill valign ::= top | bottom | center | fill expand ::= x | y | xy

Parameters:

comp - the component

str - a string that describes how the component is added to the layout.

setConstraints

public void setConstraints(Component comp,
                           Hashtable table)

Specify layout constraints with Hashtable

Parameters:

comp - the component to be set the constraint.

table - a Hashtable that describes how the component is added to the layout.

getConstraintString

public String getConstraintString(Component comp)

get a string representaion of constraint for the specified component

Parameters:

comp - the component to be investigate

Returns:

string representaion of the constraint

getConstraints

public Hashtable getConstraints(Component comp)

get a Hashtable of constraint for the specified component

Parameters:

comp - the component to be investigate

Returns:

the constraints as Hashtable

addLayoutComponent

public void addLayoutComponent(String name,
                               Component comp)

Adds the specified component with the specified name to the layout.

Specified by:

addLayoutComponent in interface LayoutManager

Parameters:

name - the component name

comp - the component to be added

removeLayoutComponent

public void removeLayoutComponent(Component comp)

Removes the specified component from the layout.

Specified by:

removeLayoutComponent in interface LayoutManager

Parameters:

comp - the component ot be removed

maximumLayoutSize

public Dimension maximumLayoutSize(Container target)

Returns the maximum size of this component.

Specified by:

maximumLayoutSize in interface LayoutManager2

See Also:

Component.getMinimumSize(), Component.getPreferredSize(), LayoutManager

getLayoutAlignmentX

public float getLayoutAlignmentX(Container target)

Returns the alignment along the x axis. This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.

Specified by:

getLayoutAlignmentX in interface LayoutManager2

getLayoutAlignmentY

public float getLayoutAlignmentY(Container target)

Returns the alignment along the y axis. This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.

Specified by:

getLayoutAlignmentY in interface LayoutManager2

invalidateLayout

public void invalidateLayout(Container target)

Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.

Specified by:

invalidateLayout in interface LayoutManager2

Parameters:

target - container to invalidate the layout

setCols

public void setCols(int cols)

Set the number of columns

Parameters:

cols - the number of columns

setUniform

public void setUniform(boolean x,
                       boolean y)

set "uniform" property

Parameters:

x - uniform property for horizontal direction

y - uniform property for vertical direction

getUniform

public boolean[] getUniform()

get "uniform" property

Returns:

boolean array of "uniform property"

setColspan

public void setColspan(Component comp,
                       int colspan)

Parameters:

comp - the component of which you want to change colspan

colspan - the number of columns the component occupies

getColspan

public int getColspan(Component comp)

Parameters:

comp - the component of which you want to get colspan

Returns:

the value of "colspan" property

setRowspan

public void setRowspan(Component comp,
                       int rowspan)

Parameters:

comp - the component of which you want to change rowspan

rowspan - the number of rows the component occupies

getRowspan

public int getRowspan(Component comp)

Parameters:

comp - the component of which you want to get rowspan

Returns:

the value of "rowspan" property

setHAlign

public void setHAlign(Component comp,
                      String s)

Parameters:

comp - the component of which you want to change alignment

align - "left", "right", "fill", "center"

setVAlign

public void setVAlign(Component comp,
                      String s)

Parameters:

comp - the component of which you want to change alignment

align - "top", "bottom", "fill", "center"

getHAlign

public String getHAlign(Component comp)

Parameters:

comp - the component of which you want to get alignment

Returns:

"fill" | "left" | "right" | "center"

getVAlign

public String getVAlign(Component comp)

Parameters:

comp - the component of which you want to get alignment

Returns:

"fill" | "top" | "bottom" | "center"

setExpand

public void setExpand(Component comp,
                      String ex)

Parameters:

comp - the component of which you want to set "expand"

getExpand

public String getExpand(Component comp)

Parameters:

comp - the component of which you want to get "expand"

Returns:

"x" | "y" | "xy" | ""

setPadding

public void setPadding(Component comp,
                       int x,
                       int y)

Parameters:

comp - the component of which you want to change alignment

x - "padx" property

y - "pady" property

getPadX

public int getPadX(Component comp)

Parameters:

comp - the component of which you want to get "padx"

Returns:

the value of "padx" property

getPadY

public int getPadY(Component comp)

Parameters:

comp - the component of which you want to get "pady"

Returns:

the value of "pady" property

setIPadding

public void setIPadding(Component comp,
                        int x,
                        int y)

Parameters:

comp - the component of which you want to change alignment

x - "ipadx" property

y - "ipady" property

getIPadX

public int getIPadX(Component comp)

Parameters:

comp - the component of which you want to get "ipadx"

Returns:

the value of "ipadx" property

getIPadY

public int getIPadY(Component comp)

Parameters:

comp - the component of which you want to get "ipady"

Returns:

the value of "ipady" property

preferredLayoutSize

public Dimension preferredLayoutSize(Container target)

Returns the preferred dimensions for this layout given the components in the specified target container.

Specified by:

preferredLayoutSize in interface LayoutManager

Parameters:

target - the component which needs to be laid out

See Also:

Container, minimumLayoutSize(java.awt.Container)

minimumLayoutSize

public Dimension minimumLayoutSize(Container target)

Returns the minimum dimensions needed to layout the components contained in the specified target container.

Specified by:

minimumLayoutSize in interface LayoutManager

Parameters:

target - the component which needs to be laid out

See Also:

preferredLayoutSize(java.awt.Container)

layoutContainer

public void layoutContainer(Container target)

Lays out the container. This method will actually reshape the components in the target in order to satisfy the constraints of the BorderLayout object.

Specified by:

layoutContainer in interface LayoutManager

Parameters:

target - the specified component being laid out.

See Also:

Container

getCols

public int getCols()

Get the number of columns

Returns:

the number of columns

getRows

public int getRows()

get the number of rows

Returns:

the number of rows

getGridPoint

public Point getGridPoint(Container target,
                          int x,
                          int y)

get left-top point of the component(x,y)

Parameters:

x - the index of column

y - the index of row

Returns:

left-top point of the component

getGridRectangle

public Rectangle getGridRectangle(Container target,
                                  int idx)

get bounding-box for idx'th component

Parameters:

idx - the index of the component

Returns:

bounding-box as Rectangle object

toString

public String toString()

Overrides:

toString in class Object

Returns:

the String representation of this PnutsLayout's values.