Module com.googlecode.lanterna

Package com.googlecode.lanterna.gui2.dialogs

Class DirectoryDialogBuilder

java.lang.Object

com.googlecode.lanterna.gui2.dialogs.AbstractDialogBuilder<DirectoryDialogBuilder,DirectoryDialog>

com.googlecode.lanterna.gui2.dialogs.DirectoryDialogBuilder

public class DirectoryDialogBuilder
extends AbstractDialogBuilder<DirectoryDialogBuilder,DirectoryDialog>

Dialog builder for the DirectoryDialog 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	actionLabel
private java.io.File	selectedDir
private boolean	showHiddenDirectories
private TerminalSize	suggestedSize

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

description, extraWindowHints, title

Constructor Summary

Constructors

Constructor	Description
DirectoryDialogBuilder()	Default constructor

Method Summary

Modifier and Type	Method	Description
protected DirectoryDialog	buildDialog()	Builds the dialog according to the builder implementation
java.lang.String	getActionLabel()	Returns the label on the confirmation button
java.io.File	getSelectedDirectory()	Returns the directory that is initially selected in the dialog
TerminalSize	getSuggestedSize()	Returns the suggested size for the file dialog
boolean	isShowHiddenDirectories()	Checks if hidden directories will be visible in the dialog
protected DirectoryDialogBuilder	self()	Helper method for casting this to type parameter B
DirectoryDialogBuilder	setActionLabel(java.lang.String actionLabel)	Defines the label to be but on the confirmation button (default: "ok").
DirectoryDialogBuilder	setSelectedDirectory(java.io.File selectedDir)	Sets the directory that is initially selected in the dialog
void	setShowHiddenDirectories(boolean showHiddenDirectories)	Sets if hidden directories should be visible in the dialog (default: false
DirectoryDialogBuilder	setSuggestedSize(TerminalSize suggestedSize)	Sets the suggested size for the file dialog, it won't have exactly this size but roughly.

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

actionLabel

private java.lang.String actionLabel

suggestedSize

private TerminalSize suggestedSize

selectedDir

private java.io.File selectedDir

showHiddenDirectories

private boolean showHiddenDirectories

Constructor Detail

DirectoryDialogBuilder

public DirectoryDialogBuilder()

Default constructor

Method Detail

buildDialog

protected DirectoryDialog buildDialog()

Description copied from class: AbstractDialogBuilder

Builds the dialog according to the builder implementation

Specified by:

buildDialog in class AbstractDialogBuilder<DirectoryDialogBuilder,DirectoryDialog>

Returns:

New dialog object

setActionLabel

public DirectoryDialogBuilder setActionLabel(java.lang.String actionLabel)

Defines the label to be but on the confirmation button (default: "ok"). You probably want to set this to LocalizedString.Save.toString() or LocalizedString.Open.toString()

Parameters:

actionLabel - Label to put on the confirmation button

Returns:

Itself

getActionLabel

public java.lang.String getActionLabel()

Returns the label on the confirmation button

Returns:

Label on the confirmation button

setSuggestedSize

public DirectoryDialogBuilder setSuggestedSize(TerminalSize suggestedSize)

Sets the suggested size for the file dialog, it won't have exactly this size but roughly. Default suggested size is 45x10.

Parameters:

suggestedSize - Suggested size for the file dialog

Returns:

Itself

getSuggestedSize

public TerminalSize getSuggestedSize()

Returns the suggested size for the file dialog

Returns:

Suggested size for the file dialog

setSelectedDirectory

public DirectoryDialogBuilder setSelectedDirectory(java.io.File selectedDir)

Sets the directory that is initially selected in the dialog

Parameters:

selectedDir - Directory that is initially selected in the dialog

Returns:

Itself

getSelectedDirectory

public java.io.File getSelectedDirectory()

Returns the directory that is initially selected in the dialog

Returns:

Directory that is initially selected in the dialog

setShowHiddenDirectories

public void setShowHiddenDirectories(boolean showHiddenDirectories)

Sets if hidden directories should be visible in the dialog (default: false

Parameters:

showHiddenDirectories - If true then hidden directories will be visible

isShowHiddenDirectories

public boolean isShowHiddenDirectories()

Checks if hidden directories will be visible in the dialog

Returns:

If true then hidden directories will be visible

self

protected DirectoryDialogBuilder self()

Description copied from class: AbstractDialogBuilder

Helper method for casting this to type parameter B

Specified by:

self in class AbstractDialogBuilder<DirectoryDialogBuilder,DirectoryDialog>

Returns:

this as B