org.jfree.layout

Class FormatLayout

public class FormatLayout extends Object implements LayoutManager, Serializable

A layout manager that spaces components over six columns in seven different formats.

Author: David Gilbert

Field Summary
static intC
A useful constant representing layout format 1.
static intLC
A useful constant representing layout format 2.
static intLCB
A useful constant representing layout format 3.
static intLCBLC
A useful constant representing layout format 6.
static intLCBLCB
A useful constant representing layout format 7.
static intLCLC
A useful constant representing layout format 4.
static intLCLCB
A useful constant representing layout format 5.
Constructor Summary
FormatLayout(int rowCount, int[] rowFormats)
Constructs a new layout manager that can be used to create input forms.
Method Summary
voidaddLayoutComponent(Component comp)
Not used.
voidaddLayoutComponent(String name, Component comp)
Not used.
voidcomplete()
Finishes of the processing.
voidlayoutContainer(Container parent)
Performs the layout of the container.
DimensionminimumLayoutSize(Container parent)
Returns the minimum size of the component using this layout manager.
DimensionpreferredLayoutSize(Container parent)
Returns the preferred size of the component using this layout manager.
voidremoveLayoutComponent(Component comp)
Not used.
voidremoveLayoutComponent(String name, Component comp)
Not used.
protected voidupdateC(int rowIndex, Dimension d0)
Processes a row in 'C' format.
protected voidupdateLC(int rowIndex, Dimension d0, Dimension d1)
Processes a row in 'LC' format.
protected voidupdateLCB(int rowIndex, Dimension d0, Dimension d1, Dimension d2)
Processes a row in 'LCB' format.
protected voidupdateLCBLC(int rowIndex, Dimension d0, Dimension d1, Dimension d2, Dimension d3, Dimension d4)
Processes a row in 'LCBLC' format.
protected voidupdateLCBLCB(int rowIndex, Dimension d0, Dimension d1, Dimension d2, Dimension d3, Dimension d4, Dimension d5)
Processes a row in 'LCBLCB' format.
protected voidupdateLCLC(int rowIndex, Dimension d0, Dimension d1, Dimension d2, Dimension d3)
Processes a row in 'LCLC' format.
protected voidupdateLCLCB(int rowIndex, Dimension d0, Dimension d1, Dimension d2, Dimension d3, Dimension d4)
Processes a row in 'LCLCB' format.

Field Detail

C

public static final int C
A useful constant representing layout format 1.

LC

public static final int LC
A useful constant representing layout format 2.

LCB

public static final int LCB
A useful constant representing layout format 3.

LCBLC

public static final int LCBLC
A useful constant representing layout format 6.

LCBLCB

public static final int LCBLCB
A useful constant representing layout format 7.

LCLC

public static final int LCLC
A useful constant representing layout format 4.

LCLCB

public static final int LCLCB
A useful constant representing layout format 5.

Constructor Detail

FormatLayout

public FormatLayout(int rowCount, int[] rowFormats)
Constructs a new layout manager that can be used to create input forms. The layout manager works by arranging components in rows using six columns (some components will use more than one column).

Any component can be added, but I think of them in terms of Labels, Components, and Buttons. The formats available are: C, LC, LCB, LCLC, LCLCB, LCBLC or LCBLCB.

C 1 component in this row (spread across all six columns).
LC 2 components, a label in the 1st column, and a component using the remaining 5 columns).
LCB 3 components, a label in the 1st column, a component spread across the next 4, and a button in the last column.
LCLC 4 components, a label in column 1, a component in 2-3, a label in 4 and a component in 5-6.
LCLCB 5 components, a label in column 1, a component in 2-3, a label in 4, a component in 5 and a button in 6.
LCBLC 5 components, a label in column 1, a component in 2, a button in 3, a label in 4, a component in 5-6.
LCBLCB 6 components, one in each column.

Columns 1 and 4 expand to accommodate the widest label, and 3 and 6 to accommodate the widest button.

Each row will contain the number of components indicated by the format. Be sure to specify enough row formats to cover all the components you add to the layout.

Parameters: rowCount the number of rows. rowFormats the row formats.

Method Detail

addLayoutComponent

public void addLayoutComponent(Component comp)
Not used.

Parameters: comp the component.

addLayoutComponent

public void addLayoutComponent(String name, Component comp)
Not used.

Parameters: name the component name. comp the component.

complete

public void complete()
Finishes of the processing.

layoutContainer

public void layoutContainer(Container parent)
Performs the layout of the container.

Parameters: parent the parent.

minimumLayoutSize

public Dimension minimumLayoutSize(Container parent)
Returns the minimum size of the component using this layout manager.

Parameters: parent the parent.

Returns: the minimum size of the component

preferredLayoutSize

public Dimension preferredLayoutSize(Container parent)
Returns the preferred size of the component using this layout manager.

Parameters: parent the parent.

Returns: the preferred size of the component.

removeLayoutComponent

public void removeLayoutComponent(Component comp)
Not used.

Parameters: comp the component.

removeLayoutComponent

public void removeLayoutComponent(String name, Component comp)
Not used.

Parameters: name the component name. comp the component.

updateC

protected void updateC(int rowIndex, Dimension d0)
Processes a row in 'C' format.

Parameters: rowIndex the row index. d0 dimension 0.

updateLC

protected void updateLC(int rowIndex, Dimension d0, Dimension d1)
Processes a row in 'LC' format.

Parameters: rowIndex the row index. d0 dimension 0. d1 dimension 1.

updateLCB

protected void updateLCB(int rowIndex, Dimension d0, Dimension d1, Dimension d2)
Processes a row in 'LCB' format.

Parameters: rowIndex the row index. d0 dimension 0. d1 dimension 1. d2 dimension 2.

updateLCBLC

protected void updateLCBLC(int rowIndex, Dimension d0, Dimension d1, Dimension d2, Dimension d3, Dimension d4)
Processes a row in 'LCBLC' format.

Parameters: rowIndex the row index. d0 dimension 0. d1 dimension 1. d2 dimension 2. d3 dimension 3. d4 dimension 4.

updateLCBLCB

protected void updateLCBLCB(int rowIndex, Dimension d0, Dimension d1, Dimension d2, Dimension d3, Dimension d4, Dimension d5)
Processes a row in 'LCBLCB' format.

Parameters: rowIndex the row index. d0 dimension 0. d1 dimension 1. d2 dimension 2. d3 dimension 3. d4 dimension 4. d5 dimension 5.

updateLCLC

protected void updateLCLC(int rowIndex, Dimension d0, Dimension d1, Dimension d2, Dimension d3)
Processes a row in 'LCLC' format.

Parameters: rowIndex the row index. d0 dimension 0. d1 dimension 1. d2 dimension 2. d3 dimension 3.

updateLCLCB

protected void updateLCLCB(int rowIndex, Dimension d0, Dimension d1, Dimension d2, Dimension d3, Dimension d4)
Processes a row in 'LCLCB' format.

Parameters: rowIndex the row index. d0 dimension 0. d1 dimension 1. d2 dimension 2. d3 dimension 3. d4 dimension 4.