diff --git a/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/ConverterPreferences.java b/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/ConverterPreferences.java index fe359bb0fa..e9078796f9 100644 --- a/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/ConverterPreferences.java +++ b/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/ConverterPreferences.java @@ -14,10 +14,12 @@ import java.io.InputStreamReader; import java.util.ArrayList; import java.util.List; +import java.util.Locale; import java.util.logging.Level; import java.util.prefs.Preferences; import java.util.regex.Pattern; +import org.csstudio.display.actions.OpenDisplayAction; import org.csstudio.display.builder.model.util.ModelResourceUtil; import org.phoebus.framework.preferences.AnnotatedPreferences; import org.phoebus.framework.preferences.Preference; @@ -38,6 +40,9 @@ public class ConverterPreferences public static final List paths = new ArrayList<>(); public static volatile File auto_converter_dir; + + /** Target of related displays that EDM opens in a new window */ + public static OpenDisplayAction.Target related_display_target = OpenDisplayAction.Target.TAB; @Preference public static String auto_converter_strip; private static class FontMapping @@ -77,6 +82,8 @@ public FontMapping(final String pattern, final String font_name) logger.log(Level.WARNING, "Cannot parse paths from " + edm_paths_config, ex); } + related_display_target = parseRelatedDisplayTarget(prefs.get("related_display_target")); + final String dir = prefs.get("auto_converter_dir").strip(); if (dir.isEmpty()) auto_converter_dir = null; @@ -93,6 +100,22 @@ public FontMapping(final String pattern, final String font_name) } } + /** @param setting Setting of the related display target, for example "standalone" + * @return Target for that setting, TAB if the setting is not a valid target + */ + static OpenDisplayAction.Target parseRelatedDisplayTarget(final String setting) + { + try + { + return OpenDisplayAction.Target.valueOf(setting.strip().toUpperCase(Locale.ROOT)); + } + catch (IllegalArgumentException ex) + { + logger.log(Level.WARNING, () -> "Unknown related_display_target '" + setting + "', using 'tab'"); + return OpenDisplayAction.Target.TAB; + } + } + public static void parseEdmPaths(final String edm_paths_config) throws Exception { paths.clear(); diff --git a/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/widgets/Convert_relatedDisplayClass.java b/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/widgets/Convert_relatedDisplayClass.java index 860f411a6a..3f3b29e5ff 100644 --- a/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/widgets/Convert_relatedDisplayClass.java +++ b/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/widgets/Convert_relatedDisplayClass.java @@ -11,6 +11,7 @@ import org.csstudio.display.builder.model.properties.ActionInfos; import org.csstudio.display.builder.model.spi.ActionInfo; import org.csstudio.display.builder.model.widgets.ActionButtonWidget; +import org.csstudio.display.converter.edm.ConverterPreferences; import org.csstudio.display.converter.edm.EdmConverter; import org.csstudio.opibuilder.converter.model.EdmBoolean; import org.csstudio.opibuilder.converter.model.EdmString; @@ -45,7 +46,7 @@ public Convert_relatedDisplayClass(final EdmConverter converter, final Widget pa convertColor(t.getBgColor(), widget.propBackgroundColor()); convertColor(t.getFgColor(), widget.propForegroundColor()); convertFont(t.getFont(), widget.propFont()); - + if (widget.propTransparent().getValue()) { // EDM used the fore & back colors for the button, not the menu, // which was always black-on-gray. @@ -80,7 +81,7 @@ public Convert_relatedDisplayClass(final EdmConverter converter, final Widget pa } final EdmBoolean closeDisplay = t.getCloseDisplay().getEdmAttributesMap().get(is); - final OpenDisplayAction.Target target = closeDisplay != null && closeDisplay.is() ? OpenDisplayAction.Target.REPLACE : OpenDisplayAction.Target.TAB.TAB; + final OpenDisplayAction.Target target = closeDisplay != null && closeDisplay.is() ? OpenDisplayAction.Target.REPLACE : ConverterPreferences.related_display_target; OpenDisplayAction openDisplayAction = new OpenDisplayAction(description, path, diff --git a/app/display/convert-edm/src/main/resources/edm_converter_preferences.properties b/app/display/convert-edm/src/main/resources/edm_converter_preferences.properties index 0621084a80..327a758114 100644 --- a/app/display/convert-edm/src/main/resources/edm_converter_preferences.properties +++ b/app/display/convert-edm/src/main/resources/edm_converter_preferences.properties @@ -91,3 +91,14 @@ stp_path_patch_replacement= # Strip "close" buttons which are not needed in Phoebus tabs and windows strip_close_button=true + +# Where a related display opens when EDM would open it in a new window. +# Possible settings, as for the target of an 'Open Display' action: +# +# - tab: New tab in the current window +# - window: New window +# - standalone: New window without tabs and toolbar, sized to the display +# +# A related display with "close display" set replaces the current display, +# whatever this setting is. +related_display_target=tab diff --git a/app/display/convert-edm/src/test/java/org/csstudio/display/converter/edm/RelatedDisplayTargetTest.java b/app/display/convert-edm/src/test/java/org/csstudio/display/converter/edm/RelatedDisplayTargetTest.java new file mode 100644 index 0000000000..5a9d4e4bf2 --- /dev/null +++ b/app/display/convert-edm/src/test/java/org/csstudio/display/converter/edm/RelatedDisplayTargetTest.java @@ -0,0 +1,72 @@ +package org.csstudio.display.converter.edm; + +import static org.hamcrest.CoreMatchers.equalTo; +import static org.hamcrest.MatcherAssert.assertThat; + +import java.io.File; +import java.util.List; + +import org.csstudio.display.actions.OpenDisplayAction; +import org.csstudio.display.actions.OpenDisplayAction.Target; +import org.csstudio.display.builder.model.widgets.ActionButtonWidget; +import org.csstudio.opibuilder.converter.model.EdmModel; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +/** JUnit test for the target of converted related displays */ +@SuppressWarnings("nls") +class RelatedDisplayTargetTest extends TestHelper +{ + private Target original_target; + + @BeforeEach + void rememberTarget() + { + original_target = ConverterPreferences.related_display_target; + } + + @AfterEach + void restoreTarget() + { + ConverterPreferences.related_display_target = original_target; + } + + @Test + void testParseSetting() + { + assertThat(ConverterPreferences.parseRelatedDisplayTarget("standalone"), equalTo(Target.STANDALONE)); + assertThat(ConverterPreferences.parseRelatedDisplayTarget(" WINDOW "), equalTo(Target.WINDOW)); + assertThat(ConverterPreferences.parseRelatedDisplayTarget("tab"), equalTo(Target.TAB)); + assertThat(ConverterPreferences.parseRelatedDisplayTarget("new window"), equalTo(Target.TAB)); + } + + @Test + void testDefaultTarget() throws Exception + { + ConverterPreferences.related_display_target = ConverterPreferences.parseRelatedDisplayTarget("tab"); + assertThat(convertTargets(), equalTo(List.of(Target.TAB, Target.REPLACE))); + } + + @Test + void testStandaloneTarget() throws Exception + { + ConverterPreferences.related_display_target = Target.STANDALONE; + assertThat(convertTargets(), equalTo(List.of(Target.STANDALONE, Target.REPLACE))); + } + + /** @return Targets of the actions of the converted related display button. + * The second related display has 'close display' set. + */ + private List convertTargets() throws Exception + { + EdmModel.reloadEdmColorFile("colors.list", getClass().getResourceAsStream("/colors.list")); + final File edl = new File(getClass().getResource("/related_display.edl").getFile()); + final EdmConverter converter = new EdmConverter(edl, null); + final ActionButtonWidget button = (ActionButtonWidget) converter.getDisplayModel().getChildren().get(0); + return button.propActions().getValue().getActions() + .stream() + .map(action -> ((OpenDisplayAction) action).getTarget()) + .toList(); + } +} diff --git a/app/display/convert-edm/src/test/resources/related_display.edl b/app/display/convert-edm/src/test/resources/related_display.edl new file mode 100644 index 0000000000..f6303234be --- /dev/null +++ b/app/display/convert-edm/src/test/resources/related_display.edl @@ -0,0 +1,53 @@ +4 0 1 +beginScreenProperties +major 4 +minor 0 +release 1 +x 0 +y 0 +w 200 +h 100 +font "helvetica-bold-r-12.0" +ctlFont "helvetica-medium-r-8.0" +btnFont "helvetica-medium-r-8.0" +fgColor index 10 +bgColor index 6 +textColor index 10 +ctlFgColor1 index 25 +ctlFgColor2 index 30 +ctlBgColor1 index 5 +ctlBgColor2 index 10 +topShadowColor index 5 +botShadowColor index 10 +endScreenProperties + +# (Related Display) +object relatedDisplayClass +beginObjectProperties +major 4 +minor 0 +release 0 +x 10 +y 10 +w 90 +h 30 +fgColor index 10 +bgColor index 6 +topShadowColor index 5 +botShadowColor index 10 +font "helvetica-bold-r-12.0" +buttonLabel "Related" +numPvs 4 +numDsps 2 +displayFileName { + 0 "other.edl" + 1 "replacement.edl" +} +menuLabel { + 0 "Other" + 1 "Replacement" +} +closeDisplay { + 1 1 +} +endObjectProperties