DisplayViewer: add view(UserInterface, Display)

This method allow DisplayViewer implementations to customize exactly how
they work for each supported UserInterface.

The default implementation tells the UserInterface to create its usual
flavor of DisplayWindow around the Display, invokes view(DisplayWindow,
Display), then DisplayWindow#showDisplay(Display), and finally
Display#update(), as AbstractUserInterface was previously doing.

DisplayViewer implementations needing more control (e.g., if a window
already exists, and we don't want the SwingUI to create another one) may
now override view(UserInterface, Display) to customize this process.

This will be useful in particular for SciView
(https://github.com/scenerygraphics/SciView).

Author: ctrueden

pom.xml

@@ -10,7 +10,7 @@
 	</parent>
 
 	<artifactId>scijava-common</artifactId>
-	<version>2.71.2-SNAPSHOT</version>
+	<version>2.72.0-SNAPSHOT</version>
 
 	<name>SciJava Common</name>
 	<description>SciJava Common is a shared library for SciJava software. It provides a plugin framework, with an extensible mechanism for service discovery, backed by its own annotation processor, so that plugins can be loaded dynamically. It is used by downstream projects in the SciJava ecosystem, such as ImageJ and SCIFIO.</description>

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

@@ -44,7 +44,6 @@
 import org.scijava.prefs.PrefService;
 import org.scijava.thread.ThreadService;
 import org.scijava.ui.viewer.DisplayViewer;
-import org.scijava.ui.viewer.DisplayWindow;
 
 /**
  * Abstract superclass for {@link UserInterface} implementations.
@@ -138,12 +137,8 @@ public void show(final Display<?> display) {
 		threadService.queue(new Runnable() {
 			@Override
 			public void run() {
-				final DisplayWindow displayWindow = createDisplayWindow(display);
-				finalViewer.view(displayWindow, display);
-				displayWindow.setTitle(display.getName());
+				finalViewer.view(AbstractUserInterface.this, display);
 				uiService.addDisplayViewer(finalViewer);
-				displayWindow.showDisplay(true);
-				display.update();
 			}
 		});
 	}

src/main/java/org/scijava/ui/viewer/DisplayViewer.java

@@ -67,6 +67,27 @@ public interface DisplayViewer<T> extends RichPlugin, Disposable {
 	 */
 	boolean canView(Display<?> d);
 
+	/**
+	 * Begins viewing the given display.
+	 * <p>
+	 * The default behavior of this method is to ask the given
+	 * {@link UserInterface} to create a {@link DisplayWindow} via
+	 * {@link UserInterface#createDisplayWindow(Display)} and then pass it to
+	 * {@link #view(DisplayWindow, Display)}. Viewers needing to customize details
+	 * of the {@link DisplayWindow} creation can do so via this method.
+	 * </p>
+	 * 
+	 * @param ui The user interface with which the viewer will be associated.
+	 * @param d the model for the display to show.
+	 */
+	default void view(final UserInterface ui, final Display<?> d) {
+		final DisplayWindow w = ui.createDisplayWindow(d);
+		w.setTitle(d.getName());
+		view(w, d);
+		w.showDisplay(true);
+		d.update();
+	}
+
 	/**
 	 * Begins viewing the given display.
 	 *