Class ListSelectDialog<T>

java.lang.Object

com.googlecode.lanterna.gui2.AbstractBasePane<Window>

com.googlecode.lanterna.gui2.AbstractWindow

com.googlecode.lanterna.gui2.dialogs.DialogWindow

com.googlecode.lanterna.gui2.dialogs.ListSelectDialog<T>

Type Parameters:

T - Type of elements in the list

All Implemented Interfaces:

BasePane, Composite, Window

public class ListSelectDialog<T>
extends DialogWindow

Dialog that allows the user to select an item from a list

Nested Class Summary

Nested classes/interfaces inherited from class AbstractBasePane

AbstractBasePane.ContentHolder

Nested classes/interfaces inherited from interface Window

Window.Hint

Field Summary

Fields

Modifier and Type	Field	Description
private T	result

Fields inherited from class AbstractBasePane

contentHolder, interactableLookupMap

Constructor Summary

Constructors

Constructor	Description
ListSelectDialog(String title, String description, TerminalSize listBoxPreferredSize, boolean canCancel, List<T> content)

Method Summary

Modifier and Type	Method	Description
private void	onCancel()
private void	onSelect(T item)
T	showDialog(WindowBasedTextGUI textGUI)	Opens the dialog by showing it on the GUI and doesn't return until the dialog has been closed
static <T> T	showDialog(WindowBasedTextGUI textGUI, String title, String description, int listBoxHeight, T... items)	Shortcut for quickly creating a new dialog
static <T> T	showDialog(WindowBasedTextGUI textGUI, String title, String description, TerminalSize listBoxSize, T... items)	Shortcut for quickly creating a new dialog
static <T> T	showDialog(WindowBasedTextGUI textGUI, String title, String description, T... items)	Shortcut for quickly creating a new dialog

Methods inherited from class AbstractWindow

addWindowListener, close, draw, fromGlobal, fromGlobalToContentRelative, fromGlobalToDecoratedRelative, getDecoratedSize, getHints, getPosition, getPostRenderer, getPreferredSize, getSize, getTextGUI, getTitle, handleInput, isVisible, removeWindowListener, setCloseWindowWithEscape, setContentOffset, setDecoratedSize, setFixedSize, setHints, setPosition, setSize, setTextGUI, setTitle, setVisible, setWindowPostRenderer, toGlobal, toGlobalFromContentRelative, toGlobalFromDecoratedRelative, waitUntilClosed

Methods inherited from class AbstractBasePane

addBasePaneListener, getBasePaneListeners, getComponent, getCursorPosition, getFocusedInteractable, getMenuBar, getTheme, invalidate, isInvalid, removeBasePaneListener, setComponent, setEnableDirectionBasedMovements, setFocusedInteractable, setFocusedInteractable, setMenuBar, setStrictFocusChange, setTheme

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface BasePane

getTheme, setEnableDirectionBasedMovements, setStrictFocusChange, setTheme

Methods inherited from interface Window

getBounds, getComponent, getCursorPosition, getFocusedInteractable, getMenuBar, invalidate, isInvalid, setComponent, setFocusedInteractable, setMenuBar

Field Details

result

private T result

Constructor Details

ListSelectDialog

ListSelectDialog(String title,
 String description,
 TerminalSize listBoxPreferredSize,
 boolean canCancel,
 List<T> content)

Method Details

onSelect

private void onSelect(T item)

onCancel

private void onCancel()

showDialog

public T showDialog(WindowBasedTextGUI textGUI)

Opens the dialog by showing it on the GUI and doesn't return until the dialog has been closed

Overrides:

showDialog in class DialogWindow

Parameters:

textGUI - Text GUI to add the dialog to

Returns:

The item in the list that was selected or null if the dialog was cancelled

showDialog

@SafeVarargs
public static <T> T showDialog(WindowBasedTextGUI textGUI,
 String title,
 String description,
 T... items)

Shortcut for quickly creating a new dialog

Type Parameters:

T - Type of items in the dialog

Parameters:

textGUI - Text GUI to add the dialog to

title - Title of the dialog

description - Description of the dialog

items - Items in the dialog

Returns:

The selected item or null if cancelled

showDialog

@SafeVarargs
public static <T> T showDialog(WindowBasedTextGUI textGUI,
 String title,
 String description,
 int listBoxHeight,
 T... items)

Shortcut for quickly creating a new dialog

Type Parameters:

T - Type of items in the dialog

Parameters:

textGUI - Text GUI to add the dialog to

title - Title of the dialog

description - Description of the dialog

listBoxHeight - Maximum height of the list box, scrollbars will be used if there are more items

items - Items in the dialog

Returns:

The selected item or null if cancelled

showDialog

@SafeVarargs
public static <T> T showDialog(WindowBasedTextGUI textGUI,
 String title,
 String description,
 TerminalSize listBoxSize,
 T... items)

Shortcut for quickly creating a new dialog

Type Parameters:

T - Type of items in the dialog

Parameters:

textGUI - Text GUI to add the dialog to

title - Title of the dialog

description - Description of the dialog

listBoxSize - Maximum size of the list box, scrollbars will be used if the items cannot fit

items - Items in the dialog

Returns:

The selected item or null if cancelled