FilteredComboBoxModel (Codion Framework API 0.17.16)

java.lang.Object
- is.codion.swing.common.model.component.combobox.FilteredComboBoxModel<T>

Type Parameters:

T - the type of values in this combo box model

All Implemented Interfaces:

FilteredModel<T>, ComboBoxModel<T>, ListModel<T>

Direct Known Subclasses:

EntityComboBoxModel, ItemComboBoxModel
```
public class FilteredComboBoxModel<T>
extends Object
implements FilteredModel<T>, ComboBoxModel<T>
```
A default combo box model implementation based on FilteredModel.

See Also:

setIncludeCondition(Predicate)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface FilteredComboBoxModel.ItemFinder<T,V>
Responsible for finding an item of type T by a single value of type V.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FilteredComboBoxModel.ItemFinder<T,V>` Responsible for finding an item of type `T` by a single value of type `V`.

Field Summary

Fields
Modifier and Type Field and Description

static PropertyValue<String> COMBO_BOX_NULL_CAPTION
Specifies the caption used by default to represent null in combo box models.
- Fields inherited from interface is.codion.common.model.FilteredModel
  ASYNC_REFRESH

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

Constructor Summary

Constructors
Constructor and Description

FilteredComboBoxModel()
Instantiates a new FilteredComboBoxModel.

Constructors
Constructor and Description
`FilteredComboBoxModel()` Instantiates a new FilteredComboBoxModel.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFilterListener(EventListener listener)`
`void`	`addItem(T item)` Adds the given item to this model, respecting the sorting order if specified.
`void`	`addListDataListener(ListDataListener listener)`
`void`	`addRefreshFailedListener(EventDataListener<Throwable> listener)`
`void`	`addRefreshListener(EventListener listener)`
`void`	`addSelectionListener(EventDataListener<T> listener)`
`protected boolean`	`allowSelectionChange(T itemToSelect)`
`void`	`clear()` Clears all items from this combo box model
`boolean`	`containsItem(T item)` Returns true if this model contains the given item, visible or filtered.
`<V> Value<V>`	`createSelectorValue(FilteredComboBoxModel.ItemFinder<T,V> itemFinder)`
`int`	`filteredItemCount()`
`List<T>`	`filteredItems()`
`void`	`filterItems()` Filters this model according to the condition returned by `FilteredModel.getIncludeCondition()`.
`protected void`	`fireContentsChanged()` Fires a `ListDataEvent.CONTENTS_CHANGED` event on all registered listeners
`T`	`getElementAt(int index)`
`Predicate<T>`	`getIncludeCondition()` Returns the include condition used by this model, null if no include condition has been set.
`T`	`getSelectedItem()`
`int`	`getSize()`
`Comparator<T>`	`getSortComparator()`
`boolean`	`isAsyncRefresh()`
`boolean`	`isCleared()`
`boolean`	`isFiltered(T item)` Returns true if this model contains the given item, and it is filtered, that is, is not visible
`boolean`	`isFilterSelectedItem()` Specifies whether filtering can change the selected item, if true then the selected item is set to null when the currently selected item is filtered from the model, otherwise the selected item can potentially represent a value which is not currently visible in the model.
`boolean`	`isIncludeNull()`
`boolean`	`isNullSelected()` Returns true if this model contains null and it is selected.
`boolean`	`isSelectionEmpty()`
`boolean`	`isVisible(T item)` Returns true if this model contains the given item, and it is visible, that is, not filtered
`List<T>`	`items()`
`void`	`refresh()` Refreshes the items in this combo box model.
`StateObserver`	`refreshingObserver()`
`protected Collection<T>`	`refreshItems()`
`void`	`refreshThen(Consumer<Collection<T>> afterRefresh)` Refreshes the data in this model.
`void`	`removeFilterListener(EventListener listener)`
`void`	`removeItem(T item)` Removes the given item from this model
`void`	`removeListDataListener(ListDataListener listener)`
`void`	`removeRefreshFailedListener(EventDataListener<Throwable> listener)`
`void`	`removeRefreshListener(EventListener listener)`
`void`	`removeSelectionListener(EventDataListener<T> listener)`
`void`	`replaceItem(T item, T replacement)` Replaces the given item in this combo box model
`T`	`selectedValue()`
`void`	`setAsyncRefresh(boolean asyncRefresh)` Sometimes we'd like to be able to refresh one or more models and perform some action on the refreshed data, after the refresh has finished, such as selecting a particular item or such.
`void`	`setFilterSelectedItem(boolean filterSelectedItem)` Specifies whether filtering can change the selected item, if true then the selected item is set to null when the currently selected item is filtered from the model, otherwise the selected item can potentially represent a value which is not currently visible in the model.
`void`	`setIncludeCondition(Predicate<T> includeCondition)` Sets the include condition and filters the model
`void`	`setIncludeNull(boolean includeNull)`
`void`	`setItems(Collection<T> items)` Resets the items of this model using the values found in `items`, if items is null then the model is considered to be cleared.
`void`	`setNullItem(T nullItem)` Sets the item that should represent the null value in this model.
`void`	`setSelectedItem(Object item)`
`void`	`setSortComparator(Comparator<T> sortComparator)` Sets the Comparator used when sorting the items visible in this model and sorts the model accordingly.
`protected T`	`translateSelectionItem(Object item)`
`int`	`visibleItemCount()`
`List<T>`	`visibleItems()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COMBO_BOX_NULL_CAPTION
```
public static final PropertyValue<String> COMBO_BOX_NULL_CAPTION
```
    Specifies the caption used by default to represent null in combo box models. Value type: String
    Default value: -
- Constructor Detail
  - FilteredComboBoxModel
```
public FilteredComboBoxModel()
```
    Instantiates a new FilteredComboBoxModel. The model items are sorted automatically with a default collation based comparator. To prevent sorting call setSortComparator(Comparator) with a null argument before adding items.
- Method Detail
  - isAsyncRefresh
```
public final boolean isAsyncRefresh()
```
    Specified by:
    
    isAsyncRefresh in interface FilteredModel<T>
    
    Returns:
    
    true if asynchronous refreshing is enabled, true by default
    
    See Also:
    
    FilteredModel.ASYNC_REFRESH
  - setAsyncRefresh
```
public final void setAsyncRefresh(boolean asyncRefresh)
```
    Description copied from interface: FilteredModel
    
    Sometimes we'd like to be able to refresh one or more models and perform some action on the refreshed data, after the refresh has finished, such as selecting a particular item or such. This is quite difficult to achieve with asynchronous refresh enabled, so here's a way to temporarily disable asynchronous refresh, for a more predictable behaviour.
    
    Specified by:
    
    setAsyncRefresh in interface FilteredModel<T>
    
    Parameters:
    
    asyncRefresh - true if asynchronous refreshing should be enabled, true by default
    
    See Also:
    
    FilteredModel.ASYNC_REFRESH
  - refresh
```
public final void refresh()
```
    Refreshes the items in this combo box model. If run on the Event Dispatch Thread the refresh happens asynchronously.
    
    Specified by:
    
    refresh in interface FilteredModel<T>
    
    Throws:
    
    RuntimeException - in case of an exception when running refresh synchronously, as in, not on the Event Dispatch Thread
    
    See Also:
    
    addRefreshFailedListener(EventDataListener), setAsyncRefresh(boolean)
  - refreshThen
```
public final void refreshThen(Consumer<Collection<T>> afterRefresh)
```
    Description copied from interface: FilteredModel
    
    Refreshes the data in this model. Note that this method only throws exceptions when run synchronously off the EDT. Use FilteredModel.addRefreshFailedListener(EventDataListener) to listen for exceptions that happen during asynchronous refresh.
    
    Specified by:
    
    refreshThen in interface FilteredModel<T>
    
    Parameters:
    
    afterRefresh - called after a successful refresh, may be null
    
    See Also:
    
    FilteredModel.refreshingObserver(), FilteredModel.addRefreshListener(EventListener), FilteredModel.addRefreshFailedListener(EventDataListener), FilteredModel.setAsyncRefresh(boolean)
  - refreshingObserver
```
public final StateObserver refreshingObserver()
```
    Specified by:
    
    refreshingObserver in interface FilteredModel<T>
    
    Returns:
    
    an observer active while a refresh is in progress
  - clear
```
public final void clear()
```
    Clears all items from this combo box model
  - isCleared
```
public final boolean isCleared()
```
    Returns:
    
    true if the model data has been cleared and needs to be refreshed
  - setItems
```
public final void setItems(Collection<T> items)
```
    Resets the items of this model using the values found in items, if items is null then the model is considered to be cleared.
    
    Parameters:
    
    items - the items to display in this combo box model
    
    See Also:
    
    isCleared()
  - filterItems
```
public final void filterItems()
```
    Description copied from interface: FilteredModel
    
    Filters this model according to the condition returned by FilteredModel.getIncludeCondition(). If no include condition is specified this method does nothing. This method does not interfere with the internal ordering of the visible items.
    
    Specified by:
    
    filterItems in interface FilteredModel<T>
    
    See Also:
    
    FilteredModel.getIncludeCondition(), FilteredModel.setIncludeCondition(Predicate), FilteredModel.addFilterListener(EventListener)
  - visibleItems
```
public final List<T> visibleItems()
```
    Specified by:
    
    visibleItems in interface FilteredModel<T>
    
    Returns:
    
    an unmodifiable view of the visible items
  - filteredItems
```
public final List<T> filteredItems()
```
    Specified by:
    
    filteredItems in interface FilteredModel<T>
    
    Returns:
    
    an unmodifiable view of the filtered items
  - items
```
public final List<T> items()
```
    Specified by:
    
    items in interface FilteredModel<T>
    
    Returns:
    
    an unmodifiable view of all visible and filtered items in this model, in no particular order
    
    See Also:
    
    FilteredModel.visibleItems(), FilteredModel.filteredItems()
  - setIncludeCondition
```
public final void setIncludeCondition(Predicate<T> includeCondition)
```
    Description copied from interface: FilteredModel
    
    Sets the include condition and filters the model
    
    Specified by:
    
    setIncludeCondition in interface FilteredModel<T>
    
    Parameters:
    
    includeCondition - the Predicate to use when filtering, null if no filtering should be performed
  - getIncludeCondition
```
public final Predicate<T> getIncludeCondition()
```
    Description copied from interface: FilteredModel
    
    Returns the include condition used by this model, null if no include condition has been set.
    
    Specified by:
    
    getIncludeCondition in interface FilteredModel<T>
    
    Returns:
    
    the include condition
  - filteredItemCount
```
public final int filteredItemCount()
```
    Specified by:
    
    filteredItemCount in interface FilteredModel<T>
    
    Returns:
    
    the number of currently filtered items
  - visibleItemCount
```
public final int visibleItemCount()
```
    Specified by:
    
    visibleItemCount in interface FilteredModel<T>
    
    Returns:
    
    the number of currently visible items
  - isVisible
```
public final boolean isVisible(T item)
```
    Description copied from interface: FilteredModel
    
    Returns true if this model contains the given item, and it is visible, that is, not filtered
    
    Specified by:
    
    isVisible in interface FilteredModel<T>
    
    Parameters:
    
    item - the item
    
    Returns:
    
    true if the given item is visible
  - isFiltered
```
public final boolean isFiltered(T item)
```
    Description copied from interface: FilteredModel
    
    Returns true if this model contains the given item, and it is filtered, that is, is not visible
    
    Specified by:
    
    isFiltered in interface FilteredModel<T>
    
    Parameters:
    
    item - the item
    
    Returns:
    
    true if the given item is filtered
  - addItem
```
public final void addItem(T item)
```
    Adds the given item to this model, respecting the sorting order if specified. If this model already contains the item, calling this method has no effect. Note that if the item does not satisfy the include condition, it will be filtered right away.
    
    Parameters:
    
    item - the item to add
    
    See Also:
    
    setIncludeCondition(Predicate)
  - removeItem
```
public final void removeItem(T item)
```
    Removes the given item from this model
    
    Parameters:
    
    item - the item to remove
  - replaceItem
```
public final void replaceItem(T item,
                              T replacement)
```
    Replaces the given item in this combo box model
    
    Parameters:
    
    item - the item to replace
    
    replacement - the replacement item
  - containsItem
```
public final boolean containsItem(T item)
```
    Description copied from interface: FilteredModel
    
    Returns true if this model contains the given item, visible or filtered.
    
    Specified by:
    
    containsItem in interface FilteredModel<T>
    
    Parameters:
    
    item - the item
    
    Returns:
    
    true if this model contains the item
  - getSortComparator
```
public final Comparator<T> getSortComparator()
```
    Returns:
    
    the Comparator used when sorting the items of this model
  - setSortComparator
```
public final void setSortComparator(Comparator<T> sortComparator)
```
    Sets the Comparator used when sorting the items visible in this model and sorts the model accordingly. This Comparator must take into account the null value if a nullValueString is specified. If a null sortComparator is provided no sorting will be performed.
    
    Parameters:
    
    sortComparator - the Comparator, null if the items of this model should not be sorted
  - setIncludeNull
```
public final void setIncludeNull(boolean includeNull)
```
    Parameters:
    
    includeNull - if true then a null value is included as the first item
    
    See Also:
    
    setNullItem(Object)
  - isIncludeNull
```
public final boolean isIncludeNull()
```
    Returns:
    
    true if a null value is included
  - setNullItem
```
public final void setNullItem(T nullItem)
```
    Sets the item that should represent the null value in this model. Note that setIncludeNull(boolean) must be called as well to enable the null value.
    
    Parameters:
    
    nullItem - the item representing null
    
    See Also:
    
    setIncludeNull(boolean)
  - isNullSelected
```
public final boolean isNullSelected()
```
    Returns true if this model contains null and it is selected.
    
    Returns:
    
    true if this model contains null and it is selected, false otherwise
    
    See Also:
    
    isIncludeNull()
  - isSelectionEmpty
```
public final boolean isSelectionEmpty()
```
    Returns:
    
    true if no value is selected or if the value representing null is selected
  - selectedValue
```
public final T selectedValue()
```
    Returns:
    
    the selected value, null in case the value representing null is selected
    
    See Also:
    
    isNullSelected()
  - getSelectedItem
```
public final 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 setNullItem(Object), selectedValue() is usually what you want
  - setSelectedItem
```
public final void setSelectedItem(Object item)
```
    Specified by:
    
    setSelectedItem in interface ComboBoxModel<T>
    
    Parameters:
    
    item - the item to select
  - setFilterSelectedItem
```
public final void setFilterSelectedItem(boolean filterSelectedItem)
```
    Specifies whether filtering can change the selected item, if true then the selected item is set to null when the currently 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 true by default.
    
    Parameters:
    
    filterSelectedItem - if true then the selected item is changed when it is filtered out,
  - isFilterSelectedItem
```
public final boolean isFilterSelectedItem()
```
    Specifies whether filtering can change the selected item, if true then the selected item is set to null when the currently 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 true by default.
    
    Returns:
    
    true if the selected item is changed when it is filtered out
  - 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 T getElementAt(int index)
```
    Specified by:
    
    getElementAt in interface ListModel<T>
    
    Parameters:
    
    index - the index
    
    Returns:
    
    the item at the given index
  - getSize
```
public final int getSize()
```
    Specified by:
    
    getSize in interface ListModel<T>
    
    Returns:
    
    the number of visible items in this model
  - createSelectorValue
```
public final <V> Value<V> createSelectorValue(FilteredComboBoxModel.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 via the given finder instance
  - addFilterListener
```
public final void addFilterListener(EventListener listener)
```
    Specified by:
    
    addFilterListener in interface FilteredModel<T>
    
    Parameters:
    
    listener - a listener notified each time this model is filtered
  - removeFilterListener
```
public final void removeFilterListener(EventListener listener)
```
    Specified by:
    
    removeFilterListener in interface FilteredModel<T>
    
    Parameters:
    
    listener - the listener to remove
  - addRefreshListener
```
public final void addRefreshListener(EventListener listener)
```
    Specified by:
    
    addRefreshListener in interface FilteredModel<T>
    
    Parameters:
    
    listener - a listener to be notified each time this model has been successfully refreshed
    
    See Also:
    
    FilteredModel.refresh()
  - removeRefreshListener
```
public final void removeRefreshListener(EventListener listener)
```
    Specified by:
    
    removeRefreshListener in interface FilteredModel<T>
    
    Parameters:
    
    listener - the listener to remove
    
    See Also:
    
    FilteredModel.refresh()
  - addRefreshFailedListener
```
public final void addRefreshFailedListener(EventDataListener<Throwable> listener)
```
    Specified by:
    
    addRefreshFailedListener in interface FilteredModel<T>
    
    Parameters:
    
    listener - a listener to be notified each time an asynchronous refresh has failed
    
    See Also:
    
    FilteredModel.refresh()
  - removeRefreshFailedListener
```
public final void removeRefreshFailedListener(EventDataListener<Throwable> listener)
```
    Specified by:
    
    removeRefreshFailedListener in interface FilteredModel<T>
    
    Parameters:
    
    listener - the listener to remove
  - addSelectionListener
```
public final void addSelectionListener(EventDataListener<T> listener)
```
    Parameters:
    
    listener - a listener notified each time the selection changes
  - removeSelectionListener
```
public final void removeSelectionListener(EventDataListener<T> listener)
```
    Parameters:
    
    listener - a selection listener to remove
  - refreshItems
```
protected Collection<T> refreshItems()
```
    Returns:
    
    a Collection containing the items to be shown in this combo box model, by default this simply returns the items currently contained in the model, both filtered and visible, excluding the null value.
  - allowSelectionChange
```
protected boolean allowSelectionChange(T itemToSelect)
```
    Parameters:
    
    itemToSelect - the item to be selected
    
    Returns:
    
    true if the selection change is ok, false if it should be vetoed
  - translateSelectionItem
```
protected T translateSelectionItem(Object item)
```
    Parameters:
    
    item - the item to be selected
    
    Returns:
    
    the actual item to select
  - fireContentsChanged
```
protected final void fireContentsChanged()
```
    Fires a ListDataEvent.CONTENTS_CHANGED event on all registered listeners

Class FilteredComboBoxModel<T>

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COMBO_BOX_NULL_CAPTION

Constructor Detail

FilteredComboBoxModel

Method Detail

isAsyncRefresh

setAsyncRefresh

refresh

refreshThen

refreshingObserver

clear

isCleared

setItems

filterItems

visibleItems

filteredItems

items

setIncludeCondition

getIncludeCondition

filteredItemCount

visibleItemCount

isVisible

isFiltered

addItem

removeItem

replaceItem

containsItem

getSortComparator

setSortComparator

setIncludeNull

isIncludeNull

setNullItem

isNullSelected

isSelectionEmpty

selectedValue

getSelectedItem

setSelectedItem

setFilterSelectedItem

isFilterSelectedItem

addListDataListener

removeListDataListener

getElementAt

getSize

createSelectorValue

addFilterListener

removeFilterListener

addRefreshListener

removeRefreshListener

addRefreshFailedListener

removeRefreshFailedListener

addSelectionListener

removeSelectionListener

refreshItems

allowSelectionChange

translateSelectionItem

fireContentsChanged