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 Details

    • actionLabel

      private String actionLabel

    • suggestedSize

      private TerminalSize suggestedSize

    • selectedDir

      private File selectedDir

    • showHiddenDirectories

      private boolean showHiddenDirectories

  • Constructor Details

    • DirectoryDialogBuilder

      public DirectoryDialogBuilder()
      Default constructor

  • Method Details

    • 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(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 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(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 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