Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.dialog

Interface ListSelectionDialogBuilder<T>

Type Parameters:

T - the value type

All Superinterfaces:

DialogBuilder<ListSelectionDialogBuilder<T>>, SelectionDialogBuilder<T,ListSelectionDialogBuilder<T>>

public interface ListSelectionDialogBuilder<T>
extends SelectionDialogBuilder<T,ListSelectionDialogBuilder<T>>

A builder for a JList based selection dialog.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ListSelectionDialogBuilder.SelectionStep<T>	Provides selection for single or multiple items.

Method Summary

Modifier and Type	Method	Description
ListSelectionDialogBuilder<T>	comparator(@Nullable Comparator<T> comparator)
ListSelectionDialogBuilder<T>	defaultSelection(Collection<T> defaultSelection)
ListSelectionDialogBuilder<T>	defaultSelection(T defaultSelection)
ListSelectionDialogBuilder<T>	formatter(@Nullable Function<T,String> formatter)	Ignored in case a renderer is specified, see SelectionDialogBuilder.renderer(javax.swing.ListCellRenderer).
ListSelectionDialogBuilder.SelectionStep<T>	select()
ListSelectionDialogBuilder<T>	size(@Nullable Dimension size)

Methods inherited from interface is.codion.swing.common.ui.dialog.DialogBuilder

icon, keyEvent, location, locationRelativeTo, onBuild, owner, owner, title, title, undecorated, windowFocusListener

Methods inherited from interface is.codion.swing.common.ui.dialog.SelectionDialogBuilder

allowEmptySelection, renderer

Method Details

defaultSelection

ListSelectionDialogBuilder<T> defaultSelection(T defaultSelection)

Parameters:

defaultSelection - the item selected by default

Returns:

this builder instance

Throws:

IllegalArgumentException - in case the selection values do not contain the default selection item

defaultSelection

ListSelectionDialogBuilder<T> defaultSelection(Collection<T> defaultSelection)

Parameters:

defaultSelection - the items selected by default

Returns:

this builder instance

Throws:

IllegalArgumentException - in case the selection values do not contain the default selection items

size

ListSelectionDialogBuilder<T> size(@Nullable Dimension size)

Parameters:

size - the preferred dialog size

Returns:

this builder instance

comparator

ListSelectionDialogBuilder<T> comparator(@Nullable Comparator<T> comparator)

Parameters:

comparator - the comparator to use to sort the items

Returns:

this builder instance

formatter

ListSelectionDialogBuilder<T> formatter(@Nullable Function<T,String> formatter)

Ignored in case a renderer is specified, see SelectionDialogBuilder.renderer(javax.swing.ListCellRenderer).

Parameters:

formatter - formats the items to select from, null for Object.toString()

Returns:

this builder instance

select

ListSelectionDialogBuilder.SelectionStep<T> select()

Returns:

a ListSelectionDialogBuilder.SelectionStep