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.

Note that the component created by component(Attribute) for a ForeignKey is a non-editable and non-focusable JTextField displaying a String representation of the referenced Entity.

See Also:

• entityComponents(EntityDefinition)

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.
ComponentValueBuilder<FileInputPanel,byte[],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<C, T, B>> ComboBoxBuilder<C,T,B>	comboBox(Attribute<T> attribute, ComboBoxModel<T> comboBoxModel)	Creates a JComboBox builder based on the given attribute.
EntityComboBox.Builder	comboBox(ForeignKey foreignKey, EntityComboBoxModel comboBoxModel)	Creates a EntityComboBox.Builder based on the given foreign key.
EntityComboBoxPanel.Builder	comboBoxPanel(ForeignKey foreignKey, EntityComboBoxModel comboBoxModel, Supplier<EntityEditPanel> editPanel)	Creates a EntityComboBoxPanel.Builder with optional buttons for adding and editing items.
<C extends JComponent, T, B extends ComponentValueBuilder<C, T, B>> ComponentValueBuilder<C,T,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()
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> 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.
NullableCheckBoxBuilder	nullableCheckBox(Attribute<Boolean> attribute)	Creates a NullableCheckBox builder based on the given attribute.
EntitySearchField.Builder.Factory	searchField(ForeignKey foreignKey, EntitySearchModel searchModel)	Creates a EntitySearchField.Builder.Factory.
EntitySearchFieldPanel.Builder.Factory	searchFieldPanel(ForeignKey foreignKey, EntitySearchModel searchModel, Supplier<EntityEditPanel> editPanel)	Creates a EntitySearchFieldPanel.Builder.Factory.
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.
<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<C, T, B>> TextFieldBuilder<C,T,B>	textField(Attribute<T> attribute)	Creates a text field builder based on the given attribute.
<B extends TextFieldBuilder<JTextField, Entity, B>> TextFieldBuilder<JTextField,Entity,B>	textField(ForeignKey foreignKey)	Creates Entity text field builder for the given foreign key, read-only and non-focusable, displaying the String representation the Entity
TextFieldPanel.Builder	textFieldPanel(Attribute<String> attribute)	Creates a TextFieldPanel builder based on the given attribute.
<B extends ButtonBuilder<JToggleButton, Boolean, B>> ButtonBuilder<JToggleButton,Boolean,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

component

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

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

Note that this method does not create an input component for ForeignKeys, it simply returns a non-focusable and non-editable JTextField from textField(ForeignKey).

Input components for ForeignKeys (EntityComboBox or EntitySearchField) require a data model, use comboBox(Attribute, ComboBoxModel) or searchField(ForeignKey, EntitySearchModel).

Type Parameters:

C - the component type

T - the attribute 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 given attribute is not supported

checkBox

public CheckBoxBuilder checkBox(Attribute<Boolean> attribute)

Creates a CheckBox builder based on the given attribute.

Parameters:

attribute - the attribute

Returns:

a JCheckBox builder

Throws:

IllegalArgumentException - in case the attribute is nullable

nullableCheckBox

public NullableCheckBoxBuilder nullableCheckBox(Attribute<Boolean> attribute)

Creates a NullableCheckBox builder based on the given attribute.

Parameters:

attribute - the attribute

Returns:

a NullableCheckBox builder

toggleButton

public <B extends ButtonBuilder<JToggleButton,
Boolean,
B>>
ButtonBuilder<JToggleButton,Boolean,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

comboBox

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

Creates a EntityComboBox.Builder based on the given foreign key.

Parameters:

foreignKey - the foreign key

comboBoxModel - the combo box model

Returns:

a foreign key JComboBox builder

comboBoxPanel

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

Creates a EntityComboBoxPanel.Builder 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

searchField

public EntitySearchField.Builder.Factory searchField(ForeignKey foreignKey,
 EntitySearchModel searchModel)

Creates a EntitySearchField.Builder.Factory.

Parameters:

foreignKey - the foreign key

searchModel - the search model

Returns:

a foreign key EntitySearchField builder

searchFieldPanel

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

Creates a EntitySearchFieldPanel.Builder.Factory.

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

textField

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

Creates Entity text field builder for the given foreign key, read-only and non-focusable, displaying the String representation the Entity

Type Parameters:

B - the builder type

Parameters:

foreignKey - the foreign key

Returns:

a Entity JTextField 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<C,
T,
B>>
ComboBoxBuilder<C,T,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<C,
T,
B>>
TextFieldBuilder<C,T,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 ComponentValueBuilder<FileInputPanel,byte[],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

entityComponents

public static EntityComponents entityComponents(EntityDefinition entityDefinition)

Parameters:

entityDefinition - the entity definition

Returns:

a new EntityComponents instance