Module com.googlecode.lanterna
Class ActionListDialogBuilder
java.lang.Object
com.googlecode.lanterna.gui2.dialogs.AbstractDialogBuilder<ActionListDialogBuilder,ActionListDialog>
com.googlecode.lanterna.gui2.dialogs.ActionListDialogBuilder
public class ActionListDialogBuilder
extends AbstractDialogBuilder<ActionListDialogBuilder,ActionListDialog>
Dialog builder for the
ActionListDialog
class, use this to create instances of that class and to customize
them-
Field Summary
FieldsFields inherited from class com.googlecode.lanterna.gui2.dialogs.AbstractDialogBuilder
description, extraWindowHints, title
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAdds an additional action to theActionListBox
that is to be displayed when the dialog is opened.Adds an additional action to theActionListBox
that is to be displayed when the dialog is openedaddActions
(Runnable... actions) Adds additional actions to theActionListBox
that is to be displayed when the dialog is opened.protected ActionListDialog
Builds the dialog according to the builder implementationReturns a copy of the internal list of actions currently inside this builder that will be assigned to theActionListBox
in the dialog when builtReturns the specified size of the internalActionListBox
ornull
if there is no size and the list box will attempt to take up enough size to draw all itemsboolean
Returnstrue
if the dialog can be cancelled once it's openedprotected ActionListDialogBuilder
self()
Helper method for casting this totype
parameterB
setCanCancel
(boolean canCancel) Sets if the dialog can be cancelled or not (default:true
)setCloseAutomaticallyOnAction
(boolean closeAutomatically) Sets if clicking on an action automatically closes the dialog after the action is finished (default:true
)setListBoxSize
(TerminalSize listBoxSize) Sets the size of the internalActionListBox
in columns and rows, forcing scrollbars to appear if the space isn't big enough to contain all the itemsMethods inherited from class com.googlecode.lanterna.gui2.dialogs.AbstractDialogBuilder
build, getDescription, getExtraWindowHints, getTitle, setDescription, setExtraWindowHints, setTitle
-
Field Details
-
actions
-
listBoxSize
-
canCancel
private boolean canCancel -
closeAutomatically
private boolean closeAutomatically
-
-
Constructor Details
-
ActionListDialogBuilder
public ActionListDialogBuilder()Default constructor
-
-
Method Details
-
self
Description copied from class:AbstractDialogBuilder
Helper method for casting this totype
parameterB
- Specified by:
self
in classAbstractDialogBuilder<ActionListDialogBuilder,
ActionListDialog> - Returns:
this
asB
-
buildDialog
Description copied from class:AbstractDialogBuilder
Builds the dialog according to the builder implementation- Specified by:
buildDialog
in classAbstractDialogBuilder<ActionListDialogBuilder,
ActionListDialog> - Returns:
- New dialog object
-
setListBoxSize
Sets the size of the internalActionListBox
in columns and rows, forcing scrollbars to appear if the space isn't big enough to contain all the items- Parameters:
listBoxSize
- Size of theActionListBox
- Returns:
- Itself
-
getListBoxSize
Returns the specified size of the internalActionListBox
ornull
if there is no size and the list box will attempt to take up enough size to draw all items- Returns:
- Specified size of the internal
ActionListBox
ornull
if there is no size
-
setCanCancel
Sets if the dialog can be cancelled or not (default:true
)- Parameters:
canCancel
- Iftrue
, the user has the option to cancel the dialog, iffalse
there is no such button in the dialog- Returns:
- Itself
-
isCanCancel
public boolean isCanCancel()Returnstrue
if the dialog can be cancelled once it's opened- Returns:
true
if the dialog can be cancelled once it's opened
-
addAction
Adds an additional action to theActionListBox
that is to be displayed when the dialog is opened- Parameters:
label
- Label of the new actionaction
- Action to perform if the user selects this item- Returns:
- Itself
-
addAction
Adds an additional action to theActionListBox
that is to be displayed when the dialog is opened. The label of this item will be derived by callingtoString()
on the runnable- Parameters:
action
- Action to perform if the user selects this item- Returns:
- Itself
-
addActions
Adds additional actions to theActionListBox
that is to be displayed when the dialog is opened. The label of the items will be derived by callingtoString()
on each runnable- Parameters:
actions
- Items to add to theActionListBox
- Returns:
- Itself
-
getActions
Returns a copy of the internal list of actions currently inside this builder that will be assigned to theActionListBox
in the dialog when built- Returns:
- Copy of the internal list of actions currently inside this builder
-
setCloseAutomaticallyOnAction
Sets if clicking on an action automatically closes the dialog after the action is finished (default:true
)- Parameters:
closeAutomatically
- iftrue
dialog will be automatically closed after choosing and finish any of the action- Returns:
- Itself
-