Module is.codion.swing.framework.model

Package is.codion.swing.framework.model.component

Interface SwingEntityComboBoxModel.Builder

Enclosing interface:

SwingEntityComboBoxModel

public static interface SwingEntityComboBoxModel.Builder

Builds a SwingEntityComboBoxModel — the same options as EntityComboBoxModel.Builder, but the chain stays Swing-typed so build() yields a ComboBoxModel.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SwingEntityComboBoxModel.Builder.ConnectionProviderStep	Provides a SwingEntityComboBoxModel.Builder
static interface	SwingEntityComboBoxModel.Builder.EntityTypeStep	Specifies the entity type, either directly or derived from a ForeignKey.

Method Summary

Modifier and Type	Method	Description
SwingEntityComboBoxModel.Builder	attributes(Collection<Attribute<?>> attributes)	Specifies the attributes to include when selecting the entities to populate this model with.
SwingEntityComboBoxModel	build()
SwingEntityComboBoxModel.Builder	comparator(@Nullable Comparator<Entity> comparator)	Note that this comparator is not used if orderBy(OrderBy) has been specified.
SwingEntityComboBoxModel.Builder	condition(@Nullable Supplier<Condition> condition)	If condition is null, the default condition, specifying all underlying entities is used.
SwingEntityComboBoxModel.Builder	filter(ForeignKey foreignKey, SwingEntityComboBoxModel filterModel)	Links the given combo box model representing foreign key entities to this combo box model so that selection in the foreign key model filters this model.
SwingEntityComboBoxModel.Builder	filterSelected(boolean filterSelected)	Specifies whether filtering the model affects the currently selected item.
SwingEntityComboBoxModel.Builder	includeNull(boolean includeNull)
SwingEntityComboBoxModel.Builder	nullCaption(@Nullable String nullCaption)	Enables the null item and sets the null item caption.
SwingEntityComboBoxModel.Builder	onItemSelected(Consumer<@Nullable Entity> item)
SwingEntityComboBoxModel.Builder	orderBy(@Nullable OrderBy orderBy)	Specifies the OrderBy to use when selecting entities for this model.
SwingEntityComboBoxModel.Builder	persistenceAware(boolean persistenceAware)
SwingEntityComboBoxModel.Builder	refresh(boolean refresh)	Default false.
SwingEntityComboBoxModel.Builder	select(@Nullable Entity entity)

Method Details

orderBy

SwingEntityComboBoxModel.Builder orderBy(@Nullable OrderBy orderBy)

Specifies the OrderBy to use when selecting entities for this model.

Parameters:

orderBy - the OrderBy to use when selecting

Returns:

this builder instance

comparator

SwingEntityComboBoxModel.Builder comparator(@Nullable Comparator<Entity> comparator)

Note that this comparator is not used if orderBy(OrderBy) has been specified.

Parameters:

comparator - the comparator to use, null for unsorted

Returns:

this builder instance

condition

SwingEntityComboBoxModel.Builder condition(@Nullable Supplier<Condition> condition)

If condition is null, the default condition, specifying all underlying entities is used.

Parameters:

condition - the condition supplier to use when querying data, may not return null

Returns:

this builder instance

attributes

SwingEntityComboBoxModel.Builder attributes(Collection<Attribute<?>> attributes)

Specifies the attributes to include when selecting the entities to populate this model with.

Parameters:

attributes - the attributes to select, an empty Collection for all

Returns:

this builder instance

includeNull

SwingEntityComboBoxModel.Builder includeNull(boolean includeNull)

Parameters:

includeNull - if true then the null item is enabled using the default null item caption

Returns:

this builder instance

nullCaption

SwingEntityComboBoxModel.Builder nullCaption(@Nullable String nullCaption)

Enables the null item and sets the null item caption.

Parameters:

nullCaption - the null item caption

Returns:

this builder instance

select

SwingEntityComboBoxModel.Builder select(@Nullable Entity entity)

Parameters:

entity - the entity to select initially

Returns:

this builder

persistenceAware

SwingEntityComboBoxModel.Builder persistenceAware(boolean persistenceAware)

Parameters:

persistenceAware - controls whether this combo box model should respond to entity persistence events

Returns:

this builder instance

See Also:

• EntityComboBoxModel.PERSISTENCE_AWARE
• PersistenceEvents

filterSelected

SwingEntityComboBoxModel.Builder filterSelected(boolean filterSelected)

Specifies whether filtering the model affects the currently selected item.

Parameters:

filterSelected - if true then the selected item is cleared when filtered

Returns:

this builder instance

filter

SwingEntityComboBoxModel.Builder filter(ForeignKey foreignKey,
 SwingEntityComboBoxModel filterModel)

Links the given combo box model representing foreign key entities to this combo box model so that selection in the foreign key model filters this model.

Parameters:

foreignKey - the foreign key

filterModel - the combo box model filtering this model

See Also:

• EntityComboBoxModel.ForeignKeyFilter.link(EntityComboBoxModel)

onItemSelected

SwingEntityComboBoxModel.Builder onItemSelected(Consumer<@Nullable Entity> item)

Parameters:

item - receives the selected item, note that this item may be null

Returns:

this builder instance

refresh

SwingEntityComboBoxModel.Builder refresh(boolean refresh)

Default false.

Parameters:

refresh - true if the model items should be refreshed on initialization

Returns:

this builder instance

build

SwingEntityComboBoxModel build()

Returns:

a new SwingEntityComboBoxModel instance