com.luciad.lucy.gui

LuciadLightspeedClass TLcyTwoColumnLayoutBuilder.RowBuilder

java.lang.Object

com.luciad.lucy.gui.TLcyTwoColumnLayoutBuilder.RowBuilder

Enclosing class:

TLcyTwoColumnLayoutBuilder

public static final class TLcyTwoColumnLayoutBuilder.RowBuilder
extends Object

Class following the Builder pattern which allows to add a row to a two column layout.

Since:

2012.0

Method Summary

Modifier and Type	Method and Description
TLcyTwoColumnLayoutBuilder	build() Call this method when all components for the row are specified.
TLcyTwoColumnLayoutBuilder.RowBuilder	columnOne(Component aComponent) Add a component which spans the whole width of the first column
TLcyTwoColumnLayoutBuilder.RowBuilder	columnOne(Component aLabel, Component aComponent) Add a label and/or component to the first column of this row
TLcyTwoColumnLayoutBuilder.RowBuilder	columnTwo(Component aComponent) Add a component which spans the whole width of the second column
TLcyTwoColumnLayoutBuilder.RowBuilder	columnTwo(Component aLabel, Component aComponent) Add a label and/or component to the second column of this row
TLcyTwoColumnLayoutBuilder.RowBuilder	growVertically(boolean aGrowVertically) Specify whether the row should grow vertically or not.
TLcyTwoColumnLayoutBuilder.RowBuilder	spanBothColumns(Component aComponent) Add a component which spans the whole width of the two columns.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

columnOne

public TLcyTwoColumnLayoutBuilder.RowBuilder columnOne(Component aLabel,
                                                       Component aComponent)

Add a label and/or component to the first column of this row

Parameters:

aLabel - The label component. May be null in case aComponent is not null

aComponent - The editor component. May be null in case aLabel is not null

Returns:

this

columnOne

public TLcyTwoColumnLayoutBuilder.RowBuilder columnOne(Component aComponent)

Add a component which spans the whole width of the first column

Parameters:

aComponent - The component. Must not be null

Returns:

this

columnTwo

public TLcyTwoColumnLayoutBuilder.RowBuilder columnTwo(Component aLabel,
                                                       Component aComponent)

Add a label and/or component to the second column of this row

Parameters:

aLabel - The label component. May be null in case aComponent is not null

aComponent - The editor component. May be null in case aLabel is not null

Returns:

this

columnTwo

public TLcyTwoColumnLayoutBuilder.RowBuilder columnTwo(Component aComponent)

Add a component which spans the whole width of the second column

Parameters:

aComponent - The component. Must not be null

Returns:

this

spanBothColumns

public TLcyTwoColumnLayoutBuilder.RowBuilder spanBothColumns(Component aComponent)

Add a component which spans the whole width of the two columns.

In case aComponent is a container where the child components were added using the TLcyTwoColumnLayoutBuilder, the layout of aComponent and the layout of the panel for which this builder is used will be aligned.

Parameters:

aComponent - The component

Returns:

this

growVertically

public TLcyTwoColumnLayoutBuilder.RowBuilder growVertically(boolean aGrowVertically)

Specify whether the row should grow vertically or not. The default value is false

Parameters:

aGrowVertically - true when the row should grow vertically, false otherwise

Returns:

this

build

public TLcyTwoColumnLayoutBuilder build()

Call this method when all components for the row are specified. This will return the outer builder instance

Returns:

the outer builder instance for which this row builder is used.