com.jgoodies.forms.builder
public abstract class AbstractFormBuilder extends Object
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.
Version: $Revision: 1.3 $
See Also: ButtonBarBuilder ButtonStackBuilder PanelBuilder I15dPanelBuilder DefaultFormBuilder
Constructor Summary | |
---|---|
AbstractFormBuilder(FormLayout layout, Container container)
Constructs a AbstractFormBuilder
for the given FormLayout and layout container.
|
Method Summary | |
---|---|
Component | add(Component component, CellConstraints cellConstraints)
Adds a component to the panel using the given cell constraints.
|
Component | add(Component component, String encodedCellConstraints)
Adds a component to the panel using the given encoded cell constraints.
|
Component | add(Component component)
Adds a component to the container using the default cell constraints.
|
void | appendColumn(ColumnSpec columnSpec)
Appends the given column specification to the builder's layout.
|
void | appendColumn(String encodedColumnSpec)
Appends a column specification to the builder's layout
that represents the given string encoding.
|
void | appendGlueColumn()
Appends a glue column.
|
void | appendGlueRow()
Appends a glue row.
|
void | appendLabelComponentsGapColumn()
Appends a column that is the default gap between a label and
its associated component.
|
void | appendParagraphGapRow()
Appends a row that is the default gap for paragraphs.
|
void | appendRelatedComponentsGapColumn()
Appends a column that is the default gap for related components.
|
void | appendRelatedComponentsGapRow()
Appends a row that is the default gap for related components.
|
void | appendRow(RowSpec rowSpec)
Appends the given row specification to the builder's layout.
|
void | appendRow(String encodedRowSpec)
Appends a row specification to the builder's layout that represents
the given string encoding.
|
void | appendUnrelatedComponentsGapColumn()
Appends a column that is the default gap for unrelated components.
|
void | appendUnrelatedComponentsGapRow()
Appends a row that is the default gap for unrelated components.
|
protected CellConstraints | cellConstraints()
Returns the CellConstraints object that is used as a cursor and
holds the current column span and row span.
|
protected CellConstraints | createLeftAdjustedConstraints(int columnSpan)
Creates and returns a CellConstraints object at
the current cursor position that uses the given column span
and is adjusted to the left. |
int | getColumn()
Returns the cursor's column.
|
int | getColumnCount()
Returns the number of columns in the form.
|
protected int | getColumnIncrementSign()
Returns the sign (-1 or 1) used to increment the cursor's column
when moving to the next column.
|
Container | getContainer()
Returns the container used to build the form.
|
FormLayout | getLayout()
Returns the instance of {@link FormLayout} used to build this form.
|
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. |
int | getRow()
Returns the cursor's row.
|
int | getRowCount()
Returns the number of rows in the form.
|
boolean | isLeftToRight()
Returns whether this builder fills the form left-to-right
or right-to-left. |
void | nextColumn()
Moves to the next column, does the same as #nextColumn(1). |
void | nextColumn(int columns)
Moves to the next column.
|
void | nextLine()
Moves to the next line: increases the row and resets the column;
does the same as #nextLine(1). |
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.
|
void | nextRow()
Increases the row by one; does the same as #nextRow(1). |
void | nextRow(int rows)
Increases the row by the specified rows.
|
void | setAlignment(CellConstraints.Alignment hAlign, CellConstraints.Alignment vAlign)
Sets the horizontal and vertical alignment.
|
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.
|
void | setColumn(int column)
Sets the cursor to the given column.
|
void | setColumnSpan(int columnSpan)
Sets the cursor's column span.
|
void | setExtent(int columnSpan, int rowSpan)
Sets the cursor's extent to the given column span and row span.
|
void | setHAlignment(CellConstraints.Alignment alignment)
Sets the horizontal alignment.
|
void | setLeftToRight(boolean b)
Sets the form fill direction to left-to-right or right-to-left.
|
void | setOrigin(int column, int row)
Sets the cursor's origin to the given column and row.
|
void | setRow(int row)
Sets the cursor to the given row.
|
void | setRowSpan(int rowSpan)
Sets the cursor's row span.
|
void | setVAlignment(CellConstraints.Alignment alignment)
Sets the vertical alignment.
|
AbstractFormBuilder
for the given FormLayout and layout container.
Parameters: layout the {@link FormLayout} to use container the layout container
Throws: NullPointerException if the layout or container is null
Parameters: component the component to add cellConstraints the component's cell constraints
Returns: the added component
Parameters: component the component to add encodedCellConstraints the component's encoded cell constraints
Returns: the added component
Parameters: component the component to add
Returns: the added component
See Also: AbstractFormBuilder AbstractFormBuilder
Parameters: columnSpec the column specification object to append
See Also: appendColumn
Parameters: encodedColumnSpec the column specification to append in encoded form
See Also: appendColumn
See Also: appendLabelComponentsGapColumn appendRelatedComponentsGapColumn appendUnrelatedComponentsGapColumn
See Also: appendRelatedComponentsGapRow appendUnrelatedComponentsGapRow appendParagraphGapRow
Since: 1.0.3
See Also: appendGlueColumn appendRelatedComponentsGapColumn appendUnrelatedComponentsGapColumn
Since: 1.0.3
See Also: appendGlueRow appendRelatedComponentsGapRow appendUnrelatedComponentsGapRow
See Also: appendGlueColumn appendLabelComponentsGapColumn appendUnrelatedComponentsGapColumn
See Also: appendGlueRow appendUnrelatedComponentsGapRow appendParagraphGapRow
Parameters: rowSpec the row specification object to append
See Also: appendRow
Parameters: encodedRowSpec the row specification to append in encoded form
See Also: appendRow
See Also: appendGlueColumn appendLabelComponentsGapColumn appendRelatedComponentsGapColumn
See Also: appendGlueRow appendRelatedComponentsGapRow appendParagraphGapRow
Returns: the builder's current {@link CellConstraints} object
CellConstraints
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
Returns: the cursor's column
Returns: the number of columns
Returns: -1 for right-to-left, 1 for left-to-right
Returns: the layout container
Returns: the FormLayout
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
Returns: the cursor's row
Returns: the number of rows
componentOrientation
property.
Returns: true indicates left-to-right, false indicates right-to-left
See Also: AbstractFormBuilder ComponentOrientation
Parameters: columns number of columns to move
Parameters: lines number of rows to move
Parameters: rows number of rows to move
Parameters: hAlign the new horizontal alignment vAlign the new vertical alignment
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)
Parameters: column the cursor's new column index
Parameters: columnSpan the cursor's new column span (grid width)
Parameters: columnSpan the new column span (grid width) rowSpan the new row span (grid height)
Parameters: alignment the new horizontal alignment
componentOrientation
property.
Parameters: b true indicates left-to-right, false right-to-left
See Also: isLeftToRight ComponentOrientation
Parameters: column the new column index row the new row index
Parameters: row the cursor's new row index
Parameters: rowSpan the cursor's new row span (grid height)
Parameters: alignment the new vertical alignment