Module is.codion.swing.common.model

Package is.codion.swing.common.model.component.combobox

Interface FilterComboBoxModel<T>

Type Parameters:

T - the type of values in this combo box model

All Superinterfaces:

ComboBoxModel<T>, FilterModel<T>, ListModel<T>

All Known Subinterfaces:

EntityComboBoxModel

public interface FilterComboBoxModel<T>
extends FilterModel<T>, ComboBoxModel<T>

A combo box model based on FilterModel.

See Also:

• filterComboBoxModel()
• FilterModel.VisibleItems.predicate()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FilterComboBoxModel.ComboBoxItems<T>
static interface	FilterComboBoxModel.ComboBoxSelection<T>
static interface	FilterComboBoxModel.ItemFinder<T,V>	Responsible for finding an item of type FilterComboBoxModel.ItemFinder by a single value of type FilterComboBoxModel.ItemFinder.
static interface	FilterComboBoxModel.NullItem<T>	Specifies the item that should represent null for providing a caption.

Nested classes/interfaces inherited from interface is.codion.common.model.FilterModel

FilterModel.AbstractRefresher<T>, FilterModel.FilteredItems<T>, FilterModel.Items<T>, FilterModel.Refresher<T>, FilterModel.VisibleItems<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<String>	NULL_CAPTION	Specifies the caption used by default to represent the null item in combo box models.

Fields inherited from interface is.codion.common.model.FilterModel

ASYNC_REFRESH

Method Summary

Modifier and Type	Method	Description
<V> Value<V>	createSelectorValue(FilterComboBoxModel.ItemFinder<T,V> itemFinder)
static <T> FilterComboBoxModel<T>	filterComboBoxModel()
static <T> FilterComboBoxModel<T>	filterComboBoxModel(Collection<T> items)
static <T> FilterComboBoxModel<T>	filterComboBoxModel(Supplier<Collection<T>> supplier)
T	getSelectedItem()
FilterComboBoxModel.ComboBoxItems<T>	items()
FilterComboBoxModel.ComboBoxSelection<T>	selection()

Methods inherited from interface javax.swing.ComboBoxModel

setSelectedItem

Methods inherited from interface is.codion.common.model.FilterModel

refresh, refresh, refresher

Methods inherited from interface javax.swing.ListModel

addListDataListener, getElementAt, getSize, removeListDataListener

Field Details

NULL_CAPTION

static final PropertyValue<String> NULL_CAPTION

Specifies the caption used by default to represent the null item in combo box models.

• Value type: String
• Default value: -

See Also:

• FilterComboBoxModel.ComboBoxItems.nullItem()

Method Details

items

FilterComboBoxModel.ComboBoxItems<T> items()

Specified by:

items in interface FilterModel<T>

Returns:

the model items

selection

FilterComboBoxModel.ComboBoxSelection<T> selection()

Specified by:

selection in interface FilterModel<T>

Returns:

the SingleItemSelection instance used by this filter model

getSelectedItem

T getSelectedItem()

Specified by:

getSelectedItem in interface ComboBoxModel<T>

Returns:

the selected item, N.B. this can include the nullItem in case it has been set via FilterComboBoxModel.ComboBoxItems.nullItem(), FilterComboBoxModel.ComboBoxSelection.value() is usually what you want

createSelectorValue

<V> Value<V> createSelectorValue(FilterComboBoxModel.ItemFinder<T,V> itemFinder)

Type Parameters:

V - the value type

Parameters:

itemFinder - responsible for finding the item to select

Returns:

a Value linked to the selected item using the given FilterComboBoxModel.ItemFinder instance

filterComboBoxModel

static <T> FilterComboBoxModel<T> filterComboBoxModel()

Type Parameters:

T - the item type

Returns:

a new FilterComboBoxModel instance

filterComboBoxModel

static <T> FilterComboBoxModel<T> filterComboBoxModel(Collection<T> items)

Type Parameters:

T - the item type

Parameters:

items - the items to add to the model

Returns:

a new FilterComboBoxModel instance

filterComboBoxModel

static <T> FilterComboBoxModel<T> filterComboBoxModel(Supplier<Collection<T>> supplier)

Type Parameters:

T - the item type

Parameters:

supplier - the item supplier

Returns:

a new FilterComboBoxModel instance