Class CellConstraints
- All Implemented Interfaces:
Serializable
,Cloneable
Most methods return this object to enable method chaining.
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.
Examples:
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.
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");See also the examples in the
FormLayout
class comment.TODO: Explain in the JavaDocs that the insets are actually offsets. And describe that these offsets are not taken into account when FormLayout computes the column and row sizes.
TODO: Rename the inset to offsets.
- Version:
- $Revision: 1.11 $
- Author:
- Karsten Lentzsch
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
An ordinal-based serializable typesafe enumeration for component alignment types as used by theFormLayout
. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final CellConstraints.Alignment
Put the component in the bottom.static final CellConstraints.Alignment
Put the component in the center.static final CellConstraints.Alignment
Use the column's or row's default alignment.static final CellConstraints.Alignment
Fill the cell either horizontally or vertically.int
Describes the component's vertical grid extent (number of cells).int
Describes the component's horizontal grid extend (number of cells).int
Describes the component's horizontal grid origin (starts at 1).int
Describes the component's vertical grid origin (starts at 1).Describes the component's horizontal alignment.Describes whether individual components shall be taken into account by the FormLayout if 1) they are invisible and 2) the FormLayout does not honor the visibility.Describes the component'sInsets
in it's display area.static final CellConstraints.Alignment
Put the component in the left.static final CellConstraints.Alignment
Put the component in the right.static final CellConstraints.Alignment
Put the component in the top.Describes the component's vertical alignment. -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a default instance ofCellConstraints
.CellConstraints
(int gridX, int gridY) Constructs an instance ofCellConstraints
for the given cell position.CellConstraints
(int gridX, int gridY, int gridWidth, int gridHeight) Constructs an instance ofCellConstraints
for the given cell position and size.CellConstraints
(int gridX, int gridY, int gridWidth, int gridHeight, CellConstraints.Alignment hAlign, CellConstraints.Alignment vAlign) Constructs an instance ofCellConstraints
for the given cell position and size, anchor, and fill.CellConstraints
(int gridX, int gridY, int gridWidth, int gridHeight, CellConstraints.Alignment hAlign, CellConstraints.Alignment vAlign, Insets insets) Constructs an instance ofCellConstraints
for the complete set of available properties.CellConstraints
(int gridX, int gridY, CellConstraints.Alignment hAlign, CellConstraints.Alignment vAlign) Constructs an instance ofCellConstraints
for the given cell position, anchor, and fill.CellConstraints
(String encodedConstraints) Constructs an instance ofCellConstraints
from the given encoded string properties. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a copy of this cell constraints object.rc
(int row, int col) Sets row and column origins; sets height and width to 1; uses the default alignments.rc
(int row, int col, CellConstraints.Alignment rowAlign, CellConstraints.Alignment colAlign) Sets the row and column origins; sets width and height to 1; set horizontal and vertical alignment using the specified objects.Sets row and column origins; sets height and width to 1; decodes vertical and horizontal alignments from the given string.rchw
(int row, int col, int rowSpan, int colSpan) Sets the row, column, height, and width; uses default alignments.rchw
(int row, int col, int rowSpan, int colSpan, CellConstraints.Alignment rowAlign, CellConstraints.Alignment colAlign) Sets the row, column, height, and width; sets the vertical and horizontal alignment using the specified alignment objects.Sets the row, column, height, and width; decodes the vertical and horizontal alignments from the given string.rcw
(int row, int col, int colSpan) Sets the row, column, height, and width; uses a height (row span) of 1 and the vertical and horizontal default alignments.rcw
(int row, int col, int colSpan, CellConstraints.Alignment rowAlign, CellConstraints.Alignment colAlign) Sets the row, column, height, and width; sets the vertical and horizontal alignment using the specified alignment objects.Sets the row, column, height, and width; decodes the vertical and horizontal alignments from the given string.Returns a short string representation of this constraints object.toShortString
(FormLayout layout) Returns a short string representation of this constraints object.toString()
Constructs and returns a string representation of this constraints object.xy
(int col, int row) Sets column and row origins; sets width and height to 1; uses the default alignments.xy
(int col, int row, CellConstraints.Alignment colAlign, CellConstraints.Alignment rowAlign) Sets the column and row origins; sets width and height to 1; set horizontal and vertical alignment using the specified objects.Sets column and row origins; sets width and height to 1; decodes horizontal and vertical alignments from the given string.xyw
(int col, int row, int colSpan) Sets the column, row, width, and height; uses a height (row span) of 1 and the horizontal and vertical default alignments.xyw
(int col, int row, int colSpan, CellConstraints.Alignment colAlign, CellConstraints.Alignment rowAlign) Sets the column, row, width, and height; sets the horizontal and vertical alignment using the specified alignment objects.Sets the column, row, width, and height; decodes the horizontal and vertical alignments from the given string.xywh
(int col, int row, int colSpan, int rowSpan) Sets the column, row, width, and height; uses default alignments.xywh
(int col, int row, int colSpan, int rowSpan, CellConstraints.Alignment colAlign, CellConstraints.Alignment rowAlign) Sets the column, row, width, and height; sets the horizontal and vertical alignment using the specified alignment objects.Sets the column, row, width, and height; decodes the horizontal and vertical alignments from the given string.
-
Field Details
-
DEFAULT
Use the column's or row's default alignment. -
FILL
Fill the cell either horizontally or vertically. -
LEFT
Put the component in the left. -
RIGHT
Put the component in the right. -
CENTER
Put the component in the center. -
TOP
Put the component in the top. -
BOTTOM
Put the component in the bottom. -
gridX
public int gridXDescribes the component's horizontal grid origin (starts at 1). -
gridY
public int gridYDescribes the component's vertical grid origin (starts at 1). -
gridWidth
public int gridWidthDescribes the component's horizontal grid extend (number of cells). -
gridHeight
public int gridHeightDescribes the component's vertical grid extent (number of cells). -
hAlign
Describes the component's horizontal alignment. -
vAlign
Describes the component's vertical alignment. -
insets
Describes the component'sInsets
in it's display area. -
honorsVisibility
Describes whether individual components shall be taken into account by the FormLayout if 1) they are invisible and 2) the FormLayout does not honor the visibility. SeeFormLayout.setHonorsVisibility(boolean)
andFormLayout.setHonorsVisibility(Component, Boolean)
for a full description of this feature.
-
-
Constructor Details
-
CellConstraints
public CellConstraints()Constructs a default instance ofCellConstraints
. -
CellConstraints
public CellConstraints(int gridX, int gridY) Constructs an instance ofCellConstraints
for the given cell position.Examples:
new CellConstraints(1, 3); new CellConstraints(1, 3);
- Parameters:
gridX
- the component's horizontal grid origingridY
- the component's vertical grid origin
-
CellConstraints
public CellConstraints(int gridX, int gridY, CellConstraints.Alignment hAlign, CellConstraints.Alignment vAlign) Constructs an instance ofCellConstraints
for the given cell position, anchor, and fill.Examples:
new CellConstraints(1, 3, CellConstraints.LEFT, CellConstraints.BOTTOM); new CellConstraints(1, 3, CellConstraints.CENTER, CellConstraints.FILL);
- Parameters:
gridX
- the component's horizontal grid origingridY
- the component's vertical grid originhAlign
- the component's horizontal alignmentvAlign
- the component's vertical alignment
-
CellConstraints
public CellConstraints(int gridX, int gridY, int gridWidth, int gridHeight) Constructs an instance ofCellConstraints
for the given cell position and size.Examples:
new CellConstraints(1, 3, 2, 1); new CellConstraints(1, 3, 7, 3);
- Parameters:
gridX
- the component's horizontal grid origingridY
- the component's vertical grid origingridWidth
- the component's horizontal extentgridHeight
- the component's vertical extent
-
CellConstraints
public CellConstraints(int gridX, int gridY, int gridWidth, int gridHeight, CellConstraints.Alignment hAlign, CellConstraints.Alignment vAlign) Constructs an instance ofCellConstraints
for the given cell position and size, anchor, and fill.Examples:
new CellConstraints(1, 3, 2, 1, CellConstraints.LEFT, CellConstraints.BOTTOM); new CellConstraints(1, 3, 7, 3, CellConstraints.CENTER, CellConstraints.FILL);
- Parameters:
gridX
- the component's horizontal grid origingridY
- the component's vertical grid origingridWidth
- the component's horizontal extentgridHeight
- the component's vertical extenthAlign
- the component's horizontal alignmentvAlign
- the component's vertical alignment
-
CellConstraints
public CellConstraints(int gridX, int gridY, int gridWidth, int gridHeight, CellConstraints.Alignment hAlign, CellConstraints.Alignment vAlign, Insets insets) Constructs an instance ofCellConstraints
for the complete set of available properties.Examples:
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));
- Parameters:
gridX
- the component's horizontal grid origingridY
- the component's vertical grid origingridWidth
- the component's horizontal extentgridHeight
- the component's vertical extenthAlign
- the component's horizontal alignmentvAlign
- the component's vertical alignmentinsets
- the component's display areaInsets
- Throws:
IndexOutOfBoundsException
- if the grid origin or extent is negativeNullPointerException
- if the horizontal or vertical alignment is nullIllegalArgumentException
- if an alignment orientation is invalid
-
CellConstraints
Constructs an instance ofCellConstraints
from the given encoded string properties.Examples:
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");
- Parameters:
encodedConstraints
- the constraints encoded as string
-
-
Method Details
-
xy
Sets column and row origins; sets width and height to 1; uses the default alignments.Examples:
cc.xy(1, 1); cc.xy(1, 3);
- Parameters:
col
- the new column indexrow
- the new row index- Returns:
- this
-
xy
Sets column and row origins; sets width and height to 1; decodes horizontal and vertical alignments from the given string.Examples:
cc.xy(1, 3, "left, bottom"); cc.xy(1, 3, "l, b"); cc.xy(1, 3, "center, fill"); cc.xy(1, 3, "c, f");
- Parameters:
col
- the new column indexrow
- the new row indexencodedAlignments
- describes the horizontal and vertical alignments- Returns:
- this
- Throws:
IllegalArgumentException
- if an alignment orientation is invalid
-
xy
public CellConstraints xy(int col, int row, CellConstraints.Alignment colAlign, CellConstraints.Alignment rowAlign) Sets the column and row origins; sets width and height to 1; set horizontal and vertical alignment using the specified objects.Examples:
cc.xy(1, 3, CellConstraints.LEFT, CellConstraints.BOTTOM); cc.xy(1, 3, CellConstraints.CENTER, CellConstraints.FILL);
- Parameters:
col
- the new column indexrow
- the new row indexcolAlign
- horizontal component alignmentrowAlign
- vertical component alignment- Returns:
- this
-
xyw
Sets the column, row, width, and height; uses a height (row span) of 1 and the horizontal and vertical default alignments.Examples:
cc.xyw(1, 3, 7); cc.xyw(1, 3, 2);
- Parameters:
col
- the new column indexrow
- the new row indexcolSpan
- the column span or grid width- Returns:
- this
-
xyw
Sets the column, row, width, and height; decodes the horizontal and vertical alignments from the given string. The row span (height) is set to 1.Examples:
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");
- Parameters:
col
- the new column indexrow
- the new row indexcolSpan
- the column span or grid widthencodedAlignments
- describes the horizontal and vertical alignments- Returns:
- this
- Throws:
IllegalArgumentException
- if an alignment orientation is invalid
-
xyw
public CellConstraints xyw(int col, int row, int colSpan, CellConstraints.Alignment colAlign, CellConstraints.Alignment rowAlign) Sets the column, row, width, and height; sets the horizontal and vertical alignment using the specified alignment objects. The row span (height) is set to 1.Examples:
cc.xyw(1, 3, 2, CellConstraints.LEFT, CellConstraints.BOTTOM); cc.xyw(1, 3, 7, CellConstraints.CENTER, CellConstraints.FILL);
- Parameters:
col
- the new column indexrow
- the new row indexcolSpan
- the column span or grid widthcolAlign
- horizontal component alignmentrowAlign
- vertical component alignment- Returns:
- this
- Throws:
IllegalArgumentException
- if an alignment orientation is invalid
-
xywh
Sets the column, row, width, and height; uses default alignments.Examples:
cc.xywh(1, 3, 2, 1); cc.xywh(1, 3, 7, 3);
- Parameters:
col
- the new column indexrow
- the new row indexcolSpan
- the column span or grid widthrowSpan
- the row span or grid height- Returns:
- this
-
xywh
Sets the column, row, width, and height; decodes the horizontal and vertical alignments from the given string.Examples:
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");
- Parameters:
col
- the new column indexrow
- the new row indexcolSpan
- the column span or grid widthrowSpan
- the row span or grid heightencodedAlignments
- describes the horizontal and vertical alignments- Returns:
- this
- Throws:
IllegalArgumentException
- if an alignment orientation is invalid
-
xywh
public CellConstraints xywh(int col, int row, int colSpan, int rowSpan, CellConstraints.Alignment colAlign, CellConstraints.Alignment rowAlign) Sets the column, row, width, and height; sets the horizontal and vertical alignment using the specified alignment objects.Examples:
cc.xywh(1, 3, 2, 1, CellConstraints.LEFT, CellConstraints.BOTTOM); cc.xywh(1, 3, 7, 3, CellConstraints.CENTER, CellConstraints.FILL);
- Parameters:
col
- the new column indexrow
- the new row indexcolSpan
- the column span or grid widthrowSpan
- the row span or grid heightcolAlign
- horizontal component alignmentrowAlign
- vertical component alignment- Returns:
- this
- Throws:
IllegalArgumentException
- if an alignment orientation is invalid
-
rc
Sets row and column origins; sets height and width to 1; uses the default alignments.Examples:
cc.rc(1, 1); cc.rc(3, 1);
- Parameters:
row
- the new row indexcol
- the new column index- Returns:
- this
- Since:
- 1.1
-
rc
Sets row and column origins; sets height and width to 1; decodes vertical and horizontal alignments from the given string.Examples:
cc.rc(3, 1, "bottom, left"); cc.rc(3, 1, "b, l"); cc.rc(3, 1, "fill, center"); cc.rc(3, 1, "f, c");
- Parameters:
row
- the new row indexcol
- the new column indexencodedAlignments
- describes the vertical and horizontal alignments- Returns:
- this
- Throws:
IllegalArgumentException
- if an alignment orientation is invalid- Since:
- 1.1
-
rc
public CellConstraints rc(int row, int col, CellConstraints.Alignment rowAlign, CellConstraints.Alignment colAlign) Sets the row and column origins; sets width and height to 1; set horizontal and vertical alignment using the specified objects.Examples:
cc.rc(3, 1, CellConstraints.BOTTOM, CellConstraints.LEFT); cc.rc(3, 1, CellConstraints.FILL, CellConstraints.CENTER);
- Parameters:
row
- the new row indexcol
- the new column indexrowAlign
- vertical component alignmentcolAlign
- horizontal component alignment- Returns:
- this
- Since:
- 1.1
-
rcw
Sets the row, column, height, and width; uses a height (row span) of 1 and the vertical and horizontal default alignments.Examples:
cc.rcw(3, 1, 7); cc.rcw(3, 1, 2);
- Parameters:
row
- the new row indexcol
- the new column indexcolSpan
- the column span or grid width- Returns:
- this
- Since:
- 1.1
-
rcw
Sets the row, column, height, and width; decodes the vertical and horizontal alignments from the given string. The row span (height) is set to 1.Examples:
cc.rcw(3, 1, 7, "bottom, left"); cc.rcw(3, 1, 7, "b, l"); cc.rcw(3, 1, 2, "fill, center"); cc.rcw(3, 1, 2, "f, c");
- Parameters:
row
- the new row indexcol
- the new column indexcolSpan
- the column span or grid widthencodedAlignments
- describes the vertical and horizontal alignments- Returns:
- this
- Throws:
IllegalArgumentException
- if an alignment orientation is invalid- Since:
- 1.1
-
rcw
public CellConstraints rcw(int row, int col, int colSpan, CellConstraints.Alignment rowAlign, CellConstraints.Alignment colAlign) Sets the row, column, height, and width; sets the vertical and horizontal alignment using the specified alignment objects. The row span (height) is set to 1.Examples:
cc.rcw(3, 1, 2, CellConstraints.BOTTOM, CellConstraints.LEFT); cc.rcw(3, 1, 7, CellConstraints.FILL, CellConstraints.CENTER);
- Parameters:
row
- the new row indexcol
- the new column indexcolSpan
- the column span or grid widthrowAlign
- vertical component alignmentcolAlign
- horizontal component alignment- Returns:
- this
- Throws:
IllegalArgumentException
- if an alignment orientation is invalid- Since:
- 1.1
-
rchw
Sets the row, column, height, and width; uses default alignments.Examples:
cc.rchw(1, 3, 2, 1); cc.rchw(1, 3, 7, 3);
- Parameters:
row
- the new row indexcol
- the new column indexrowSpan
- the row span or grid heightcolSpan
- the column span or grid width- Returns:
- this
- Since:
- 1.1
-
rchw
Sets the row, column, height, and width; decodes the vertical and horizontal alignments from the given string.Examples:
cc.rchw(3, 1, 1, 2, "bottom, left"); cc.rchw(3, 1, 1, 2, "b, l"); cc.rchw(3, 1, 3, 7, "fill, center"); cc.rchw(3, 1, 3, 7, "f, c");
- Parameters:
row
- the new row indexcol
- the new column indexrowSpan
- the row span or grid heightcolSpan
- the column span or grid widthencodedAlignments
- describes the vertical and horizontal alignments- Returns:
- this
- Throws:
IllegalArgumentException
- if an alignment orientation is invalid- Since:
- 1.1
-
rchw
public CellConstraints rchw(int row, int col, int rowSpan, int colSpan, CellConstraints.Alignment rowAlign, CellConstraints.Alignment colAlign) Sets the row, column, height, and width; sets the vertical and horizontal alignment using the specified alignment objects.Examples:
cc.rchw(3, 1, 1, 2, CellConstraints.BOTTOM, CellConstraints.LEFT); cc.rchw(3, 1, 3, 7, CellConstraints.FILL, CellConstraints.CENTER);
- Parameters:
row
- the new row indexcol
- the new column indexrowSpan
- the row span or grid heightcolSpan
- the column span or grid widthrowAlign
- vertical component alignmentcolAlign
- horizontal component alignment- Returns:
- this
- Throws:
IllegalArgumentException
- if an alignment orientation is invalid- Since:
- 1.1
-
clone
Creates a copy of this cell constraints object. -
toString
Constructs and returns a string representation of this constraints object. -
toShortString
Returns a short string representation of this constraints object.- Returns:
- a short string representation of this constraints object
-
toShortString
Returns a short string representation of this constraints object. This method can use the givenFormLayout
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.- Parameters:
layout
- the layout to be presented as a string- Returns:
- a short string representation of this constraints object
-