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:

• builder()
• FilterModel.IncludedItems.predicate()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FilterComboBoxModel.Builder<T>	Builds a FilterComboBoxModel
static interface	FilterComboBoxModel.ComboBoxItems<T>
static interface	FilterComboBoxModel.ItemComboBoxModelBuilder<T>	Builds FilterComboBoxModel implementations based on the Item class.
static interface	FilterComboBoxModel.ItemFinder<T,V>	Responsible for finding an item of type FilterComboBoxModel.ItemFinder by a single value of type FilterComboBoxModel.ItemFinder.

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

FilterModel.AbstractRefresher<T>, FilterModel.FilteredItems<T>, FilterModel.IncludedItems<T>, FilterModel.IncludedPredicate<T>, FilterModel.Items<T>, FilterModel.Refresher<T>, FilterModel.Sort<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.filter.FilterModel

ASYNC

Method Summary

Modifier and Type	Method	Description
static List<Item<Boolean>>	booleanItems()
static List<Item<Boolean>>	booleanItems(String nullCaption)
static List<Item<Boolean>>	booleanItems(String nullCaption, String trueCaption, String falseCaption)
static FilterComboBoxModel.Builder.ItemsStep	builder()
<V> Value<V>	createSelector(FilterComboBoxModel.ItemFinder<T,V> itemFinder)
@Nullable T	getSelectedItem()
FilterComboBoxModel.ComboBoxItems<T>	items()

Methods inherited from interface javax.swing.ComboBoxModel

setSelectedItem

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

selection, sort

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.Builder.includeNull(boolean)

Method Details

items

FilterComboBoxModel.ComboBoxItems<T> items()

Specified by:

items in interface FilterModel<T>

Returns:

the model items

getSelectedItem

@Nullable 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.Builder.nullItem(Object), SingleSelection.item() is usually what you want

createSelector

<V> Value<V> createSelector(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

builder

static FilterComboBoxModel.Builder.ItemsStep builder()

Returns:

a new FilterComboBoxModel.Builder.ItemsStep instance

booleanItems

static List<Item<Boolean>> booleanItems()

Returns:

items for null, true and false, using the default captions

See Also:

• NULL_CAPTION
• Messages.yes()
• Messages.no()

booleanItems

static List<Item<Boolean>> booleanItems(String nullCaption)

Parameters:

nullCaption - the caption for the null value

Returns:

items for null, true and false, using the given null caption and the default true/false captions

See Also:

• Messages.yes()
• Messages.no()

booleanItems

static List<Item<Boolean>> booleanItems(String nullCaption,
 String trueCaption,
 String falseCaption)

Parameters:

nullCaption - the caption for null

trueCaption - the caption for true

falseCaption - the caption for false

Returns:

items for null, true and false