Module com.googlecode.lanterna
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
Dialog that allows the user to select an item from a list
-
Nested Class Summary
Nested classes/interfaces inherited from class com.googlecode.lanterna.gui2.AbstractBasePane
AbstractBasePane.ContentHolder
Nested classes/interfaces inherited from interface com.googlecode.lanterna.gui2.Window
Window.Hint
-
Field Summary
FieldsFields inherited from class com.googlecode.lanterna.gui2.AbstractBasePane
contentHolder, interactableLookupMap
-
Constructor Summary
ConstructorsConstructorDescriptionListSelectDialog
(String title, String description, TerminalSize listBoxPreferredSize, boolean canCancel, List<T> content) -
Method Summary
Modifier and TypeMethodDescriptionprivate void
onCancel()
private void
showDialog
(WindowBasedTextGUI textGUI) Opens the dialog by showing it on the GUI and doesn't return until the dialog has been closedstatic <T> T
showDialog
(WindowBasedTextGUI textGUI, String title, String description, int listBoxHeight, T... items) Shortcut for quickly creating a new dialogstatic <T> T
showDialog
(WindowBasedTextGUI textGUI, String title, String description, TerminalSize listBoxSize, T... items) Shortcut for quickly creating a new dialogstatic <T> T
showDialog
(WindowBasedTextGUI textGUI, String title, String description, T... items) Shortcut for quickly creating a new dialogMethods inherited from class com.googlecode.lanterna.gui2.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 com.googlecode.lanterna.gui2.AbstractBasePane
addBasePaneListener, getBasePaneListeners, getComponent, getCursorPosition, getFocusedInteractable, getMenuBar, getTheme, invalidate, isInvalid, removeBasePaneListener, setComponent, setEnableDirectionBasedMovements, setFocusedInteractable, setFocusedInteractable, setMenuBar, setStrictFocusChange, setTheme
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.googlecode.lanterna.gui2.BasePane
getTheme, setEnableDirectionBasedMovements, setStrictFocusChange, setTheme
Methods inherited from interface com.googlecode.lanterna.gui2.Window
getBounds, getComponent, getCursorPosition, getFocusedInteractable, getMenuBar, invalidate, isInvalid, setComponent, setFocusedInteractable, setMenuBar
-
Field Details
-
result
-
-
Constructor Details
-
ListSelectDialog
ListSelectDialog(String title, String description, TerminalSize listBoxPreferredSize, boolean canCancel, List<T> content)
-
-
Method Details
-
onSelect
-
onCancel
private void onCancel() -
showDialog
Opens the dialog by showing it on the GUI and doesn't return until the dialog has been closed- Overrides:
showDialog
in classDialogWindow
- 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 totitle
- Title of the dialogdescription
- Description of the dialogitems
- 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 totitle
- Title of the dialogdescription
- Description of the dialoglistBoxHeight
- Maximum height of the list box, scrollbars will be used if there are more itemsitems
- 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 totitle
- Title of the dialogdescription
- Description of the dialoglistBoxSize
- Maximum size of the list box, scrollbars will be used if the items cannot fititems
- Items in the dialog- Returns:
- The selected item or
null
if cancelled
-