Module com.googlecode.lanterna

Package com.googlecode.lanterna.gui2.dialogs

Class TextInputDialogBuilder

java.lang.Object

com.googlecode.lanterna.gui2.dialogs.AbstractDialogBuilder<TextInputDialogBuilder,TextInputDialog>

com.googlecode.lanterna.gui2.dialogs.TextInputDialogBuilder

public class TextInputDialogBuilder
extends AbstractDialogBuilder<TextInputDialogBuilder,TextInputDialog>

Dialog builder for the TextInputDialog class, use this to create instances of that class and to customize them

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	initialContent
private boolean	passwordInput
private TerminalSize	textBoxSize
private TextInputDialogResultValidator	validator

Fields inherited from class com.googlecode.lanterna.gui2.dialogs.AbstractDialogBuilder

description, extraWindowHints, title

Constructor Summary

Constructors

Constructor	Description
TextInputDialogBuilder()	Default constructor

Method Summary

Modifier and Type	Method	Description
protected TextInputDialog	buildDialog()	Builds the dialog according to the builder implementation
java.lang.String	getInitialContent()	Returns the initial content the dialog will have
TerminalSize	getTextBoxSize()	Returns the size of the text box the dialog will have
TextInputDialogResultValidator	getValidator()	Returns the validator that will be attached to the text box in the dialog
boolean	isPasswordInput()	Returns true if the text box the dialog will have contains a password and should be masked
protected TextInputDialogBuilder	self()	Helper method for casting this to type parameter B
TextInputDialogBuilder	setInitialContent(java.lang.String initialContent)	Sets the initial content the dialog will have
TextInputDialogBuilder	setPasswordInput(boolean passwordInput)	Sets if the text box the dialog will have contains a password and should be masked (default: false)
TextInputDialogBuilder	setTextBoxSize(TerminalSize textBoxSize)	Sets the size of the text box the dialog will have
TextInputDialogBuilder	setValidationPattern(java.util.regex.Pattern pattern, java.lang.String errorMessage)	Helper method that assigned a validator to the text box the dialog will have which matches the pattern supplied
TextInputDialogBuilder	setValidator(TextInputDialogResultValidator validator)	Sets the validator that will be attached to the text box in the dialog

Methods inherited from class com.googlecode.lanterna.gui2.dialogs.AbstractDialogBuilder

build, getDescription, getExtraWindowHints, getTitle, setDescription, setExtraWindowHints, setTitle

Methods inherited from class java.lang.Object

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

Field Detail

initialContent

private java.lang.String initialContent

textBoxSize

private TerminalSize textBoxSize

validator

private TextInputDialogResultValidator validator

passwordInput

private boolean passwordInput

Constructor Detail

TextInputDialogBuilder

public TextInputDialogBuilder()

Default constructor

Method Detail

self

protected TextInputDialogBuilder self()

Description copied from class: AbstractDialogBuilder

Helper method for casting this to type parameter B

Specified by:

self in class AbstractDialogBuilder<TextInputDialogBuilder,TextInputDialog>

Returns:

this as B

buildDialog

protected TextInputDialog buildDialog()

Description copied from class: AbstractDialogBuilder

Builds the dialog according to the builder implementation

Specified by:

buildDialog in class AbstractDialogBuilder<TextInputDialogBuilder,TextInputDialog>

Returns:

New dialog object

setInitialContent

public TextInputDialogBuilder setInitialContent(java.lang.String initialContent)

Sets the initial content the dialog will have

Parameters:

initialContent - Initial content the dialog will have

Returns:

Itself

getInitialContent

public java.lang.String getInitialContent()

Returns the initial content the dialog will have

Returns:

Initial content the dialog will have

setTextBoxSize

public TextInputDialogBuilder setTextBoxSize(TerminalSize textBoxSize)

Sets the size of the text box the dialog will have

Parameters:

textBoxSize - Size of the text box the dialog will have

Returns:

Itself

getTextBoxSize

public TerminalSize getTextBoxSize()

Returns the size of the text box the dialog will have

Returns:

Size of the text box the dialog will have

setValidator

public TextInputDialogBuilder setValidator(TextInputDialogResultValidator validator)

Sets the validator that will be attached to the text box in the dialog

Parameters:

validator - Validator that will be attached to the text box in the dialog

Returns:

Itself

getValidator

public TextInputDialogResultValidator getValidator()

Returns the validator that will be attached to the text box in the dialog

Returns:

validator that will be attached to the text box in the dialog

setValidationPattern

public TextInputDialogBuilder setValidationPattern(java.util.regex.Pattern pattern,
                                                   java.lang.String errorMessage)

Helper method that assigned a validator to the text box the dialog will have which matches the pattern supplied

Parameters:

pattern - Pattern to validate the text box

errorMessage - Error message to show when the pattern doesn't match

Returns:

Itself

setPasswordInput

public TextInputDialogBuilder setPasswordInput(boolean passwordInput)

Sets if the text box the dialog will have contains a password and should be masked (default: false)

Parameters:

passwordInput - true if the text box should be password masked, false otherwise

Returns:

Itself

isPasswordInput

public boolean isPasswordInput()

Returns true if the text box the dialog will have contains a password and should be masked

Returns:

true if the text box the dialog will have contains a password and should be masked