API cleanup: Detection of stream mode should not rely on any GUI

Author: tferr

src/main/java/sc/fiji/snt/BookmarkManager.java

@@ -339,7 +339,7 @@ private void goToRow(final int tableRow) {
 
     private void noImageOpenError() {
         assert sntui != null;
-        sntui.guiUtils.error((sntui.isStreamMode())
+        sntui.guiUtils.error(sntui.plugin.isStreamMode()
                 ? "No image is currently open. This table can be better accessed from BDV/BVV's <i>Markers</i> pane."
                 : "No image is currently open.");
     }

src/main/java/sc/fiji/snt/CurationManager.java

@@ -1064,7 +1064,7 @@ private JPopupMenu getToolsMenu() {
         final JPopupMenu popup = new JPopupMenu();
         GuiUtils.addSeparator(popup, "Navigation:");
         final JMenu zMenu = visitingZoom.zoomControls("Visiting Zoom Level", "issues");
-        zMenu.setEnabled(sntui != null && !sntui.isStreamMode());
+        zMenu.setEnabled(sntui != null && !sntui.plugin.isStreamMode());
         popup.add(zMenu);
         GuiUtils.addSeparator(popup, "Path Tagging:");
         final JMenuItem colorMenuItem = new JMenuItem("Color Affected Paths by Issue Severity");

src/main/java/sc/fiji/snt/FillManagerUI.java

@@ -116,7 +116,7 @@ public FillManagerUI(final SNT plugin, final SNTUI ui) {
         getRootPane().putClientProperty("JRootPane.menuBarEmbedded", false);
 
         this.plugin = plugin;
-        final boolean streamMode = ui != null && ui.isStreamMode();
+        final boolean streamMode = plugin.isStreamMode();
         pathAndFillManager = plugin.getPathAndFillManager();
         pathAndFillManager.addPathAndFillListener(this);
         listModel = new DefaultListModel<>();
@@ -850,7 +850,7 @@ private void assembleExportFillsMenu() {
                 try {
                     action.execute();
                 } catch (final UnsupportedOperationException ex) {
-                    final String msg = (plugin.getUI() != null && plugin.getUI().isStreamMode())
+                    final String msg = (plugin.isStreamMode())
                             ? "An error occurred: This operation likely requires the entire image to be loaded into memory (RAM)."
                             : "An error occurred.";
                     gUtils.error(msg + " See Console for details.");

src/main/java/sc/fiji/snt/PathManagerUI.java

@@ -5894,7 +5894,7 @@ private JButton zoomToNodeButton() {
                     });
             menu.addSeparator();
             final JMenu zMenu = visitingZoom.zoomControls("Zoom to Node", "nodes");
-            zMenu.setEnabled(plugin.getUI() != null && !plugin.getUI().isStreamMode());
+            zMenu.setEnabled(!plugin.isStreamMode());
             zMenu.setText("Visiting Zoom Level");
             zMenu.setToolTipText("The magnification to be used when zooming into a node");
             menu.add(zMenu);

src/main/java/sc/fiji/snt/SNT.java

@@ -350,6 +350,9 @@ public String toString() {
 
 	/* GUI */
 	protected SNTUI ui;
+	// Whether this session is running in stream mode ("SNT Stream"), i.e., without access to a full
+	// in-core materialized image (see BigDataLoaderCmd)
+	private boolean bigDataMode;
 	protected volatile boolean tracingHalted = false; // Tracing functions paused?
 	protected volatile boolean rubberBandTracing = false; // Rubber band (live preview) tracing mode
 
@@ -981,6 +984,7 @@ public void startUI(final boolean bigDataMode) {
 	}
 
 	private void startUIOnEDT(final boolean bigDataMode) {
+		setBigDataMode(bigDataMode);
 		GuiUtils.setLookAndFeel();
 		final SNT thisPlugin = this;
 		ui = new SNTUI(thisPlugin, bigDataMode);
@@ -3559,7 +3563,7 @@ public void enableSecondaryLayerTracing(final boolean enable) {
 				// NB: enableSecondaryLayerTracing() is reached from several off-EDT callers but showSecondaryData()
 				// does BVV/BDV Swing/OpenGL setup that. Calling it directly from a worker thread is a silent EDT/GL
 				// threading violation (no exception, just a hang), hence the explicit invokeLater() below
-				if (getUI() != null && getUI().isStreamMode()) {
+				if (isStreamMode() && getUI() != null) {
 					final var viewer = getUI().getActiveBigViewer();
 					if (viewer != null) {
 						SwingUtilities.invokeLater(() -> {
@@ -3598,7 +3602,7 @@ public void flushSecondaryData() {
 			// Bdv/Bvv viewer (see enableSecondaryLayerTracing()'s showSecondaryData() hook); flushing it
 			// here should remove that source toot. Same invokeLater() rationale as that hook:
 			// hideSecondaryData() touches Swing/OpenGL state and may be reached from off-EDT callers.
-			if (getUI().isStreamMode()) {
+			if (isStreamMode()) {
 				final var viewer = getUI().getActiveBigViewer();
 				if (viewer != null) {
 					SwingUtilities.invokeLater(() -> {
@@ -4441,7 +4445,7 @@ public void closeAndResetAllPanes() {
 		// Dispose xz/zy images unless the user stored some annotations (ROIs)
 		// on the image overlay or modified them somehow.
 		removeMIPOverlayAllPanes();
-		final boolean bvvMode = getUI() != null && getUI().isStreamMode();
+		final boolean bvvMode = isStreamMode();
 		if (!single_pane) {
 			final ImagePlus[] impPanes = { xz, zy };
 			for (final ImagePlus imp : impPanes) {
@@ -4516,6 +4520,29 @@ public SNTUI getUI() {
 		return ui;
 	}
 
+	/**
+	 * Returns whether this session is running in stream mode ("SNT Stream"), i.e., without access to
+	 * a full in-core materialized image but rather a lazily-loaded BDV/BVV-backed source (typically
+	 * an OME-Zarr/N5 dataset; see {@link sc.fiji.snt.gui.cmds.BigDataLoaderCmd}).
+	 *
+	 * @return true if in stream mode
+	 */
+	public boolean isStreamMode() {
+		return bigDataMode;
+	}
+
+	/**
+	 * Sets the stream-mode flag returned by {@link #isStreamMode()}. Package-private: the only
+	 * legitimate callers are {@link #startUIOnEDT(boolean)} (before constructing {@link SNTUI}) and
+	 * {@link SNTUI}'s own constructor (covering direct {@code new SNTUI(plugin, bigDataMode)}
+	 * construction that bypasses {@link #startUI(boolean)}).
+	 *
+	 * @param bigDataMode the new stream-mode flag
+	 */
+	void setBigDataMode(final boolean bigDataMode) {
+		this.bigDataMode = bigDataMode;
+	}
+
 	/* (non-Javadoc)
 	 * @see MultiDThreePanes#showStatus(int, int, java.lang.String)
 	 */

src/main/java/sc/fiji/snt/SNTService.java

@@ -141,7 +141,7 @@ public boolean isActive() {
 	 */
 	public boolean isStreamMode() {
 		final SNT instance = SNTUtils.getInstance();
-		return instance != null && instance.getUI() != null && instance.getUI().isStreamMode();
+		return instance != null && instance.isStreamMode();
 	}
 
 	/**