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.

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	condition(Supplier<Condition> condition)
EntityComboBoxModel.Builder	filterSelected(boolean filterSelected)	Specifies whether filtering the model affects the currently selected item.
EntityComboBoxModel.Builder	handleEditEvents(boolean handleEditEvents)
EntityComboBoxModel.Builder	includeNull(boolean includeNull)
EntityComboBoxModel.Builder	nullCaption(String nullCaption)	Enables the null item and sets the null item caption.
EntityComboBoxModel.Builder	orderBy(OrderBy orderBy)	Specifies the OrderBy to use when selecting entities for this model.

Method Details

orderBy

EntityComboBoxModel.Builder orderBy(OrderBy orderBy)

Specifies the OrderBy to use when selecting entities for this model. Note that this is overridden by setting the FilterModel.VisibleItems.comparator() in the combo box model.

Parameters:

orderBy - the OrderBy to use when selecting

Returns:

this builder instance

condition

EntityComboBoxModel.Builder condition(Supplier<Condition> condition)

Parameters:

condition - the condition supplier to use when querying data

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.ComboBoxItems.nullItem()
• FilterComboBoxModel.NullItem
• FilterComboBoxModel.NULL_CAPTION

nullCaption

EntityComboBoxModel.Builder nullCaption(String nullCaption)

Enables the null item and sets the null item caption.

Parameters:

nullCaption - the null item caption

Returns:

this builder instance

See Also:

• FilterComboBoxModel.ComboBoxItems.nullItem()

handleEditEvents

EntityComboBoxModel.Builder handleEditEvents(boolean handleEditEvents)

Parameters:

handleEditEvents - 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:

• EntityEditEvents

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 visible 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.VisibleItems.predicate()

build

EntityComboBoxModel build()

Returns:

a new EntityComboBoxModel instance