Merge branch 'master' into custom_disabled_widget_style

rjwills28 · web-flow · commit 9893fdfc62ac · 2025-10-17T10:38:13.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -123,6 +123,5 @@ phoebus-product/settings_template.ini
 
 # doc files generated by docs/source/conf.py 
 docs/source/applications.rst
-docs/source/preference_properties.rst
 docs/source/services.rst
 
diff --git a/app/display/representation-javafx/src/main/java/org/csstudio/display/builder/representation/javafx/JFXStageRepresentation.java b/app/display/representation-javafx/src/main/java/org/csstudio/display/builder/representation/javafx/JFXStageRepresentation.java
@@ -49,7 +49,6 @@ public JFXStageRepresentation(final Stage stage)
     public Parent configureStage(final DisplayModel model, final Consumer<DisplayModel> close_request_handler)
     {
         final String name = model.getDisplayName();
-        stage.setTitle(name);
 
         //  The following trick is necessary because keys cannot be longer than 80 characters.
         final String hexName = Integer.toHexString(name.hashCode()).toLowerCase();
diff --git a/core/ui/src/main/java/org/phoebus/ui/Preferences.java b/core/ui/src/main/java/org/phoebus/ui/Preferences.java
@@ -101,6 +101,10 @@ public class Preferences
     @Preference public static boolean save_credentials;
     /** documentation_location */
     @Preference public static String documentation_location;
+    /** window_title_format **/
+    @Preference public static String window_title_format;
+    /** default_window_title **/
+    @Preference public static String default_window_title;
     /** Custom stylings file */
     @Preference public static String custom_css_styling;
 
diff --git a/core/ui/src/main/java/org/phoebus/ui/application/Messages.java b/core/ui/src/main/java/org/phoebus/ui/application/Messages.java
@@ -50,7 +50,6 @@ public class Messages
     public static String File;
     public static String FileDoesNotExist;
     public static String FileExists;
-    public static String FixedTitle;
     public static String Help;
     public static String HelpAbout;
     public static String HelpAboutAppFea;
diff --git a/core/ui/src/main/java/org/phoebus/ui/application/PhoebusApplication.java b/core/ui/src/main/java/org/phoebus/ui/application/PhoebusApplication.java
@@ -85,6 +85,7 @@
 import org.phoebus.ui.docking.DockPane;
 import org.phoebus.ui.docking.DockPaneListener;
 import org.phoebus.ui.docking.DockStage;
+import org.phoebus.ui.docking.StageTitleManager;
 import org.phoebus.ui.help.OpenAbout;
 import org.phoebus.ui.help.OpenHelp;
 import org.phoebus.ui.internal.MementoHelper;
@@ -547,6 +548,8 @@ private void startUI(final MementoTree memento, final JobMonitor monitor) throws
             closeMainStage();
         });
 
+        StageTitleManager.bindStageTitlesToActiveTabs(main_stage);
+
         DockPane.addListener(dock_pane_listener);
         DockPane.setActiveDockPane(DockStage.getDockPanes(main_stage).get(0));
         monitor.done();
diff --git a/core/ui/src/main/java/org/phoebus/ui/docking/DockPane.java b/core/ui/src/main/java/org/phoebus/ui/docking/DockPane.java
@@ -520,11 +520,6 @@ private void doAutoHideTabs(final Scene scene)
                 throw new IllegalStateException("Expected DockItem, got " + tab);
             stage.titleProperty().bind(((DockItem)tab).labelTextProperty());
         }
-        else
-        {   // Fixed title
-            stage.titleProperty().unbind();
-            stage.setTitle(Messages.FixedTitle);
-        }
     }
 
     /** @param tabs One or more tabs to add */
@@ -533,6 +528,8 @@ public void addTab(final DockItem... tabs)
         getTabs().addAll(tabs);
         // Select the newly added tab
         getSelectionModel().select(getTabs().size()-1);
+        // Set this as the active dock pane
+        setActiveDockPane(this);
     }
 
     /** @return All {@link DockItem}s in this pane (safe copy) */
diff --git a/core/ui/src/main/java/org/phoebus/ui/docking/DockStage.java b/core/ui/src/main/java/org/phoebus/ui/docking/DockStage.java
@@ -164,7 +164,6 @@ else if(layout.getChildren().get(0) instanceof SplitPane){
 
         final Scene scene = new Scene(layout, geometry.width, geometry.height);
         stage.setScene(scene);
-        stage.setTitle(Messages.FixedTitle);
         // Set position
         stage.setX(geometry.x);
         stage.setY(geometry.y);
diff --git a/core/ui/src/main/java/org/phoebus/ui/docking/SplitDock.java b/core/ui/src/main/java/org/phoebus/ui/docking/SplitDock.java
@@ -184,6 +184,16 @@ else if (dock_parent instanceof SplitPane) { // "dock_parent instanceof SplitPan
             return;
         }
 
+        // If the dock pane that has just been merged is active,
+        // switch the active dock pane to the first pane found in the other child
+        if (empty_dock == DockPane.getActiveDockPane()) {
+            if (child instanceof DockPane dockPane) {
+                DockPane.setActiveDockPane(dockPane);
+            } else if (child instanceof SplitDock splitDock) {
+                splitDock.findAndActivateDockPane();
+            }
+        }
+
         // Tell child about its new dock_parent
         if (child instanceof DockPane)
             ((DockPane)child).setDockParent(dock_parent);
@@ -261,6 +271,18 @@ private boolean isEmptyDock(final Node item)
         return false;
     }
 
+    private void findAndActivateDockPane() {
+        // switch the active dock pane to the first pane found in this split or in any nested split
+        for (Node child : getItems()) {
+            if (child instanceof DockPane dockPane) {
+                DockPane.setActiveDockPane(dockPane);
+                return;
+            } else if (child instanceof SplitDock splitDock) {
+                splitDock.findAndActivateDockPane();
+            }
+        }
+    }
+
     @Override
     public String toString()
     {
diff --git a/core/ui/src/main/java/org/phoebus/ui/docking/StageTitleManager.java b/core/ui/src/main/java/org/phoebus/ui/docking/StageTitleManager.java
@@ -0,0 +1,67 @@
+package org.phoebus.ui.docking;
+
+import javafx.beans.binding.Bindings;
+import javafx.beans.binding.StringExpression;
+import javafx.stage.Stage;
+import org.phoebus.ui.Preferences;
+
+import java.util.List;
+
+/**
+ * Helper class to manage the window title.
+ */
+public class StageTitleManager {
+
+    private static final DockPaneListener listener = StageTitleManager::setStageTitleToTabTitle;
+
+    // This class is only a static utility, so it should not be instantiated.
+    private StageTitleManager() {}
+
+    public static void bindStageTitlesToActiveTabs(Stage mainStage) {
+        // this will listen to all tab focus events and set the stage title
+        // of the stage in which the tab is located to the formatted title.
+        DockPane.addListener(listener);
+
+        // This listener is passed down to all child panes when a split occurs,
+        // so it fires when any pane in the main stage becomes empty.
+        // Therefore, we have to check if all panes are empty.
+        DockStage.getDockPanes(mainStage).get(0).addDockPaneEmptyListener(() -> {
+            List<DockPane> panes = DockStage.getDockPanes(mainStage);
+            for (DockPane pane : panes) {
+                if (!pane.getDockItems().isEmpty()) {
+                    // If any pane has items, we don't need to set the title to default
+                    return;
+                }
+            }
+            // If all panes are empty, set the stage title to the default
+            mainStage.titleProperty().unbind();
+            setStageTitleToDefault(mainStage);
+        });
+    }
+
+    private static void setStageTitleToTabTitle(DockItem dockItem) {
+        if (dockItem == null) {
+            return;
+        }
+        DockPane pane = dockItem.getDockPane();
+        // I don't think this is ever true,
+        // but better to have it and not need it than the other way around
+        if (pane == null) {
+            return;
+        }
+        pane.deferUntilInScene(scene -> {
+            if (scene.getWindow() instanceof Stage stage) {
+                if (DockPane.getActiveDockPane() != pane) {
+                    // If the dock pane is not active, don't do anything
+                    return;
+                }
+                StringExpression exp = Bindings.format(Preferences.window_title_format, dockItem.labelTextProperty());
+                stage.titleProperty().bind(exp);
+            }
+        });
+    }
+
+    private static void setStageTitleToDefault(Stage stage) {
+        stage.setTitle(Preferences.default_window_title);
+    }
+}
diff --git a/core/ui/src/main/resources/org/phoebus/ui/application/messages.properties b/core/ui/src/main/resources/org/phoebus/ui/application/messages.properties
@@ -36,7 +36,6 @@ ExitTitle=Exit
 File=File
 FileDoesNotExist=File does not exist!
 FileExists=File \"{0}\" already exists. Do you want to overwrite it?
-FixedTitle=CS-Studio
 Help=Help
 HelpAbout=About
 HelpAboutAppFea=Application Features
diff --git a/core/ui/src/main/resources/org/phoebus/ui/application/messages_fr.properties b/core/ui/src/main/resources/org/phoebus/ui/application/messages_fr.properties
@@ -36,7 +36,6 @@ ExitTitle=Quitter
 File=Fichier
 FileDoesNotExist=Le fichier n\u2019existe pas !
 FileExists=Le fichier \"{0}\" existe d\u00E9j\u00E0. Voulez-vous l\u2019\u00E9craser ?
-FixedTitle=CS-Studio
 Help=Aide
 HelpAbout=\u00c0 propos
 HelpAboutAppFea=Fonctionnalit\u00E9s de l\u2019application
diff --git a/core/ui/src/main/resources/phoebus_ui_preferences.properties b/core/ui/src/main/resources/phoebus_ui_preferences.properties
@@ -180,8 +180,17 @@ save_credentials=false
 # Location of the Phoebus documentation
 documentation_location=
 
+# How to format the window title.
+# The string is formatted with the current active tab as argument.
+# The default is "CS-Studio: %s", where %s is replaced by the name of the active tab.
+# Setting it to just "%s" will show only the active tab.
+# Omitting the %s will always show a static title.
+# When there is no active tab, the default_window_title is used instead.
+window_title_format=CS-Studio: %s
+default_window_title=CS-Studio
+
 # Custom stylings .css file allows users to override Phoebus and JavaFX
 # default stylings.Set the full path to the .css file
 # For a system file use syntax; 'file:</path/to/custom.css>'
 # For a file served over http use syntax: 'http://<address:port/custom.css>'
-custom_css_styling=
+custom_css_styling=
diff --git a/docs/source/_ext/preferences_listing/__init__.py b/docs/source/_ext/preferences_listing/__init__.py
@@ -0,0 +1,37 @@
+"""Extension that creates a new Sphinx domain for documenting Phoebus' preference settings.
+
+Sphinx domain: https://www.sphinx-doc.org/en/master/usage/domains/index.html
+Creating a Sphinx domain tutorial: https://www.sphinx-doc.org/en/master/development/tutorials/adding_domain.html
+"""
+
+from pathlib import Path
+
+from sphinx.application import Sphinx
+from sphinx.util.typing import ExtensionMetadata
+
+from ._domain import PreferencesDomain
+from ._parsing import parse_all_properties_files
+
+
+def setup(app: Sphinx) -> ExtensionMetadata:
+    app.add_config_value(
+        "phoebus_root",
+        (Path(app.confdir) / "../..").resolve(),
+        "html",
+        Path,
+    )
+    app.add_config_value(
+        "phoebus_repository",
+        "https://github.com/ControlSystemStudio/phoebus",
+        "html",
+        str,
+    )
+
+    app.add_domain(PreferencesDomain)
+    app.connect("config-inited", parse_all_properties_files)
+
+    return {
+        "version": "0.1",
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }
diff --git a/docs/source/_ext/preferences_listing/_domain.py b/docs/source/_ext/preferences_listing/_domain.py
diff --git a/docs/source/_ext/preferences_listing/_parsing.py b/docs/source/_ext/preferences_listing/_parsing.py
diff --git a/docs/source/_static/api-font.css b/docs/source/_static/api-font.css
diff --git a/docs/source/conf.py b/docs/source/conf.py
diff --git a/docs/source/preference_properties.rst b/docs/source/preference_properties.rst
diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,6 @@ public JFXStageRepresentation(final Stage stage)`
`49`	`49`	`public Parent configureStage(final DisplayModel model, final Consumer<DisplayModel> close_request_handler)`
`50`	`50`	`{`
`51`	`51`	`final String name = model.getDisplayName();`
`52`		`- stage.setTitle(name);`
`53`	`52`
`54`	`53`	`// The following trick is necessary because keys cannot be longer than 80 characters.`
`55`	`54`	`final String hexName = Integer.toHexString(name.hashCode()).toLowerCase();`
Original file line number	Diff line number	Diff line change
`@@ -520,11 +520,6 @@ private void doAutoHideTabs(final Scene scene)`
`520`	`520`	`throw new IllegalStateException("Expected DockItem, got " + tab);`
`521`	`521`	`stage.titleProperty().bind(((DockItem)tab).labelTextProperty());`
`522`	`522`	`}`
`523`		`- else`
`524`		`- { // Fixed title`
`525`		`- stage.titleProperty().unbind();`
`526`		`- stage.setTitle(Messages.FixedTitle);`
`527`		`- }`
`528`	`523`	`}`
`529`	`524`
`530`	`525`	`/** @param tabs One or more tabs to add */`
`@@ -533,6 +528,8 @@ public void addTab(final DockItem... tabs)`
`533`	`528`	`getTabs().addAll(tabs);`
`534`	`529`	`// Select the newly added tab`
`535`	`530`	`getSelectionModel().select(getTabs().size()-1);`
	`531`	`+ // Set this as the active dock pane`
	`532`	`+ setActiveDockPane(this);`
`536`	`533`	`}`
`537`	`534`
`538`	`535`	`/** @return All {@link DockItem}s in this pane (safe copy) */`