Module is.codion.swing.framework.model

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

Interface EntityComboBoxModel.Builder

Enclosing interface:

EntityComboBoxModel

public static interface EntityComboBoxModel.Builder

Builds a EntityComboBoxModel.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityComboBoxModel.Builder.ConnectionProviderStep	Provides a EntityComboBoxModel.Builder
static interface	EntityComboBoxModel.Builder.EntityTypeStep	Provides a EntityComboBoxModel.Builder.ConnectionProviderStep

Method Summary

Modifier and Type	Method	Description
EntityComboBoxModel.Builder	attributes(Collection<Attribute<?>> attributes)	Specifies the attributes to include when selecting the entities to populate this model with.
EntityComboBoxModel	build()
EntityComboBoxModel.Builder	comparator(@Nullable Comparator<Entity> comparator)	Note that this comparator is not used if orderBy(OrderBy) has been specified.
EntityComboBoxModel.Builder	condition(@Nullable Supplier<Condition> condition)	If condition is null, the default condition, specifying all underlying entities is used.
EntityComboBoxModel.Builder	editEvents(boolean editEvents)
EntityComboBoxModel.Builder	filter(ForeignKey foreignKey, EntityComboBoxModel 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.
EntityComboBoxModel.Builder	filterSelected(boolean filterSelected)	Specifies whether filtering the model affects the currently selected item.
EntityComboBoxModel.Builder	includeNull(boolean includeNull)
EntityComboBoxModel.Builder	nullCaption(@Nullable String nullCaption)	Enables the null item and sets the null item caption.
EntityComboBoxModel.Builder	onItemSelected(Consumer<@Nullable Entity> item)
EntityComboBoxModel.Builder	orderBy(@Nullable OrderBy orderBy)	Specifies the OrderBy to use when selecting entities for this model.
EntityComboBoxModel.Builder	refresh(boolean refresh)	Default false.
EntityComboBoxModel.Builder	select(@Nullable Entity entity)

Method Details

orderBy

EntityComboBoxModel.Builder orderBy(@Nullable OrderBy orderBy)

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

Parameters:

orderBy - the OrderBy to use when selecting

Returns:

this builder instance

comparator

EntityComboBoxModel.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

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

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

The condition supplier may not return null, doing so will cause an exception when refreshing the model items.

Parameters:

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

Returns:

this builder instance

attributes

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

Specifies the attributes to include when selecting the entities to populate this model with. Note that the primary key attribute values are always included. An empty Collection indicates that all attributes should be selected.

Parameters:

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

Returns:

this builder instance

includeNull

EntityComboBoxModel.Builder includeNull(boolean includeNull)

Parameters:

includeNull - if true then the null item is enabled using the default null item caption (FilterComboBoxModel.NULL_CAPTION)

Returns:

this builder instance

See Also:

• FilterComboBoxModel.NULL_CAPTION

nullCaption

EntityComboBoxModel.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

EntityComboBoxModel.Builder select(@Nullable Entity entity)

Parameters:

entity - the entity to select initially

Returns:

this builder

editEvents

EntityComboBoxModel.Builder editEvents(boolean editEvents)

Parameters:

editEvents - controls whether this combo box model should handle entity edit events, by adding inserted items, updating any updated items and removing deleted ones

Returns:

this builder instance

See Also:

• EntityComboBoxModel.EDIT_EVENTS
• EntityEditModel.EditEvents

filterSelected

EntityComboBoxModel.Builder filterSelected(boolean filterSelected)

Specifies whether filtering the model affects the currently selected item. If true, the selection is cleared when the selected item is filtered from the model, otherwise the selected item can potentially represent a value which is not currently included in the model This is false by default.

Parameters:

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

Returns:

this builder instance

See Also:

• FilterModel.IncludedItems.predicate()

filter

EntityComboBoxModel.Builder filter(ForeignKey foreignKey,
 EntityComboBoxModel 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. Note that filterModel is automatically refreshed each time this combo box model is refreshed.

Parameters:

foreignKey - the foreign key

filterModel - the combo box model filtering this model

See Also:

• EntityComboBoxModel.ForeignKeyFilter.link(EntityComboBoxModel)

onItemSelected

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

Parameters:

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

Returns:

this builder instance

refresh

EntityComboBoxModel.Builder refresh(boolean refresh)

Default false.

Parameters:

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

Returns:

this builder instance

build

EntityComboBoxModel build()

Returns:

a new EntityComboBoxModel instance