Merge pull request #461 from scijava/disable-ui-events-for-invisible-uis

Choose UserInterfaces smarter, ensure UIs shown when UI functionality called

Author: ctrueden

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

@@ -244,17 +244,17 @@ public List<PluginInfo<DisplayViewer<?>>> getViewerPlugins() {
 
 	@Override
 	public void show(final Object o) {
-		getDefaultUI().show(o);
+		getVisibleUI(true).show(o);
 	}
 
 	@Override
 	public void show(final String name, final Object o) {
-		getDefaultUI().show(name, o);
+		getVisibleUI(true).show(name, o);
 	}
 
 	@Override
 	public void show(final Display<?> display) {
-		getDefaultUI().show(display);
+		getVisibleUI(true).show(display);
 	}
 
 	@Override
@@ -309,44 +309,43 @@ public DialogPrompt.Result showDialog(final String message,
 		final String title, final DialogPrompt.MessageType messageType,
 		final DialogPrompt.OptionType optionType)
 	{
-		final UserInterface ui = getDefaultUI();
+		UserInterface ui = getVisibleUI(false);
 		if (ui == null) return null;
-		final DialogPrompt dialogPrompt =
-			ui.dialogPrompt(message, title, messageType, optionType);
+		final DialogPrompt dialogPrompt = ui.dialogPrompt(message, title, messageType, optionType);
 		return dialogPrompt == null ? null : dialogPrompt.prompt();
 	}
 
 	@Override
 	public File chooseFile(final File file, final String style) {
-		final UserInterface ui = getDefaultUI();
+		final UserInterface ui = getVisibleUI(true);
 		return ui == null ? null : ui.chooseFile(file, style);
 	}
 
 	@Override
 	public File
 		chooseFile(final String title, final File file, final String style)
 	{
-		final UserInterface ui = getDefaultUI();
+		final UserInterface ui = getVisibleUI(true);
 		return ui == null ? null : ui.chooseFile(title, file, style);
 	}
 
 	@Override
 	public File[] chooseFiles(File parent, File[] files, FileFilter filter, String style) {
-		final UserInterface ui = getDefaultUI();
+		final UserInterface ui = getVisibleUI(true);
 		return ui == null ? null : ui.chooseFiles(parent, files, filter, style);
 	}
 
 	@Override
 	public List<File> chooseFiles(File parent, List<File> fileList, FileFilter filter, String style) {
-		final UserInterface ui = getDefaultUI();
+		final UserInterface ui = getVisibleUI(true);
 		return ui == null ? null : ui.chooseFiles(parent, fileList, filter, style);
 	}
 
 	@Override
 	public void showContextMenu(final String menuRoot, final Display<?> display,
 		final int x, final int y)
 	{
-		final UserInterface ui = getDefaultUI();
+		final UserInterface ui = getVisibleUI(true);
 		if (ui != null) ui.showContextMenu(menuRoot, display, x, y);
 	}
 
@@ -542,4 +541,21 @@ private void addUserInterface(final String name, final UserInterface ui) {
 	private String getTitle() {
 		return appService.getApp().getTitle();
 	}
+
+	private UserInterface getVisibleUI(final boolean forceShow) {
+		// finds the first (highest priority) VISIBLE UserInterface
+		// if none are visible, then we show default UI if the caller indicated so.
+		UserInterface defaultUI = getDefaultUI();
+		if (defaultUI == null) return null;
+		if (defaultUI.isVisible()) return defaultUI;
+		else if(getVisibleUIs().size() > 0) {
+			return getVisibleUIs().get(0);
+		}
+
+		if (forceShow) {
+			showUI(defaultUI);
+			return defaultUI;
+		}
+		return null;
+	}
 }