Module is.codion.common.model

Package is.codion.common.model.component.table

Interface FilterTableModel.Builder<R,C>

Type Parameters:

R - the row type

C - the column identifier type

Enclosing interface:

FilterTableModel<R,C>

public static interface FilterTableModel.Builder<R,C>

A builder for a FilterTableModel.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FilterTableModel.Builder.ColumnsStep	Provides a FilterTableModel.Builder instance

Method Summary

Modifier and Type	Method	Description
FilterTableModel<R,C>	build()
FilterTableModel.Builder<R,C>	filters(Supplier<Map<C,ConditionModel<?>>> filters)
FilterTableModel.Builder<R,C>	included(Predicate<R> included)
FilterTableModel.Builder<R,C>	items(Supplier<Collection<R>> items)
FilterTableModel.Builder<R,C>	listener(FilterModel.IncludedItems.ItemsListener itemsListener)	Adds an FilterModel.IncludedItems.ItemsListener notified of fine-grained changes to the included items, allowing toolkit layers to bridge to their table change notifications (e.g.
FilterTableModel.Builder<R,C>	onIndexesSelected(Consumer<List<Integer>> indexes)
FilterTableModel.Builder<R,C>	onIndexSelected(Consumer<Integer> index)
FilterTableModel.Builder<R,C>	onItemSelected(Consumer<R> item)
FilterTableModel.Builder<R,C>	onItemsSelected(Consumer<List<R>> items)
FilterTableModel.Builder<R,C>	onRefreshException(Consumer<Exception> onRefreshException)	By default, exceptions during refresh are rethrown, use this method to handle async exceptions differently
FilterTableModel.Builder<R,C>	onSelectionChanged(Runnable listener)
FilterTableModel.Builder<R,C>	refresh(boolean refresh)
FilterTableModel.Builder<R,C>	selection(Function<FilterModel.IncludedItems<R>,MultiSelection<R>> selection)	Provides the MultiSelection for this model, given its FilterModel.IncludedItems.
FilterTableModel.Builder<R,C>	validator(Predicate<R> validator)	Items failing validation can not be added to the model.

Method Details

filters

FilterTableModel.Builder<R,C> filters(Supplier<Map<C,ConditionModel<?>>> filters)

Parameters:

filters - the column filter model factory

Returns:

this builder instance

items

FilterTableModel.Builder<R,C> items(Supplier<Collection<R>> items)

Parameters:

items - supplies the items

Returns:

this builder instance

validator

FilterTableModel.Builder<R,C> validator(Predicate<R> validator)

Items failing validation can not be added to the model.

Parameters:

validator - the item validator

Returns:

this builder instance

onRefreshException

FilterTableModel.Builder<R,C> onRefreshException(Consumer<Exception> onRefreshException)

By default, exceptions during refresh are rethrown, use this method to handle async exceptions differently

Parameters:

onRefreshException - the exception handler to use during refresh

Returns:

this builder instance

included

FilterTableModel.Builder<R,C> included(Predicate<R> included)

Parameters:

included - the Predicate controlling which items should be included

Returns:

this builder instance

refresh

FilterTableModel.Builder<R,C> refresh(boolean refresh)

Parameters:

refresh - true if the model items should be refreshed on initialization, false by default

Returns:

this builder instance

onSelectionChanged

FilterTableModel.Builder<R,C> onSelectionChanged(Runnable listener)

Parameters:

listener - the selection listener

Returns:

this builder instance

onItemSelected

FilterTableModel.Builder<R,C> onItemSelected(Consumer<R> item)

Parameters:

item - receives the selected item

Returns:

this builder instance

onItemsSelected

FilterTableModel.Builder<R,C> onItemsSelected(Consumer<List<R>> items)

Parameters:

items - receives the selected items

Returns:

this builder instance

onIndexSelected

FilterTableModel.Builder<R,C> onIndexSelected(Consumer<Integer> index)

Parameters:

index - receives the selected index

Returns:

this builder instance

onIndexesSelected

FilterTableModel.Builder<R,C> onIndexesSelected(Consumer<List<Integer>> indexes)

Parameters:

indexes - receives the selected indexes

Returns:

this builder instance

selection

FilterTableModel.Builder<R,C> selection(Function<FilterModel.IncludedItems<R>,MultiSelection<R>> selection)

Provides the MultiSelection for this model, given its FilterModel.IncludedItems. The default is the pure-Java MultiSelection.multiSelection(MultiSelection.IndexedItems); the Swing layer plugs a javax.swing.ListSelectionModel based one.

Parameters:

selection - the selection factory

Returns:

this builder instance

listener

FilterTableModel.Builder<R,C> listener(FilterModel.IncludedItems.ItemsListener itemsListener)

Adds an FilterModel.IncludedItems.ItemsListener notified of fine-grained changes to the included items, allowing toolkit layers to bridge to their table change notifications (e.g. TableModelEvents).

Parameters:

itemsListener - the FilterModel.IncludedItems.ItemsListener to add

Returns:

this builder instance

build

FilterTableModel<R,C> build()

Returns:

a new FilterTableModel instance.