Module is.codion.swing.common.model

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

Class ItemComboBoxModel<T>

java.lang.Object

is.codion.swing.common.model.component.combobox.ItemComboBoxModel<T>

Type Parameters:

T - the type of value wrapped by this combo box models items

All Implemented Interfaces:

FilterModel<Item<T>>, FilterComboBoxModel<Item<T>>, ComboBoxModel<Item<T>>, ListModel<Item<T>>

public final class ItemComboBoxModel<T>
extends Object

A ComboBoxModel implementation based on the Item class.

See Also:

• itemComboBoxModel()
• sortedItemComboBoxModel()
• booleanItemComboBoxModel()

Nested Class Summary

Nested classes/interfaces inherited from interface is.codion.swing.common.model.component.combobox.FilterComboBoxModel

FilterComboBoxModel.ComboBoxItems<T>, FilterComboBoxModel.ComboBoxSelection<T>, FilterComboBoxModel.ItemFinder<T,V>, FilterComboBoxModel.NullItem<T>

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 inherited from interface is.codion.swing.common.model.component.combobox.FilterComboBoxModel

NULL_CAPTION

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

ASYNC_REFRESH

Method Summary

Modifier and Type	Method	Description
final void	addListDataListener(ListDataListener listener)
static ItemComboBoxModel<Boolean>	booleanItemComboBoxModel()	Constructs a new Boolean based ItemComboBoxModel with null as the initially selected value.
static ItemComboBoxModel<Boolean>	booleanItemComboBoxModel(String nullCaption)	Constructs a new Boolean based ItemComboBoxModel with null as the initially selected value.
static ItemComboBoxModel<Boolean>	booleanItemComboBoxModel(String nullCaption, String trueCaption, String falseCaption)	Constructs a new Boolean based ItemComboBoxModel with null as the initially selected value.
final <V> Value<V>	createSelectorValue(FilterComboBoxModel.ItemFinder<Item<T>,V> itemFinder)
final Item<T>	getElementAt(int index)
final Item<T>	getSelectedItem()
final int	getSize()
int	indexOf(T value)	Returns the index of the Item representing the given value, -1 if this model does not contain such an Item.
static <T> ItemComboBoxModel<T>	itemComboBoxModel()
static <T> ItemComboBoxModel<T>	itemComboBoxModel(List<Item<T>> items)
final FilterComboBoxModel.ComboBoxItems<Item<T>>	items()
final void	refresh()	Refreshes the items in this model using its FilterModel.Refresher.
final void	refresh(Consumer<Collection<Item<T>>> onRefresh)	Refreshes the data in this filter model using its FilterModel.Refresher.
final FilterModel.Refresher<Item<T>>	refresher()
final void	removeListDataListener(ListDataListener listener)
final FilterComboBoxModel.ComboBoxSelection<Item<T>>	selection()
final void	setSelectedItem(Object item)
static <T> ItemComboBoxModel<T>	sortedItemComboBoxModel()
static <T> ItemComboBoxModel<T>	sortedItemComboBoxModel(Comparator<Item<T>> comparator)
static <T> ItemComboBoxModel<T>	sortedItemComboBoxModel(List<Item<T>> items)
static <T> ItemComboBoxModel<T>	sortedItemComboBoxModel(List<Item<T>> items, Comparator<Item<T>> comparator)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

indexOf

public int indexOf(T value)

Returns the index of the Item representing the given value, -1 if this model does not contain such an Item.

Parameters:

value - the value

Returns:

the index of the Item representing the given value, -1 if not found

itemComboBoxModel

public static <T> ItemComboBoxModel<T> itemComboBoxModel()

Type Parameters:

T - the Item value type

Returns:

a new combo box model

itemComboBoxModel

public static <T> ItemComboBoxModel<T> itemComboBoxModel(List<Item<T>> items)

Type Parameters:

T - the Item value type

Parameters:

items - the items

Returns:

a new combo box model

sortedItemComboBoxModel

public static <T> ItemComboBoxModel<T> sortedItemComboBoxModel()

Type Parameters:

T - the Item value type

Returns:

a new combo box model

sortedItemComboBoxModel

public static <T> ItemComboBoxModel<T> sortedItemComboBoxModel(List<Item<T>> items)

Type Parameters:

T - the Item value type

Parameters:

items - the items

Returns:

a new combo box model

sortedItemComboBoxModel

public static <T> ItemComboBoxModel<T> sortedItemComboBoxModel(Comparator<Item<T>> comparator)

Type Parameters:

T - the Item value type

Parameters:

comparator - the comparator to use when sorting

Returns:

a new combo box model

sortedItemComboBoxModel

public static <T> ItemComboBoxModel<T> sortedItemComboBoxModel(List<Item<T>> items,
 Comparator<Item<T>> comparator)

Type Parameters:

T - the Item value type

Parameters:

items - the items

comparator - the comparator to use when sorting

Returns:

a new combo box model

booleanItemComboBoxModel

public static ItemComboBoxModel<Boolean> booleanItemComboBoxModel()

Constructs a new Boolean based ItemComboBoxModel with null as the initially selected value.

Returns:

a Boolean based ItemComboBoxModel

booleanItemComboBoxModel

public static ItemComboBoxModel<Boolean> booleanItemComboBoxModel(String nullCaption)

Constructs a new Boolean based ItemComboBoxModel with null as the initially selected value.

Parameters:

nullCaption - the string representing a null value

Returns:

a Boolean based ItemComboBoxModel

booleanItemComboBoxModel

public static ItemComboBoxModel<Boolean> booleanItemComboBoxModel(String nullCaption,
 String trueCaption,
 String falseCaption)

Constructs a new Boolean based ItemComboBoxModel with null as the initially selected value.

Parameters:

nullCaption - the string representing a null value

trueCaption - the string representing the boolean value 'true'

falseCaption - the string representing the boolean value 'false'

Returns:

a Boolean based ItemComboBoxModel

refresher

public final FilterModel.Refresher<Item<T>> refresher()

Specified by:

refresher in interface FilterModel<T>

Returns:

this models Refresher instance

refresh

public final void refresh()

Description copied from interface: FilterModel

Refreshes the items in this model using its FilterModel.Refresher.

Specified by:

refresh in interface FilterModel<T>

See Also:

• FilterModel.refresh()

refresh

public final void refresh(Consumer<Collection<Item<T>>> onRefresh)

Description copied from interface: FilterModel

Refreshes the data in this filter model using its FilterModel.Refresher. Note that this method only throws exceptions when run synchronously off the user interface thread. Use FilterModel.Refresher.failure() to listen for exceptions that happen during asynchronous refresh.

Specified by:

refresh in interface FilterModel<T>

Parameters:

onRefresh - called after a successful refresh, may be null

See Also:

• FilterModel.Refresher.observer()
• FilterModel.Refresher.success()
• FilterModel.Refresher.failure()
• FilterModel.Refresher.async()

items

public final FilterComboBoxModel.ComboBoxItems<Item<T>> items()

Specified by:

items in interface FilterComboBoxModel<T>

Specified by:

items in interface FilterModel<T>

Returns:

the model items

selection

public final FilterComboBoxModel.ComboBoxSelection<Item<T>> selection()

Specified by:

selection in interface FilterComboBoxModel<T>

Specified by:

selection in interface FilterModel<T>

Returns:

the SingleItemSelection instance used by this filter model

getSelectedItem

public final Item<T> getSelectedItem()

Specified by:

getSelectedItem in interface ComboBoxModel<T>

Specified by:

getSelectedItem in interface FilterComboBoxModel<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

setSelectedItem

public final void setSelectedItem(Object item)

Specified by:

setSelectedItem in interface ComboBoxModel<T>

addListDataListener

public final void addListDataListener(ListDataListener listener)

Specified by:

addListDataListener in interface ListModel<T>

removeListDataListener

public final void removeListDataListener(ListDataListener listener)

Specified by:

removeListDataListener in interface ListModel<T>

getElementAt

public final Item<T> getElementAt(int index)

Specified by:

getElementAt in interface ListModel<T>

getSize

public final int getSize()

Specified by:

getSize in interface ListModel<T>

createSelectorValue

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

Specified by:

createSelectorValue in interface FilterComboBoxModel<T>

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