Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.component.panel

Class DefaultFormBuilder<B extends FormBuilder<B>>

java.lang.Object

is.codion.swing.common.ui.component.builder.AbstractComponentBuilder<JPanel,B>

is.codion.swing.common.ui.component.panel.DefaultFormBuilder<B>

Type Parameters:

B - the builder type

All Implemented Interfaces:

ComponentBuilder<JPanel,B>, FormBuilder<B>, Supplier<JPanel>

Direct Known Subclasses:

EditorComponents.ComponentFactory.AttributeFormBuilder

public class DefaultFormBuilder<B extends FormBuilder<B>>
extends AbstractComponentBuilder<JPanel,B>
implements FormBuilder<B>

A default FormBuilder implementation, extendable in order to add further ways of adding inputs.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultFormBuilder()	Instantiates a new DefaultFormBuilder

Method Summary

Modifier and Type	Method	Description
final B	add(Supplier<? extends JComponent> component)	Adds a label/input pair, the label being the one associated with the component via JLabel.setLabelFor(java.awt.Component), if any, otherwise the component occupies the input column alone, the label cell empty.
final B	add(Supplier<? extends JComponent> label, Supplier<? extends JComponent> component)	Adds a label/input pair.
final B	add(JComponent component)	Adds a label/input pair, the label being the one associated with the component via JLabel.setLabelFor(java.awt.Component), if any, otherwise the component occupies the input column alone, the label cell empty.
final B	add(JComponent label, JComponent component)	Adds a label/input pair.
final B	columns(int columns)
protected final JPanel	createComponent()	Creates the component.
final B	labelAlignment(int labelAlignment)
final B	span(Supplier<? extends JComponent> component)	Adds a component occupying a row of its own.
final B	span(JComponent component)	Adds a component occupying a row of its own.

Methods inherited from class is.codion.swing.common.ui.component.builder.AbstractComponentBuilder

ancestorListener, background, border, build, build, clientProperty, componentListener, componentOrientation, configureComponent, enable, enabled, enabled, focusable, focusable, focusCycleRoot, focusListener, font, font, foreground, hierarchyListener, input, keyEvent, keyListener, label, label, label, label, maximumHeight, maximumSize, maximumWidth, minimumHeight, minimumSize, minimumWidth, mouseListener, mouseMotionListener, mouseWheelListener, name, onBuild, onSetVisible, opaque, popupControl, popupControls, popupControls, popupMenu, preferredHeight, preferredSize, preferredWidth, propertyChangeListener, propertyChangeListener, scrollPane, self, setName, toolTipText, toolTipText, transferFocusOnEnter, transferFocusOnEnter, transferHandler, visible, visible

Methods inherited from class java.lang.Object

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

Methods inherited from interface is.codion.swing.common.ui.component.builder.ComponentBuilder

ancestorListener, background, border, build, build, clientProperty, componentListener, componentOrientation, enabled, enabled, focusable, focusable, focusCycleRoot, focusListener, font, font, foreground, get, hierarchyListener, keyEvent, keyListener, label, label, label, maximumHeight, maximumSize, maximumWidth, minimumHeight, minimumSize, minimumWidth, mouseListener, mouseMotionListener, mouseWheelListener, name, onBuild, onSetVisible, opaque, popupControl, popupControls, popupControls, popupMenu, preferredHeight, preferredSize, preferredWidth, propertyChangeListener, propertyChangeListener, scrollPane, toolTipText, toolTipText, transferFocusOnEnter, transferFocusOnEnter, transferHandler, visible, visible

Constructor Details

DefaultFormBuilder

protected DefaultFormBuilder()

Instantiates a new DefaultFormBuilder

Method Details

columns

public final B columns(int columns)

Specified by:

columns in interface FormBuilder<B extends FormBuilder<B>>

Parameters:

columns - the number of label/input pairs per row, default 1

Returns:

this builder instance

labelAlignment

public final B labelAlignment(int labelAlignment)

Specified by:

labelAlignment in interface FormBuilder<B extends FormBuilder<B>>

Parameters:

labelAlignment - the horizontal alignment of the labels within the label column, SwingConstants.LEADING (default) or SwingConstants.TRAILING

Returns:

this builder instance

add

public final B add(JComponent component)

Description copied from interface: FormBuilder

Adds a label/input pair, the label being the one associated with the component via JLabel.setLabelFor(java.awt.Component), if any, otherwise the component occupies the input column alone, the label cell empty.

Specified by:

add in interface FormBuilder<B extends FormBuilder<B>>

Parameters:

component - the input component

Returns:

this builder instance

add

public final B add(Supplier<? extends JComponent> component)

Description copied from interface: FormBuilder

Adds a label/input pair, the label being the one associated with the component via JLabel.setLabelFor(java.awt.Component), if any, otherwise the component occupies the input column alone, the label cell empty.

Specified by:

add in interface FormBuilder<B extends FormBuilder<B>>

Parameters:

component - the input component

Returns:

this builder instance

add

public final B add(JComponent label,
 JComponent component)

Description copied from interface: FormBuilder

Adds a label/input pair. A JLabel carrying no association of its own is associated with the component, so that its mnemonic focuses it.

Specified by:

add in interface FormBuilder<B extends FormBuilder<B>>

Parameters:

label - the label

component - the input component

Returns:

this builder instance

add

public final B add(Supplier<? extends JComponent> label,
 Supplier<? extends JComponent> component)

Description copied from interface: FormBuilder

Adds a label/input pair. A JLabel carrying no association of its own is associated with the component, so that its mnemonic focuses it.

Specified by:

add in interface FormBuilder<B extends FormBuilder<B>>

Parameters:

label - the label

component - the input component

Returns:

this builder instance

span

public final B span(JComponent component)

Description copied from interface: FormBuilder

Adds a component occupying a row of its own. A label associated with the component keeps the label column, the component spanning the rest of the row, otherwise the component spans the full width.

Specified by:

span in interface FormBuilder<B extends FormBuilder<B>>

Parameters:

component - the component

Returns:

this builder instance

span

public final B span(Supplier<? extends JComponent> component)

Description copied from interface: FormBuilder

Adds a component occupying a row of its own. A label associated with the component keeps the label column, the component spanning the rest of the row, otherwise the component spans the full width.

Specified by:

span in interface FormBuilder<B extends FormBuilder<B>>

Parameters:

component - the component

Returns:

this builder instance

createComponent

protected final JPanel createComponent()

Description copied from class: AbstractComponentBuilder

Creates the component.

Specified by:

createComponent in class AbstractComponentBuilder<JPanel,B extends FormBuilder<B>>

Returns:

a new component instance