com.gargoylesoftware.base.gui

Class TableLayoutConstraints

public class TableLayoutConstraints extends Object implements Serializable

This object contains all the constraints that apply to a specific component inside a TableLayout.

We use the convention of specifying row before column to conform with the swing standards. This seems counterintuitive when specifying x,y (actually y,x) co-ordinates however we felt it was more important to conform to existing java layout standards.

Version: $Revision: 1.5 $

Author: Mike Bowler

Field Summary
intcolumnSpan_
intcolumn_
inthorizontalAlignment_
booleanhorizontalStretch_
booleanisImmutable_
booleanobeyMaximumSize_
booleanobeyMinimumSize_
introwSpan_
introw_
static longserialVersionUID
intverticalAlignment_
booleanverticalStretch_
Constructor Summary
TableLayoutConstraints(int row, int column)
Create a new instance.
Method Summary
protected static voidassertNotNull(String fieldName, Object fieldValue)
Verify that the specified value is not null.
voidensureMutable()
Check to make sure that we are allowed to modify this object.
intgetColumn()
Return the column.
intgetColumnSpan()
Return the number of columns this component will span.
intgetHorizontalAlignment()
Return the horizontalAlignment.
booleangetHorizontalStretch()
Return true if this component can be stretched horizontally.
booleangetObeyMaximumSize()
Return true if we are obeying the maximum size.
booleangetObeyMinimumSize()
Return true if we are obeying the minimum size.
intgetRow()
Return the row.
intgetRowSpan()
Return the number of rows this component will span.
intgetVerticalAlignment()
Return the vertical alignment.
booleangetVerticalStretch()
Return true if this component can be stretched vertically.
booleanisImmutable()
Return true if this object is immutable.
static TableLayoutConstraintsmakeConstraints(String constraintString)
Create an instance of TableLayoutConstraints from the specified string.
static voidparseConstraintString(TableLayoutConstraints constraints, String constraintString, boolean isRow)
Parse the constraint string.
voidsetColumn(int column)
Set the column.
voidsetColumnSpan(int span)
Set the number of columns that this component will span.
voidsetHorizontalAlignment(int alignment)
Set the horizontal alignment of the component within the specified area.
voidsetHorizontalStretch(boolean stretch)
Set whether or not this component can be stretched horizontally.
voidsetImmutable()
Make this object immutable.
voidsetObeyMaximumSize(boolean obey)
Set whether or not the component should obey it's maximum size.
voidsetObeyMinimumSize(boolean obey)
Set whether or not we should obey the minimum size of the component.
voidsetRow(int row)
Set the row.
voidsetRowSpan(int span)
Set the number of rows that this component will span.
voidsetVerticalAlignment(int alignment)
Set the vertical alignment of the component within the specified area.
voidsetVerticalStretch(boolean stretch)
Set whether or not this component can be stretched vertically.
StringtoString()
Return a string representation of this object.

Field Detail

columnSpan_

private int columnSpan_

column_

private int column_

horizontalAlignment_

private int horizontalAlignment_

horizontalStretch_

private boolean horizontalStretch_

isImmutable_

private boolean isImmutable_

obeyMaximumSize_

private boolean obeyMaximumSize_

obeyMinimumSize_

private boolean obeyMinimumSize_

rowSpan_

private int rowSpan_

row_

private int row_

serialVersionUID

private static final long serialVersionUID

verticalAlignment_

private int verticalAlignment_

verticalStretch_

private boolean verticalStretch_

Constructor Detail

TableLayoutConstraints

public TableLayoutConstraints(int row, int column)
Create a new instance.

Parameters: row The starting row. column The starting column.

Method Detail

assertNotNull

protected static final void assertNotNull(String fieldName, Object fieldValue)
Verify that the specified value is not null. If it is then throw an exception

Parameters: fieldName The name of the field to check fieldValue The value of the field to check

Throws: DetailedNullPointerException If fieldValue is null

ensureMutable

private void ensureMutable()
Check to make sure that we are allowed to modify this object. If not, throw an exception.

Throws: IllegalArgumentException If the object is immutable

getColumn

public final int getColumn()
Return the column.

Returns: The column.

getColumnSpan

public final int getColumnSpan()
Return the number of columns this component will span.

Returns: the column span.

getHorizontalAlignment

public final int getHorizontalAlignment()
Return the horizontalAlignment.

Returns: Return the horizontalAlignment.

getHorizontalStretch

public final boolean getHorizontalStretch()
Return true if this component can be stretched horizontally.

Returns: Return true if this component can be stretched horizontally.

getObeyMaximumSize

public final boolean getObeyMaximumSize()
Return true if we are obeying the maximum size.

Returns: Return true if we are obeying the maximum size.

getObeyMinimumSize

public final boolean getObeyMinimumSize()
Return true if we are obeying the minimum size.

Returns: Return true if we are obeying the minimum size.

getRow

public final int getRow()
Return the row.

Returns: The row.

getRowSpan

public final int getRowSpan()
Return the number of rows this component will span.

Returns: The row span.

getVerticalAlignment

public final int getVerticalAlignment()
Return the vertical alignment.

Returns: Return the vertical alignment.

getVerticalStretch

public final boolean getVerticalStretch()
Return true if this component can be stretched vertically.

Returns: Return true if this component can be stretched vertically.

isImmutable

public final boolean isImmutable()
Return true if this object is immutable.

Returns: Return true if this object is immutable.

makeConstraints

public static TableLayoutConstraints makeConstraints(String constraintString)
Create an instance of TableLayoutConstraints from the specified string. Format: "1,1"

Parameters: constraintString The constraints string.

Returns: A new TableLayoutConstraints object.

parseConstraintString

private static void parseConstraintString(TableLayoutConstraints constraints, String constraintString, boolean isRow)
Parse the constraint string.

Parameters: constraints The new constraints object constraintString The constraints as an input string isRow true if these constraints are for a row

setColumn

public final void setColumn(int column)
Set the column.

Parameters: column The new column.

setColumnSpan

public final void setColumnSpan(int span)
Set the number of columns that this component will span. The new span must be greater than or equal to one.

Parameters: span The new span.

setHorizontalAlignment

public final void setHorizontalAlignment(int alignment)
Set the horizontal alignment of the component within the specified area. Possible values are

Parameters: alignment The new alignment.

setHorizontalStretch

public final void setHorizontalStretch(boolean stretch)
Set whether or not this component can be stretched horizontally.

Parameters: stretch true if the component will stretch horizontally.

setImmutable

public final void setImmutable()
Make this object immutable.

setObeyMaximumSize

public final void setObeyMaximumSize(boolean obey)
Set whether or not the component should obey it's maximum size. Most components do not provide sensible maximum values so always obeying these values, ends up with very strange layouts. The default value is false.

Parameters: obey true if we are to obey the maximum size.

setObeyMinimumSize

public final void setObeyMinimumSize(boolean obey)
Set whether or not we should obey the minimum size of the component. Default is true.

Parameters: obey true if we are to obey the minimum size.

setRow

public final void setRow(int row)
Set the row.

Parameters: row The row.

setRowSpan

public final void setRowSpan(int span)
Set the number of rows that this component will span. The new span must be greater than or equal to one.

Parameters: span The new row span.

setVerticalAlignment

public final void setVerticalAlignment(int alignment)
Set the vertical alignment of the component within the specified area. Possible values are

Parameters: alignment The new alignment.

setVerticalStretch

public final void setVerticalStretch(boolean stretch)
Set whether or not this component can be stretched vertically.

Parameters: stretch true if the component will stretch vertically.

toString

public final String toString()
Return a string representation of this object.

Returns: Return a string representation of this object.