Package com.googlecode.lanterna.gui2.dialogs

Class DirectoryDialog

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.DirectoryDialog

All Implemented Interfaces:

BasePane, Composite, Window

public class DirectoryDialog
extends DialogWindow

Dialog that allows the user to iterate the file system and pick directory.

Author:

Martin, FracPete (fracpete at waikato dot ac dot nz)

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

Fields inherited from class com.googlecode.lanterna.gui2.AbstractBasePane

contentHolder, interactableLookupMap

Constructor Summary

Constructors

Constructor	Description
DirectoryDialog(String title, String description, String actionLabel, TerminalSize dialogSize, boolean showHiddenDirs, File selectedObject)	Default constructor for DirectoryDialog

Method Summary

Modifier and Type	Method	Description
File	showDialog(WindowBasedTextGUI textGUI)	Opens the dialog by showing it on the GUI and doesn't return until the dialog has been closed

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 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, setWindowPostRenderer, setVisible, toGlobal, toGlobalFromContentRelative, toGlobalFromDecoratedRelative, waitUntilClosed

Methods inherited from interface com.googlecode.lanterna.gui2.BasePane

getTheme, setEnableDirectionBasedMovements, 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.Window

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

Constructor Detail

DirectoryDialog

public DirectoryDialog(String title,
                       String description,
                       String actionLabel,
                       TerminalSize dialogSize,
                       boolean showHiddenDirs,
                       File selectedObject)

Default constructor for DirectoryDialog

Parameters:

title - Title of the dialog

description - Description of the dialog, is displayed at the top of the content area

actionLabel - Label to use on the "confirm" button, for example "open" or "save"

dialogSize - Rough estimation of how big you want the dialog to be

showHiddenDirs - If true, hidden directories will be visible

selectedObject - Initially selected directory node

Method Detail

showDialog

public File 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 directory which was selected in the dialog or null if the dialog was cancelled