Module qupath.fx
Package qupath.fx.dialogs

Class FileChoosers.Builder<T>

java.lang.Object
qupath.fx.dialogs.FileChoosers.Builder<T>
Type Parameters:
T -
Enclosing class:
FileChoosers
public abstract static class FileChoosers.Builder<T> extends Object
Abstract base class for builders for JavaFX FileChooser and DirectoryChooser.

  • Field Details

    • titleProperty

      protected javafx.beans.property.StringProperty titleProperty

    • initialDirectory

      protected File initialDirectory

    • initialFileName

      protected String initialFileName

    • extensionFilters

      protected Set<javafx.stage.FileChooser.ExtensionFilter> extensionFilters

    • selectedExtensionFilter

      protected javafx.stage.FileChooser.ExtensionFilter selectedExtensionFilter

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public abstract T build()
      Build the chooser using the specified options.
      Returns:

    • title

      public FileChoosers.Builder<T> title(String title)
      Set the chooser title. Note that this is not supported on all platforms (e.g. macOS currently does not display the title).
      Parameters:
      title -
      Returns:

    • titleProperty

      public FileChoosers.Builder<T> titleProperty(javafx.beans.property.StringProperty titleProperty)
      Set the chooser title property. Note that this is not supported on all platforms (e.g. macOS currently does not display the title).
      Parameters:
      titleProperty -
      Returns:

    • initialDirectory

      public FileChoosers.Builder<T> initialDirectory(File dir)
      Set the initial directory for the chooser.
      Parameters:
      dir -
      Returns:

    • initialFile

      public FileChoosers.Builder<T> initialFile(File file)
      Specify the initial file. This is a convenience method that can be used instead of initialDirectory(File) and initialFileName(String). If only a name or directory is valid, this will be used and the other ignored.
      Parameters:
      file -
      Returns:

    • initialFileName

      public FileChoosers.Builder<T> initialFileName(String name)
      Set the initial file name to be selected in the chooser. This has no effect for directory choosers.
      Parameters:
      name -
      Returns:

    • extensionFilter

      public FileChoosers.Builder<T> extensionFilter(String description, String... extensions)
      Set a single extension filter for the chooser from a description and array of extensions.
      Parameters:
      description -
      extensions -
      Returns:
      See Also:

    • extensionFilter

      public FileChoosers.Builder<T> extensionFilter(String description, Collection<String> extensions)
      Set a single extension filter for the chooser from a description and collection of extensions.
      Parameters:
      description -
      extensions -
      Returns:
      See Also:

    • extensionFilters

      public FileChoosers.Builder<T> extensionFilters(javafx.stage.FileChooser.ExtensionFilter... extensionFilters)
      Set zero or more file extension filters for the chooser. This has no effect for directory choosers.
      Parameters:
      extensionFilters -
      Returns:

    • extensionFilters

      public FileChoosers.Builder<T> extensionFilters(Collection<? extends javafx.stage.FileChooser.ExtensionFilter> extensionFilters)
      Set zero or more file extension filters for the chooser from a collection. This has no effect for directory choosers.
      Parameters:
      extensionFilters -
      Returns:

    • selectedExtensionFilter

      public FileChoosers.Builder<T> selectedExtensionFilter(javafx.stage.FileChooser.ExtensionFilter extensionFilter)
      Specify which extension filter should be selected by default. Usually this is not required, as the first filter is selected by default.
      Parameters:
      extensionFilter -
      Returns: