Merge pull request #164 from scijava/file-chooser-titles

Add API to give explicit file chooser title

Author: ctrueden

src/main/java/org/scijava/ui/AbstractUserInterface.java

@@ -31,6 +31,7 @@
 
 package org.scijava.ui;
 
+import java.io.File;
 import java.util.List;
 
 import org.scijava.app.StatusService;
@@ -47,6 +48,7 @@
 import org.scijava.ui.console.ConsolePane;
 import org.scijava.ui.viewer.DisplayViewer;
 import org.scijava.ui.viewer.DisplayWindow;
+import org.scijava.widget.FileWidget;
 
 /**
  * Abstract superclass for {@link UserInterface} implementations.
@@ -186,6 +188,19 @@ public ConsolePane<?> getConsolePane() {
 		return null;
 	}
 
+	@Override
+	public File chooseFile(final File file, final String style) {
+		return chooseFile(fileChooserTitle(style), file, style);
+	}
+
+	@Deprecated
+	@Override
+	public File chooseFile(final String title, final File file,
+		final String style)
+	{
+		throw new UnsupportedOperationException("No default implementation.");
+	}
+
 	@Override
 	public void saveLocation() {
 		final ApplicationFrame appFrame = getApplicationFrame();
@@ -216,4 +231,12 @@ protected void createUI() {
 		restoreLocation();
 	}
 
+	/** Gets a default file chooser title to use when none is given. */
+	protected String fileChooserTitle(final String style) {
+		if (style.equals(FileWidget.DIRECTORY_STYLE)) return "Choose a directory";
+		if (style.equals(FileWidget.OPEN_STYLE)) return "Open";
+		if (style.equals(FileWidget.SAVE_STYLE)) return "Save";
+		return "Choose a file";
+	}
+
 }

src/main/java/org/scijava/ui/DefaultUIService.java

@@ -340,6 +340,15 @@ public File chooseFile(final File file, final String style) {
 		return ui.chooseFile(file, style);
 	}
 
+	@Override
+	public File
+		chooseFile(final String title, final File file, final String style)
+	{
+		final UserInterface ui = getDefaultUI();
+		if (ui == null) return null;
+		return ui.chooseFile(title, file, style);
+	}
+
 	@Override
 	public void showContextMenu(final String menuRoot, final Display<?> display,
 		final int x, final int y)

src/main/java/org/scijava/ui/UIService.java

@@ -276,6 +276,23 @@ DialogPrompt.Result showDialog(String message, String title,
 	 */
 	File chooseFile(File file, String style);
 
+	/**
+	 * Prompts the user to choose a file.
+	 * <p>
+	 * The prompt is displayed in the default user interface.
+	 * </p>
+	 * 
+	 * @param title Title to use in the file chooser dialog.
+	 * @param file The initial value displayed in the file chooser prompt.
+	 * @param style The style of chooser to use:
+	 *          <ul>
+	 *          <li>{@link FileWidget#OPEN_STYLE}</li>
+	 *          <li>{@link FileWidget#SAVE_STYLE}</li>
+	 *          <li>{@link FileWidget#DIRECTORY_STYLE}</li>
+	 *          </ul>
+	 */
+	File chooseFile(String title, File file, String style);
+
 	/**
 	 * Displays a popup context menu for the given display at the specified
 	 * position.

src/main/java/org/scijava/ui/UserInterface.java

@@ -133,6 +133,20 @@ DialogPrompt dialogPrompt(String message, String title,
 	 */
 	File chooseFile(File file, String style);
 
+	/**
+	 * Prompts the user to choose a file.
+	 * 
+	 * @param title Title to use in the file chooser dialog.
+	 * @param file The initial value displayed in the file chooser prompt.
+	 * @param style The style of chooser to use:
+	 *          <ul>
+	 *          <li>{@link FileWidget#OPEN_STYLE}</li>
+	 *          <li>{@link FileWidget#SAVE_STYLE}</li>
+	 *          <li>{@link FileWidget#DIRECTORY_STYLE}</li>
+	 *          </ul>
+	 */
+	File chooseFile(String title, File file, String style);
+
 	/**
 	 * Displays a popup context menu for the given display at the specified
 	 * position.