GUI: Better handling of interactive commands

Author: tferr

src/main/java/sc/fiji/snt/gui/cmds/CommonDynamicCmd.java

@@ -34,6 +34,11 @@
 import sc.fiji.snt.SNTUI;
 import sc.fiji.snt.viewer.Viewer3D;
 
+import javax.swing.*;
+import java.awt.*;
+import java.awt.event.WindowAdapter;
+import java.awt.event.WindowEvent;
+
 /**
  * Command class for GUI commands extending DynamicCommand
  *
@@ -149,6 +154,57 @@ protected void resetUI(final boolean validateDimensions, final int state) {
 		statusService.clearStatus();
 	}
 
+	/**
+	 * Finds the SciJava-generated prompt dialog by its title and attaches a
+	 * {@link WindowAdapter} that resets the UI state to {@link SNTUI#READY} when
+	 * the dialog is closed. This is necessary because {@link #init(boolean)} sets
+	 * the state to {@link SNTUI#RUNNING_CMD}, but if the user dismisses the
+	 * dialog without running the command, nothing else resets it.
+	 * <p>
+	 * Subclasses implementing {@link org.scijava.command.Interactive} should call
+	 * this method early (e.g., from {@link #run()}) to ensure the listener is
+	 * attached before the user can close the dialog. The dialog is cached: repeated
+	 * calls are no-ops once it has been found.
+	 *
+	 * @param title  the exact title set via {@code getInfo().setLabel()} — must be
+	 *               unique across open dialogs
+	 * @return the dialog, or {@code null} if not yet created by SciJava
+	 */
+	protected JDialog getPromptWithCloseHandler(final String title) {
+		return getPromptWithCloseHandler(title, null);
+	}
+
+	/**
+	 * Variant of {@link #getPromptWithCloseHandler(String)} that runs an extra
+	 * action when the dialog is closing (e.g., cleaning up listeners).
+	 *
+	 * @param title         the dialog title
+	 * @param extraOnClose  additional action to run on {@code windowClosing}, or
+	 *                      {@code null} for none. Runs <em>before</em> the UI
+	 *                      state is reset.
+	 * @return the dialog, or {@code null} if not yet created
+	 */
+	protected JDialog getPromptWithCloseHandler(final String title, final Runnable extraOnClose) {
+		if (cachedPrompt == null) {
+			for (final Window w : JDialog.getWindows()) {
+				if (w instanceof JDialog && title.equals(((JDialog) w).getTitle())) {
+					cachedPrompt = (JDialog) w;
+					cachedPrompt.addWindowListener(new WindowAdapter() {
+						@Override
+						public void windowClosing(final WindowEvent ignored) {
+							if (extraOnClose != null) extraOnClose.run();
+							if (ui != null) ui.changeState(SNTUI.READY);
+						}
+					});
+					break;
+				}
+			}
+		}
+		return cachedPrompt;
+	}
+
+	private JDialog cachedPrompt;
+
 	protected void notifyExternalDataLoaded() { //TODO: Implement listener
 		// If a display canvas is being used notify plugin
 		snt.updateDisplayCanvases();

src/main/java/sc/fiji/snt/plugin/GWDTMultiSomaCmd.java

@@ -48,8 +48,6 @@ public class GWDTMultiSomaCmd extends GWDTMultiSomaCommonCmd implements Interact
     @Parameter(label = "   Run   ", callback = "runTrace", description = "<HTML>Run multi-soma autotracing")
     private Button run;
 
-    private JDialog prompt;
-
     @SuppressWarnings("unused")
     private void init() {
         getInfo().setLabel(PROMPT_TITLE);
@@ -78,24 +76,19 @@ protected boolean isFileMode() {
     }
 
     private JDialog getPrompt() {
-        if (prompt == null) {
-            for (final Window w : JDialog.getWindows()) {
-                if (w instanceof JDialog && PROMPT_TITLE.equals(((JDialog) w).getTitle())) {
-                    prompt = ((JDialog) w);
-                }
-            }
-        }
-        return prompt;
+        return getPromptWithCloseHandler(PROMPT_TITLE);
     }
 
     @Override
     public void run() {
         // Called on widget change; do nothing. Tracing triggered by runTrace().
+        getPrompt(); // ensure close handler is attached early
     }
 
     @SuppressWarnings("unused")
     private void runTrace() {
-        if (getPrompt() != null) prompt.dispose();
+        final JDialog prompt = getPrompt();
+        if (prompt != null) prompt.dispose();
         new SwingWorker<Void, Void>() {
             @Override
             protected Void doInBackground() {

src/main/java/sc/fiji/snt/plugin/GWDTTracerCmd.java

@@ -69,7 +69,6 @@ public class GWDTTracerCmd extends GWDTTracerCommonCmd implements Interactive {
     @Parameter(label = "   Run   ", callback = "runTrace", description = "<HTML>Run autotracing")
     private Button run;
 
-    private JDialog prompt;
     private AutoTraceConfigDialog configDialog;
 
     @SuppressWarnings("unused")
@@ -100,27 +99,21 @@ protected boolean isFileMode() {
     }
 
     private JDialog getPrompt() {
-        // HACK: See ComputeSecondaryImg#getPrompt()
-        if (prompt == null) {
-            for (final Window w : JDialog.getWindows()) {
-                if (w instanceof JDialog && PROMPT_TITLE.equals(((JDialog) w).getTitle())) {
-                    prompt = ((JDialog) w);
-                }
-            }
-        }
-        return prompt;
+        return getPromptWithCloseHandler(PROMPT_TITLE);
     }
 
     @Override
     public void run() {
         // Called every time a widget changes in the prompt: Do nothing by default.
         // The actual run is triggered by the runTrace() callback.
+        getPrompt(); // ensure close handler is attached early
     }
 
     @SuppressWarnings("unused")
     private void runTrace() {
         if (configDialog != null) configDialog.dispose();
-        if (getPrompt() != null) prompt.dispose();
+        final JDialog prompt = getPrompt();
+        if (prompt != null) prompt.dispose();
         // Button callbacks in Interactive commands run on the EDT,
         // so we must offload the heavy tracing work to a background
         // thread; otherwise setCanvasLabelAllPanes() can never repaint.

src/main/java/sc/fiji/snt/plugin/ShollAnalysisTreeInteractiveCmd.java

@@ -30,6 +30,7 @@
 import org.scijava.plugin.Parameter;
 import org.scijava.plugin.Plugin;
 import org.scijava.widget.Button;
+import sc.fiji.snt.SNTUtils;
 import sc.fiji.snt.Tree;
 
 /**
@@ -63,6 +64,7 @@ public void run() {
 		// There is no "OK" button in the prompt, so we don't need anything here. All functionality is run from callbacks
 		// The code here gets called once the prompt is displayed and when CommandService.run() is called, so we'll only
 		// run analysis if called from a (legacy!?) pre-recorded macro
+		getPromptWithCloseHandler("Sholl Analysis SNT" + SNTUtils.VERSION); // ensure close button resets UI state
 		if (ij.IJ.macroRunning()) {
 			try {
 				runAnalysis();