Module is.codion.swing.common.model

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

Interface SwingFilterListModel.Builder<T>

Type Parameters:

T - the item type

Enclosing interface:

SwingFilterListModel<T>

public static interface SwingFilterListModel.Builder<T>

Builds a SwingFilterListModel — the same options as the common FilterListModel.Builder (the selection is a javax.swing.ListSelectionModel based one and the refresher a ProgressWorker based one), but the chain stays Swing-typed so build() yields a ListModel.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SwingFilterListModel.Builder.ItemsStep	Provides a SwingFilterListModel.Builder

Method Summary

Modifier and Type	Method	Description
SwingFilterListModel.Builder<T>	async(boolean async)
SwingFilterListModel<T>	build()
SwingFilterListModel.Builder<T>	comparator(@Nullable Comparator<T> comparator)
SwingFilterListModel.Builder<T>	included(Predicate<T> included)
SwingFilterListModel.Builder<T>	onIndexesSelected(Consumer<List<Integer>> indexes)
SwingFilterListModel.Builder<T>	onIndexSelected(Consumer<Integer> index)
SwingFilterListModel.Builder<T>	onItemSelected(Consumer<T> item)
SwingFilterListModel.Builder<T>	onItemsSelected(Consumer<List<T>> items)
SwingFilterListModel.Builder<T>	onRefreshException(Consumer<Exception> onRefreshException)	By default, exceptions during refresh are rethrown, use this method to handle async exceptions differently
SwingFilterListModel.Builder<T>	onSelectionChanged(Runnable listener)

Method Details

comparator

SwingFilterListModel.Builder<T> comparator(@Nullable Comparator<T> comparator)

Parameters:

comparator - the comparator to use when sorting

Returns:

this builder instance

async

SwingFilterListModel.Builder<T> async(boolean async)

Parameters:

async - true if async refresh should be enabled

Returns:

this builder instance

onRefreshException

SwingFilterListModel.Builder<T> 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

SwingFilterListModel.Builder<T> included(Predicate<T> included)

Parameters:

included - the Predicate controlling which items should be included

Returns:

this builder instance

onSelectionChanged

SwingFilterListModel.Builder<T> onSelectionChanged(Runnable listener)

Parameters:

listener - the selection listener

Returns:

this builder instance

onItemSelected

SwingFilterListModel.Builder<T> onItemSelected(Consumer<T> item)

Parameters:

item - receives the selected item

Returns:

this builder instance

onItemsSelected

SwingFilterListModel.Builder<T> onItemsSelected(Consumer<List<T>> items)

Parameters:

items - receives the selected items

Returns:

this builder instance

onIndexSelected

SwingFilterListModel.Builder<T> onIndexSelected(Consumer<Integer> index)

Parameters:

index - receives the selected index

Returns:

this builder instance

onIndexesSelected

SwingFilterListModel.Builder<T> onIndexesSelected(Consumer<List<Integer>> indexes)

Parameters:

indexes - receives the selected indexes

Returns:

this builder instance

build

SwingFilterListModel<T> build()

Returns:

a new SwingFilterListModel instance