Module is.codion.common.model

Package is.codion.common.model

Interface FilterModel<T>

Type Parameters:

T - the type of items in the model.

All Known Subinterfaces:

EntityTableModel<E>, FilterComboBoxModel<T>, FilterTableModel<R,C>

All Known Implementing Classes:

AbstractEntityTableModel, EntityComboBoxModel, ItemComboBoxModel, SwingEntityTableModel

public interface FilterModel<T>

Specifies a data model that can be filtered to hide some or all of the items it contains.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FilterModel.AbstractRefresher<T>	An abstract base implementation of FilterModel.Refresher.
static interface	FilterModel.FilteredItems<T>
static interface	FilterModel.Items<T>	A Mutable controlling the items in a FilterModel
static interface	FilterModel.Refresher<T>	Handles refreshing data for a FilterModel.
static interface	FilterModel.VisibleItems<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<Boolean>	ASYNC_REFRESH	Specifies whether data models should refresh data asynchronously or on the UI thread Value type: Boolean Default value: true

Method Summary

Modifier and Type	Method	Description
FilterModel.Items<T>	items()
void	refresh()	Refreshes the items in this model using its FilterModel.Refresher.
void	refresh(Consumer<Collection<T>> onRefresh)	Refreshes the data in this filter model using its FilterModel.Refresher.
FilterModel.Refresher<T>	refresher()
SingleItemSelection<T>	selection()

Field Details

ASYNC_REFRESH

static final PropertyValue<Boolean> ASYNC_REFRESH

Specifies whether data models should refresh data asynchronously or on the UI thread

Value type: Boolean

Default value: true

See Also:

• FilterModel.Refresher.async()

Method Details

items

FilterModel.Items<T> items()

Returns:

the model items

refresher

FilterModel.Refresher<T> refresher()

Returns:

this models Refresher instance

refresh

void refresh()

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

Throws:

RuntimeException - in case of an exception when running refresh synchronously

See Also:

• refresh()

refresh

void refresh(Consumer<Collection<T>> onRefresh)

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.

Parameters:

onRefresh - called after a successful refresh, may be null

See Also:

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

selection

SingleItemSelection<T> selection()

Returns:

the SingleItemSelection instance used by this filter model