Fields

static int FREE_LABEL

An add() mode that allows a label to align to the left of the other labels in its column.

static int FREE_FIELD

An add() mode that allows a field to align to the right of the other fields in its column.

static int LABEL_ON_TOP

An add() mode that directs the label to align vertically adjacent the field in the row directly preceding it.

Constructors

FormLayout()

Constructs a new FormLayout with default gaps of internalHGap = 5, internalVGap = 5, externalHGap = 0, externalVGap = 0.

FormLayout(int gap)

Constructs a new FormLayout in which components are separated by gap pixels.

FormLayout(int internalHGap, int internalVGap, int externalHGap, int externalVGap)

Constructs a new FormLayout in which components are separated horizontally by internalHGap pixels, vertically by internalVGap, and the layout is bounded left and right by externalHGap, and top and bottom by externalVGap.

Methods

void layoutContainer(Container parent)

Lays out parent as specified by the add() methods.

Dimension minimumLayoutSize(Container parent)

The minimum size required to lay out parent as specified by the add() methods.

Dimension preferredLayoutSize(Container parent)

The preferred size desired to lay out parent as specified by the add() methods.

void removeLayoutComponent(Component component)

Remove component from the layout.

void add(Component component, int row, int column)

Adds component pair to row in column.

void add(Component label, Component field, int row, int column)

Adds the label/field pair to row in column.

void add(Component label, Component field, int row, int column, int mode)

Adds the label/field pair to row in column with special behavior as specified by mode.

void add(Component component, int row, int column, double fillRightPct)

add(Component, int, int) with the specified fillRightPct applied to field (see below).

void add(Component label, Component field, int row, int column, double fillRightPct)

add(Component, Component, int, int) with the specified fillRightPct applied to field (see below).

void add(Component label, Component field, int row, int column, int mode, double fillRightPct)

add(Component, Component, int, int, int) with the specified fillRightPct applied to field (see below).

void addMultiRow(Component component, int startRow, int endRow, int column)

Identical to add(Component, int, int) except that component occupies column from startRow to endRow.

void addMultiRow(Component label, Component field, int startRow, int endRow, int column)

Identical to add(Component, Component, int, int) except that field occupies column from startRow to endRow.

void addMultiRow(Component label, Component field, int startRow, int endRow, int column, int mode)

Identical to add(Component, Component, int, int, int) except that field occupies column from startRow to endRow.

void addMultiRow(Component component, int startRow, int endRow, int column, double fillRightPct)

Identical to add(Component, int, int, double) except that component occupies column from startRow to endRow.

void addMultiRow(Component label, Component field, int startRow, int endRow, int column, double fillRightPct)

Identical to add(Component, Component, int, int, double) except that field occupies column from startRow to endRow.

void addMultiRow(Component label, Component field, int startRow, int endRow, int column, int mode, double fillRightPct)

Identical to add(Component, Component, int, int, int, double) except that field occupies column from startRow to endRow.

int getInternalHGap()

Get the gap attribute value that determines distance between columns within the layout.

int getInternalVGap()

Get the gap attribute value that determines distance between rows within the layout.

int getExternalHGap()

Get the gap attribute value that determines the right and left padding of the container.

int getExternalVGap()

Get the gap attribute value that determines the top and bottom padding of the container.

void setInternalHGap(int gap)

Set the gap attribute value that determines distance between columns within the layout.

void setInternalVGap(int gap)

Set the gap attribute value that determines distance between rows within the layout.

void setExternalHGap(int gap)

Set the gap attribute value that determines the right and left padding of the container.

void setExternalVGap(int gap)

Set the gap attribute value that determines the top and bottom padding of the container.

void setDefaultFillRightPct(double fillRightPct)

add() and addMultiRow() calls on this FormLayout that do not specify a fillRightPct will henceforth use fillRightPct.

void getDefaultFillRightPct()

Get the current default fillRightPct.

fillRightPct

Domain: 0 <= fillRightPct <= 1

This parameter specifies how far beyond its preferred width a component is willing to stretch when the horizontal space available exceeds the component's preferred width. If the component can fill the entire space with a width of:


component.getPreferredSize() + ((component.getPreferredSize() - component.getMinimumSize()) * fillRightPct),

then it will do so. Otherwise, it will stay at its preferred width and leave blank space to its right. A fillRightPct of 1 will always stretch the component to fill the entire space available (up to its maxiumum width).

Use this to right justify your form by setting the fillRightPct of each of the rightmost components to 1. Or, call setDefaultFillRightPct(1) before adding the rightmost components. Use an intermediate value if you like the right justified effect, but don't want your small components to stretch beyond proportion to their width and flexibility. Set the fillRightPct to 0 if you don't want a component to stretch beyond its preferred width (the initial fillRightPct default is 0).

Terminated Methods

from javax.swing.LayoutManager

void addLayoutComponent(String name, Component comp)