Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
com.jgoodies.forms.builder.AbstractFormBuilder
public abstract class AbstractFormBuilder
extends java.lang.Object
FormLayout
.
Builders hide details of the FormLayout and provide convenience behavior
that assists you in constructing a form.
This class provides a cell cursor that helps you traverse a form while
you add components. Also, it offers several methods to append custom
and logical columns and rows.
Constructor Summary | |
| |
|
Method Summary | |
Component |
|
Component |
|
Component |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void | |
void |
|
void |
|
protected CellConstraints |
|
protected CellConstraints |
|
int |
|
int |
|
protected int |
|
Container |
|
FormLayout |
|
protected int |
|
int |
|
int |
|
boolean |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
public AbstractFormBuilder(Container container, FormLayout layout)
Deprecated. Replaced by
AbstractFormBuilder(FormLayout,Container)
.Constructs an instance ofAbstractFormBuilder
for the given container and form layout.
- Parameters:
container
- the layout containerlayout
- theFormLayout
to use
public AbstractFormBuilder(FormLayout layout, Container container)
Constructs an instance ofAbstractFormBuilder
for the given FormLayout and layout container.
- Parameters:
layout
- theFormLayout
to usecontainer
- the layout container
public final Component add(Component component)
Adds a component to the container using the default cell constraints. Note that when building from left to right, this method won't adjust the cell constraints if the column span is larger than 1. In this case you should useadd(Component,CellConstraints)
with a cell constraints object created bycreateLeftAdjustedConstraints(int)
.
- Parameters:
component
- the component to add
- Returns:
- the added component
public final Component add(Component component, String encodedCellConstraints)
Adds a component to the panel using the given encoded cell constraints.
- Parameters:
component
- the component to addencodedCellConstraints
- the component's encoded cell constraints
- Returns:
- the added component
public final Component add(Component component, CellConstraints cellConstraints)
Adds a component to the panel using the given cell constraints.
- Parameters:
component
- the component to addcellConstraints
- the component's cell constraints
- Returns:
- the added component
public final void appendColumn(String encodedColumnSpec)
Appends a column specification to the builder's layout that represents the given string encoding.
- Parameters:
encodedColumnSpec
- the column specification to append in encoded form
- See Also:
appendColumn(ColumnSpec)
public final void appendColumn(ColumnSpec columnSpec)
Appends the given column specification to the builder's layout.
- Parameters:
columnSpec
- the column specification object to append
- See Also:
appendColumn(String)
public final void appendGlueColumn()
Appends a glue column.
public final void appendGlueRow()
Appends a glue row.
public final void appendLabelComponentsGapColumn()
Appends a column that is the default gap between a label and its associated component.
- Since:
- 1.0.3
public final void appendParagraphGapRow()
Appends a row that is the default gap for paragraphs.
- Since:
- 1.0.3
public final void appendRelatedComponentsGapColumn()
Appends a column that is the default gap for related components.
public final void appendRelatedComponentsGapRow()
Appends a row that is the default gap for related components.
public final void appendRow(String encodedRowSpec)
Appends a row specification to the builder's layout that represents the given string encoding.
- Parameters:
encodedRowSpec
- the row specification to append in encoded form
- See Also:
appendRow(RowSpec)
public final void appendRow(RowSpec rowSpec)
Appends the given row specification to the builder's layout.
- Parameters:
rowSpec
- the row specification object to append
- See Also:
appendRow(String)
public final void appendUnrelatedComponentsGapColumn()
Appends a column that is the default gap for unrelated components.
public final void appendUnrelatedComponentsGapRow()
Appends a row that is the default gap for unrelated components.
protected final CellConstraints cellConstraints()
Returns the CellConstraints object that is used as a cursor and holds the current column span and row span.
- Returns:
- the builder's current
CellConstraints
object
protected final CellConstraints createLeftAdjustedConstraints(int columnSpan)
Creates and returns aCellConstraints
object at the current cursor position that uses the given column span and is adjusted to the left. Useful when building from right to left.
- Parameters:
columnSpan
- the column span to be used in the constraints
- Returns:
- CellConstraints adjusted to the left hand side
public final int getColumn()
Returns the cursor's column.
- Returns:
- the cursor's column
public final int getColumnCount()
Returns the number of columns in the form.
- Returns:
- the number of columns
protected final int getColumnIncrementSign()
Returns the sign (-1 or 1) used to increment the cursor's column when moving to the next column.
- Returns:
- -1 for right-to-left, 1 for left-to-right
public final Container getContainer()
Returns the container used to build the form.
- Returns:
- the layout container
public final FormLayout getLayout()
Returns the instance ofFormLayout
used to build this form.
- Returns:
- the FormLayout
protected int getLeadingColumn()
Returns the index of the leading column. Subclasses may override this method, for example, if the form has a leading gap column that should not be filled with components.
- Returns:
- the leading column
public final int getRow()
Returns the cursor's row.
- Returns:
- the cursor's row
public final int getRowCount()
Returns the number of rows in the form.
- Returns:
- the number of rows
public final boolean isLeftToRight()
Returns whether this builder fills the form left-to-right or right-to-left. The initial value of this property is set during the builder construction from the layout container'scomponentOrientation
property.
- Returns:
- true indicates left-to-right, false indicates right-to-left
- See Also:
setLeftToRight(boolean)
,ComponentOrientation
public final void nextColumn()
Moves to the next column, does the same as #nextColumn(1).
public final void nextColumn(int columns)
Moves to the next column.
- Parameters:
columns
- number of columns to move
public final void nextLine()
Moves to the next line: increases the row and resets the column; does the same as #nextLine(1).
public final void nextLine(int lines)
Moves the cursor down several lines: increases the row by the specified number of lines and sets the cursor to the leading column.
- Parameters:
lines
- number of rows to move
public final void nextRow()
Increases the row by one; does the same as #nextRow(1).
public final void nextRow(int rows)
Increases the row by the specified rows.
- Parameters:
rows
- number of rows to move
public final void setAlignment(CellConstraints.Alignment hAlign, CellConstraints.Alignment vAlign)
Sets the horizontal and vertical alignment.
- Parameters:
hAlign
- the new horizontal alignmentvAlign
- the new vertical alignment
public final void setBounds(int column, int row, int columnSpan, int rowSpan)
Sets the cell bounds (location and extent) to the given column, row, column span and row span.
- Parameters:
column
- the new column index (grid x)row
- the new row index (grid y)columnSpan
- the new column span (grid width)rowSpan
- the new row span (grid height)
public final void setColumn(int column)
Sets the cursor to the given column.
- Parameters:
column
- the cursor's new column index
public final void setColumnSpan(int columnSpan)
Sets the cursor's column span.
- Parameters:
columnSpan
- the cursor's new column span (grid width)
public final void setExtent(int columnSpan, int rowSpan)
Sets the cursor's extent to the given column span and row span.
- Parameters:
columnSpan
- the new column span (grid width)rowSpan
- the new row span (grid height)
public final void setHAlignment(CellConstraints.Alignment alignment)
Sets the horizontal alignment.
- Parameters:
alignment
- the new horizontal alignment
public final void setLeftToRight(boolean b)
Sets the form fill direction to left-to-right or right-to-left. The initial value of this property is set during the builder construction from the layout container'scomponentOrientation
property.
- Parameters:
b
- true indicates left-to-right, false right-to-left
- See Also:
isLeftToRight()
,ComponentOrientation
public final void setOrigin(int column, int row)
Sets the cursor's origin to the given column and row.
- Parameters:
column
- the new column indexrow
- the new row index
public final void setRow(int row)
Sets the cursor to the given row.
- Parameters:
row
- the cursor's new row index
public final void setRowSpan(int rowSpan)
Sets the cursor's row span.
- Parameters:
rowSpan
- the cursor's new row span (grid height)
public final void setVAlignment(CellConstraints.Alignment alignment)
Sets the vertical alignment.
- Parameters:
alignment
- the new vertical alignment