Module is.codion.swing.framework.ui

Package is.codion.swing.framework.ui.component

Class EntityComponents

java.lang.Object

is.codion.swing.framework.ui.component.EntityComponents

public final class EntityComponents
extends Object

A factory for ComponentBuilder instances based on attributes from a given entity definition.

See Also:

• entityComponents(EntityDefinition)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EntityComponents.EntityListBuilderFactory<T>	A factory for list builders.

Method Summary

Modifier and Type	Method	Description
NumberField.Builder<BigDecimal>	bigDecimalField(Attribute<BigDecimal> attribute)	Creates a NumberField builder based on the given attribute.
ItemComboBoxBuilder<Boolean>	booleanComboBox(Attribute<Boolean> attribute)	Creates a boolean ComboBox builder based on the given attribute.
ComponentBuilder<byte[],FileInputPanel,FileInputPanel.Builder<byte[]>>	byteArrayInputPanel(Attribute<byte[]> attribute)	Creates a byte array based FileInputPanel builder based on the given attribute.
CheckBoxBuilder	checkBox(Attribute<Boolean> attribute)	Creates a CheckBox builder based on the given attribute.
<T, C extends JComboBox<T>, B extends ComboBoxBuilder<T, C, B>> ComboBoxBuilder<T,C,B>	comboBox(Attribute<T> attribute, ComboBoxModel<T> comboBoxModel)	Creates a JComboBox builder based on the given attribute.
<T, C extends JComponent, B extends ComponentBuilder<T, C, B>> ComponentBuilder<T,C,B>	component(Attribute<T> attribute)	Returns a ComponentBuilder instance for a default input component for the given attribute.
NumberField.Builder<Double>	doubleField(Attribute<Double> attribute)	Creates a NumberField builder based on the given attribute.
NumberSpinnerBuilder<Double>	doubleSpinner(Attribute<Double> attribute)	Creates a JSpinner builder based on the given attribute.
static EntityComponents	entityComponents(EntityDefinition entityDefinition)
EntityDefinition	entityDefinition()
EntityComboBox.Builder	foreignKeyComboBox(ForeignKey foreignKey, EntityComboBoxModel comboBoxModel)	Creates a foreign key ComboBox builder based on the given foreign key.
EntityComboBoxPanel.Builder	foreignKeyComboBoxPanel(ForeignKey foreignKey, EntityComboBoxModel comboBoxModel, Supplier<EntityEditPanel> editPanel)	Creates a builder for a foreign key combo box panel with optional buttons for adding and editing items.
LabelBuilder<Entity>	foreignKeyLabel(ForeignKey foreignKey)	Creates a foreign key label builder based on the given foreign key.
EntitySearchField.Builder	foreignKeySearchField(ForeignKey foreignKey, EntitySearchModel searchModel)	Creates a foreign key search field builder based on the given foreign key.
EntitySearchFieldPanel.Builder	foreignKeySearchFieldPanel(ForeignKey foreignKey, EntitySearchModel searchModel)	Creates a builder for a foreign key search field panel with an optional button for performing a search.
EntitySearchFieldPanel.Builder	foreignKeySearchFieldPanel(ForeignKey foreignKey, EntitySearchModel searchModel, Supplier<EntityEditPanel> editPanel)	Creates a builder for a foreign key search field panel with optional buttons for adding and editing items.
<B extends TextFieldBuilder<Entity, JTextField, B>> TextFieldBuilder<Entity,JTextField,B>	foreignKeyTextField(ForeignKey foreignKey)	Creates foreign key text field builder for the given foreign key, read-only and non-focusable.
NumberField.Builder<Integer>	integerField(Attribute<Integer> attribute)	Creates a NumberField builder based on the given attribute.
NumberSpinnerBuilder<Integer>	integerSpinner(Attribute<Integer> attribute)	Creates a JSpinner builder based on the given attribute.
<T> ItemComboBoxBuilder<T>	itemComboBox(Attribute<T> attribute)	Creates a JComboBox builder based on the given attribute.
<T> ItemSpinnerBuilder<T>	itemSpinner(Attribute<T> attribute)	Creates a JSpinner builder based on the given attribute.
<T> EntityComponents.EntityListBuilderFactory<T>	list(ListModel<T> listModel)
<T> ListSpinnerBuilder<T>	listSpinner(Attribute<T> attribute, SpinnerListModel listModel)	Creates a JSpinner builder based on the given attribute.
NumberField.Builder<Long>	longField(Attribute<Long> attribute)	Creates a NumberField builder based on the given attribute.
MaskedTextFieldBuilder	maskedTextField(Attribute<String> attribute)	Creates a masked text field builder based on the given attribute.
NumberField.Builder<Short>	shortField(Attribute<Short> attribute)	Creates a NumberField builder based on the given attribute.
SliderBuilder	slider(Attribute<Integer> attribute)	Creates a JSlider builder based on the given attribute, with a bounded range model based on the min/max values of the associated attribute.
SliderBuilder	slider(Attribute<Integer> attribute, BoundedRangeModel boundedRangeModel)	Creates a JSlider builder based on the given attribute.
boolean	supports(Attribute<?> attribute)
<T extends Temporal> TemporalField.Builder<T>	temporalField(Attribute<T> attribute)	Creates a TemporalField builder based on the given attribute.
<T extends Temporal> TemporalFieldPanel.Builder<T>	temporalFieldPanel(Attribute<T> attribute)	Creates a TemporalFieldPanel builder based on the given attribute.
TextAreaBuilder	textArea(Attribute<String> attribute)	Creates a TextArea builder based on the given attribute.
<T, C extends JTextField, B extends TextFieldBuilder<T, C, B>> TextFieldBuilder<T,C,B>	textField(Attribute<T> attribute)	Creates a text field builder based on the given attribute.
TextFieldPanel.Builder	textFieldPanel(Attribute<String> attribute)	Creates a TextFieldPanel builder based on the given attribute.
<B extends ButtonBuilder<Boolean, JToggleButton, B>> ButtonBuilder<Boolean,JToggleButton,B>	toggleButton(Attribute<Boolean> attribute)	Creates a ToggleButton builder based on the given attribute.

Methods inherited from class java.lang.Object

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

Method Details

entityDefinition

public EntityDefinition entityDefinition()

Returns:

the underlying entity definition

supports

public boolean supports(Attribute<?> attribute)

Parameters:

attribute - the attribute

Returns:

true if component(Attribute) supports the given attribute

component

public <T,
C extends JComponent,
B extends ComponentBuilder<T,
C,
B>>
ComponentBuilder<T,C,B> component(Attribute<T> attribute)

Returns a ComponentBuilder instance for a default input component for the given attribute.

Type Parameters:

T - the attribute type

C - the component type

B - the builder type

Parameters:

attribute - the attribute for which to create the input component

Returns:

the component builder handling input for attribute

Throws:

IllegalArgumentException - in case the attribute type is not supported

See Also:

• supports(Attribute)

checkBox

public CheckBoxBuilder checkBox(Attribute<Boolean> attribute)

Creates a CheckBox builder based on the given attribute.

Parameters:

attribute - the attribute

Returns:

a JCheckBox builder

toggleButton

public <B extends ButtonBuilder<Boolean,
JToggleButton,
B>>
ButtonBuilder<Boolean,JToggleButton,B> toggleButton(Attribute<Boolean> attribute)

Creates a ToggleButton builder based on the given attribute.

Type Parameters:

B - the builder type

Parameters:

attribute - the attribute

Returns:

a JToggleButton builder

booleanComboBox

public ItemComboBoxBuilder<Boolean> booleanComboBox(Attribute<Boolean> attribute)

Creates a boolean ComboBox builder based on the given attribute.

Parameters:

attribute - the attribute

Returns:

a boolean JComboBox builder

foreignKeyComboBox

public EntityComboBox.Builder foreignKeyComboBox(ForeignKey foreignKey,
 EntityComboBoxModel comboBoxModel)

Creates a foreign key ComboBox builder based on the given foreign key.

Parameters:

foreignKey - the foreign key

comboBoxModel - the combo box model

Returns:

a foreign key JComboBox builder

foreignKeyComboBoxPanel

public EntityComboBoxPanel.Builder foreignKeyComboBoxPanel(ForeignKey foreignKey,
 EntityComboBoxModel comboBoxModel,
 Supplier<EntityEditPanel> editPanel)

Creates a builder for a foreign key combo box panel with optional buttons for adding and editing items.

Parameters:

foreignKey - the foreign key

comboBoxModel - the combo box model

editPanel - supplies the edit panel to use for the add and/or edit buttons

Returns:

a foreign key combo box panel builder

foreignKeySearchField

public EntitySearchField.Builder foreignKeySearchField(ForeignKey foreignKey,
 EntitySearchModel searchModel)

Creates a foreign key search field builder based on the given foreign key.

Parameters:

foreignKey - the foreign key

searchModel - the search model

Returns:

a foreign key EntitySearchField builder

foreignKeySearchFieldPanel

public EntitySearchFieldPanel.Builder foreignKeySearchFieldPanel(ForeignKey foreignKey,
 EntitySearchModel searchModel)

Creates a builder for a foreign key search field panel with an optional button for performing a search.

Parameters:

foreignKey - the foreign key

searchModel - the search model

Returns:

a foreign key search field panel builder

foreignKeySearchFieldPanel

public EntitySearchFieldPanel.Builder foreignKeySearchFieldPanel(ForeignKey foreignKey,
 EntitySearchModel searchModel,
 Supplier<EntityEditPanel> editPanel)

Creates a builder for a foreign key search field panel with optional buttons for adding and editing items.

Parameters:

foreignKey - the foreign key

searchModel - the search model

editPanel - supplies the edit panel to use for the add and/or edit buttons

Returns:

a foreign key search field panel builder

foreignKeyTextField

public <B extends TextFieldBuilder<Entity,
JTextField,
B>>
TextFieldBuilder<Entity,JTextField,B> foreignKeyTextField(ForeignKey foreignKey)

Creates foreign key text field builder for the given foreign key, read-only and non-focusable.

Type Parameters:

B - the builder type

Parameters:

foreignKey - the foreign key

Returns:

a foreign key JTextField builder

foreignKeyLabel

public LabelBuilder<Entity> foreignKeyLabel(ForeignKey foreignKey)

Creates a foreign key label builder based on the given foreign key.

Parameters:

foreignKey - the foreign key

Returns:

a foreign key JLabel builder

itemComboBox

public <T> ItemComboBoxBuilder<T> itemComboBox(Attribute<T> attribute)

Creates a JComboBox builder based on the given attribute. Note that the attribute must have items associated.

Type Parameters:

T - the attribute type

Parameters:

attribute - the attribute

Returns:

an Item based JComboBox builder

Throws:

IllegalArgumentException - in case the given attribute has no associated items

comboBox

public <T,
C extends JComboBox<T>,
B extends ComboBoxBuilder<T,
C,
B>>
ComboBoxBuilder<T,C,B> comboBox(Attribute<T> attribute,
 ComboBoxModel<T> comboBoxModel)

Creates a JComboBox builder based on the given attribute.

Type Parameters:

T - the attribute type

C - the component type

B - the builder type

Parameters:

attribute - the attribute

comboBoxModel - the combo box model

Returns:

a JComboBox builder

temporalFieldPanel

public <T extends Temporal>
TemporalFieldPanel.Builder<T> temporalFieldPanel(Attribute<T> attribute)

Creates a TemporalFieldPanel builder based on the given attribute.

Type Parameters:

T - the attribute type

Parameters:

attribute - the attribute

Returns:

a TemporalFieldPanel builder

textFieldPanel

public TextFieldPanel.Builder textFieldPanel(Attribute<String> attribute)

Creates a TextFieldPanel builder based on the given attribute.

Parameters:

attribute - the attribute

Returns:

a TextFieldPanel builder

textArea

public TextAreaBuilder textArea(Attribute<String> attribute)

Creates a TextArea builder based on the given attribute.

Parameters:

attribute - the attribute

Returns:

a JTextArea builder

textField

public <T,
C extends JTextField,
B extends TextFieldBuilder<T,
C,
B>>
TextFieldBuilder<T,C,B> textField(Attribute<T> attribute)

Creates a text field builder based on the given attribute.

Type Parameters:

T - the attribute type

C - the text field type

B - the builder type

Parameters:

attribute - the attribute

Returns:

a JTextField builder

temporalField

public <T extends Temporal>
TemporalField.Builder<T> temporalField(Attribute<T> attribute)

Creates a TemporalField builder based on the given attribute.

Type Parameters:

T - the temporal type

Parameters:

attribute - the attribute

Returns:

a TemporalField builder

shortField

public NumberField.Builder<Short> shortField(Attribute<Short> attribute)

Creates a NumberField builder based on the given attribute.

Parameters:

attribute - the attribute

Returns:

a NumberField builder

integerField

public NumberField.Builder<Integer> integerField(Attribute<Integer> attribute)

Creates a NumberField builder based on the given attribute.

Parameters:

attribute - the attribute

Returns:

a NumberField builder

longField

public NumberField.Builder<Long> longField(Attribute<Long> attribute)

Creates a NumberField builder based on the given attribute.

Parameters:

attribute - the attribute

Returns:

a NumberField builder

doubleField

public NumberField.Builder<Double> doubleField(Attribute<Double> attribute)

Creates a NumberField builder based on the given attribute.

Parameters:

attribute - the attribute

Returns:

a NumberField builder

bigDecimalField

public NumberField.Builder<BigDecimal> bigDecimalField(Attribute<BigDecimal> attribute)

Creates a NumberField builder based on the given attribute.

Parameters:

attribute - the attribute

Returns:

a NumberField builder

slider

public SliderBuilder slider(Attribute<Integer> attribute)

Creates a JSlider builder based on the given attribute, with a bounded range model based on the min/max values of the associated attribute.

Parameters:

attribute - the attribute

Returns:

a JSlider builder

slider

public SliderBuilder slider(Attribute<Integer> attribute,
 BoundedRangeModel boundedRangeModel)

Creates a JSlider builder based on the given attribute.

Parameters:

attribute - the attribute

boundedRangeModel - the bounded range model

Returns:

a JSlider builder

integerSpinner

public NumberSpinnerBuilder<Integer> integerSpinner(Attribute<Integer> attribute)

Creates a JSpinner builder based on the given attribute.

Parameters:

attribute - the attribute

Returns:

a JSpinner builder

doubleSpinner

public NumberSpinnerBuilder<Double> doubleSpinner(Attribute<Double> attribute)

Creates a JSpinner builder based on the given attribute.

Parameters:

attribute - the attribute

Returns:

a JSpinner builder

listSpinner

public <T> ListSpinnerBuilder<T> listSpinner(Attribute<T> attribute,
 SpinnerListModel listModel)

Creates a JSpinner builder based on the given attribute.

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

listModel - the spinner model

Returns:

a JSpinner builder

itemSpinner

public <T> ItemSpinnerBuilder<T> itemSpinner(Attribute<T> attribute)

Creates a JSpinner builder based on the given attribute.

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

Returns:

a JSpinner builder

maskedTextField

public MaskedTextFieldBuilder maskedTextField(Attribute<String> attribute)

Creates a masked text field builder based on the given attribute.

Parameters:

attribute - the attribute

Returns:

a JFormattedTextField builder

byteArrayInputPanel

public ComponentBuilder<byte[],FileInputPanel,FileInputPanel.Builder<byte[]>> byteArrayInputPanel(Attribute<byte[]> attribute)

Creates a byte array based FileInputPanel builder based on the given attribute.

Parameters:

attribute - the attribute

Returns:

a FileInputPanel.Builder

list

public <T>
EntityComponents.EntityListBuilderFactory<T> list(ListModel<T> listModel)

Type Parameters:

T - the value type

Parameters:

listModel - the list model to base the list on

Returns:

a builder factory for a list

entityComponents

public static EntityComponents entityComponents(EntityDefinition entityDefinition)

Parameters:

entityDefinition - the entity definition

Returns:

a new EntityComponents instance