linked_displays = new HashSet<>();
- /** Parse EDL input and convert into {@link DisplayModel}
+ /**
+ * Parse EDL input and convert into {@link DisplayModel}
*
- * Optional {@link AssetLocator} allows for example image
- * widgets to locate their images, automatically downloading
- * it from a http:/.. search path.
+ *
Optional {@link AssetLocator} allows for example image
+ * widgets to locate their images, automatically downloading
+ * it from a http:/.. search path.
*
- * @param input EDL input file
- * @param asset_locator Optional {@link AssetLocator} or null
- * @throws Exception on error
+ * @param input EDL input file
+ * @param asset_locator Optional {@link AssetLocator} or null
+ * @throws Exception on error
*/
- public EdmConverter(final File input, final AssetLocator asset_locator) throws Exception
- {
+ public EdmConverter(final File input, final AssetLocator asset_locator) throws Exception {
this.asset_locator = asset_locator;
logger.log(Level.FINE, "Parsing EDM " + input);
@@ -85,8 +85,8 @@ public EdmConverter(final File input, final AssetLocator asset_locator) throws E
// Create Display Model
final String name = input.getName()
- .replace(".edl", "")
- .replace('_', ' ');
+ .replace(".edl", "")
+ .replace('_', ' ');
model.propName().setValue(name);
model.propX().setValue(edm.getX());
model.propY().setValue(edm.getY());
@@ -99,8 +99,7 @@ public EdmConverter(final File input, final AssetLocator asset_locator) throws E
model.propName().setValue(edm.getTitle());
model.propGridVisible().setValue(edm.isShowGrid());
- if (edm.getGridSize() > 0)
- {
+ if (edm.getGridSize() > 0) {
model.propGridStepX().setValue(edm.getGridSize());
model.propGridStepY().setValue(edm.getGridSize());
}
@@ -111,89 +110,93 @@ public EdmConverter(final File input, final AssetLocator asset_locator) throws E
correctChildWidgets(model);
}
- /** @return {@link DisplayModel} */
- public DisplayModel getDisplayModel()
- {
+ /**
+ * @return {@link DisplayModel}
+ */
+ public DisplayModel getDisplayModel() {
return model;
}
- /** @param output File to write with Display Builder model
- * @throws Exception on error
+ /**
+ * @param output File to write with Display Builder model
+ * @throws Exception on error
*/
- public void write(final File output) throws Exception
- {
+ public void write(final File output) throws Exception {
logger.log(Level.FINE, "Writing " + output);
final ModelWriter writer = new ModelWriter(new FileOutputStream(output));
writer.writeModel(model);
writer.close();
}
- /** @return Number of next group */
- public int nextGroup()
- {
+ /**
+ * @return Number of next group
+ */
+ public int nextGroup() {
return next_group.getAndIncrement();
}
- /** Request download of asset.
+ /**
+ * Request download of asset.
*
- *
NOP when this converter doesn't have an {@link AssetLocator}.
+ *
NOP when this converter doesn't have an {@link AssetLocator}.
*
- * @param asset Asset of a widget, for example PNG file for Image widget
- * @throws Exception
+ * @param asset Asset of a widget, for example PNG file for Image widget
+ * @throws Exception
*/
- public void downloadAsset(final String asset) throws Exception
- {
+ public void downloadAsset(final String asset) throws Exception {
if (asset_locator != null)
asset_locator.locate(asset);
}
- /** @return Displays that were included by this display (embedded, symbol) */
- public Collection getIncludedDisplays()
- {
+ /**
+ * @return Displays that were included by this display (embedded, symbol)
+ */
+ public Collection getIncludedDisplays() {
return included_displays.stream().sorted().collect(Collectors.toList());
}
- /** @return Displays that were linked from this display (related display) */
- public Collection getLinkedDisplays()
- {
+ /**
+ * @return Displays that were linked from this display (related display)
+ */
+ public Collection getLinkedDisplays() {
return linked_displays.stream().sorted().collect(Collectors.toList());
}
- /** @param x X offset and
- * @param y Y offset of widgets within currently handled container
+ /**
+ * @param x X offset and
+ * @param y Y offset of widgets within currently handled container
*/
- public void addPositionOffset(final int x, final int y)
- {
+ public void addPositionOffset(final int x, final int y) {
offset_x += x;
offset_y += y;
}
- /** @return X offset of widgets within currently handled container */
- public int getOffsetX()
- {
+ /**
+ * @return X offset of widgets within currently handled container
+ */
+ public int getOffsetX() {
return offset_x;
}
- /** @return Y offset of widgets within currently handled container */
- public int getOffsetY()
- {
+ /**
+ * @return Y offset of widgets within currently handled container
+ */
+ public int getOffsetY() {
return offset_y;
}
- /** Convert one widget
- * @param parent Parent
- * @param edm EDM widget to convert
+ /**
+ * Convert one widget
+ *
+ * @param parent Parent
+ * @param edm EDM widget to convert
*/
- public void convertWidget(final Widget parent, final EdmEntity edm)
- {
- if (edm instanceof EdmWidget)
- {
- final EdmWidget w = (EdmWidget) edm;
- if (w.getX() + w.getW() <= 0 ||
- w.getY() + w.getH() <= 0)
- {
+ public void convertWidget(final Widget parent, final EdmEntity edm) {
+ if (edm instanceof EdmWidget w) {
+ if (w.getX() + w.getW() <= 0 ||
+ w.getY() + w.getH() <= 0) {
logger.log(Level.WARNING, "Skipping off-screen widget " + edm.getType() +
- " @ " + w.getX() + "," + w.getY() + " sized " + w.getW() + " x " + w.getH());
+ " @ " + w.getX() + "," + w.getY() + " sized " + w.getW() + " x " + w.getH());
return;
}
}
@@ -201,82 +204,71 @@ public void convertWidget(final Widget parent, final EdmEntity edm)
// Given an EDM Widget type like "activeXTextClass",
// locate the matching "Convert_activeXTextClass"
final Class clazz;
- try
- {
+ try {
final String wc_name = ConverterBase.class.getPackageName() +
- ".Convert_" +
- edm.getType().replace(':', '_');
+ ".Convert_" +
+ edm.getType().replace(':', '_');
clazz = Class.forName(wc_name);
- }
- catch (ClassNotFoundException ex)
- {
+ } catch (ClassNotFoundException ex) {
logger.log(Level.WARNING, "No converter for EDM " + edm.getType());
return;
}
- try
- {
- for (Constructor c : clazz.getConstructors())
- { // Look for suitable constructor
+ try {
+ for (Constructor c : clazz.getConstructors()) { // Look for suitable constructor
final Class[] parms = c.getParameterTypes();
- if (parms.length == 3 &&
- parms[0] == EdmConverter.class &&
- parms[1] == Widget.class &&
- EdmWidget.class.isAssignableFrom(parms[2]))
- {
+ if (parms.length == 3 &&
+ parms[0] == EdmConverter.class &&
+ parms[1] == Widget.class &&
+ EdmWidget.class.isAssignableFrom(parms[2])) {
// Simply constructing the converter will perform the conversion
c.newInstance(this, parent, edm);
return;
}
}
throw new Exception(clazz.getSimpleName() + " lacks required constructor");
- }
- catch (Exception ex)
- {
+ } catch (Exception ex) {
logger.log(Level.WARNING, "Cannot convert " + edm.getType(), ex);
}
}
- /** Correct widget issues
+ /**
+ * Correct widget issues
+ *
+ * Called after all widgets have been added to a parent
*
- *
Called after all widgets have been added to a parent
- * @param parent
+ * @param parent
*/
- public void correctChildWidgets(final Widget parent)
- {
+ public void correctChildWidgets(final Widget parent) {
final ChildrenProperty children = ChildrenProperty.getChildren(parent);
mergeButtons(children);
fixCoveredButtons(children);
raiseTransparentButtons(children);
}
- /** Merge action buttons that are overlapping into one button.
- * EDM supports 'invisible' buttons which react to left or
- * right mouse button to occupy the same space.
- * In display builder, only the left button triggers an action.
- * The right button opens the context menu.
- * So merge actions from all overlapping buttons into one.
+ /**
+ * Merge action buttons that are overlapping into one button.
+ * EDM supports 'invisible' buttons which react to left or
+ * right mouse button to occupy the same space.
+ * In display builder, only the left button triggers an action.
+ * The right button opens the context menu.
+ * So merge actions from all overlapping buttons into one.
*
- * @param children Child widgets to correct
+ * @param children Child widgets to correct
*/
- private void mergeButtons(final ChildrenProperty children)
- {
+ private void mergeButtons(final ChildrenProperty children) {
// Start with the topmost button, i.e. end of list
final List copy = new ArrayList<>(children.getValue());
- for (int i=copy.size()-1; i>=0; --i)
- {
+ for (int i = copy.size() - 1; i >= 0; --i) {
final Widget widget = copy.get(i);
- if (! (widget instanceof ActionButtonWidget))
+ if (!(widget instanceof ActionButtonWidget bw))
continue;
- final ActionButtonWidget bw = (ActionButtonWidget) widget;
// Look for buttons below that occupy roughly the same space
- for (int o=i-1; o>=0; --o)
- {
+ for (int o = i - 1; o >= 0; --o) {
final Widget other = copy.get(o);
- if (! (other instanceof ActionButtonWidget && doWidgetsOverlap(widget, other)))
+ if (!(other instanceof ActionButtonWidget ob && doWidgetsOverlap(widget, other)))
continue;
- final ActionButtonWidget ob = (ActionButtonWidget) other;
logger.log(Level.INFO, "Merging actions from overlapping " + widget + " and " + other + " into one:");
logger.log(Level.INFO, "1) " + widget.propActions().getValue());
@@ -287,8 +279,7 @@ private void mergeButtons(final ChildrenProperty children)
// When merging buttons, as soon as one button is visible.
// the remaining (merged) button must be visible
- if (! ob.propTransparent().getValue())
- {
+ if (!ob.propTransparent().getValue()) {
bw.propTransparent().setValue(false);
bw.propText().setValue(ob.propText().getValue());
bw.propForegroundColor().setValue(ob.propForegroundColor().getValue());
@@ -305,69 +296,67 @@ private void mergeButtons(final ChildrenProperty children)
}
}
- /** Do two widgets overlap, no matter which one covers the other?
- * @param widget
- * @param other
- * @return Do the widgets overlap by a considerable amount?
+ /**
+ * Do two widgets overlap, no matter which one covers the other?
+ *
+ * @param widget
+ * @param other
+ * @return Do the widgets overlap by a considerable amount?
*/
- private boolean doWidgetsOverlap(final Widget widget, final Widget other)
- {
+ private boolean doWidgetsOverlap(final Widget widget, final Widget other) {
final Rectangle2D w = new Rectangle2D.Double(widget.propX().getValue(),
- widget.propY().getValue(),
- widget.propWidth().getValue(),
- widget.propHeight().getValue());
+ widget.propY().getValue(),
+ widget.propWidth().getValue(),
+ widget.propHeight().getValue());
final Rectangle2D o = new Rectangle2D.Double(other.propX().getValue(),
- other.propY().getValue(),
- other.propWidth().getValue(),
- other.propHeight().getValue());
+ other.propY().getValue(),
+ other.propWidth().getValue(),
+ other.propHeight().getValue());
final Rectangle2D common = w.createIntersection(o);
- if (common.getWidth() <= 0 || common.getHeight() <= 0)
+ if (common.getWidth() <= 0 || common.getHeight() <= 0)
return false;
final int overlap = (int) (common.getWidth() * common.getHeight());
final int avg_area = (int) (w.getWidth() * w.getHeight() +
- o.getWidth() * o.getHeight()) / 2;
+ o.getWidth() * o.getHeight()) / 2;
// Overlap by at least a 5th??
return overlap > avg_area / 5;
}
- /** Make covered buttons 'transparent'.
- * EDM supports buttons in the back of rectangles etc.
- * They're not visible, but they react to mouse clicks.
- * In display builder, covered buttons are, well, covered.
- * Make them 'transparent', and a follow-up operation then raises
- * all transparent buttons to the top so they get mouse clicks.
+ /**
+ * Make covered buttons 'transparent'.
+ * EDM supports buttons in the back of rectangles etc.
+ * They're not visible, but they react to mouse clicks.
+ * In display builder, covered buttons are, well, covered.
+ * Make them 'transparent', and a follow-up operation then raises
+ * all transparent buttons to the top so they get mouse clicks.
*
- * @param children Child widgets to correct
+ * @param children Child widgets to correct
*/
- private void fixCoveredButtons(final ChildrenProperty children)
- {
+ private void fixCoveredButtons(final ChildrenProperty children) {
final List list = children.getValue();
// Start of list = lowest widget
- for (int i=0; i> check = other.checkProperty(CommonWidgetProperties.propTransparent);
- if (check.isPresent() && check.get().getValue())
+ if (check.isPresent() && check.get().getValue())
continue;
// .. or invisible widgets
check = other.checkProperty(CommonWidgetProperties.propVisible);
- if (check.isPresent() && !check.get().getValue())
+ if (check.isPresent() && !check.get().getValue())
continue;
// Does other widget cover this one?
- if (! isWidgetCovered(bottom, other))
+ if (!isWidgetCovered(bottom, other))
continue;
logger.log(Level.INFO, bottom + " is covered by " + other + ". Making it 'transparent' so it'll be raised.");
@@ -379,23 +368,24 @@ private void fixCoveredButtons(final ChildrenProperty children)
}
}
- /** Does one widget cover the other?
- * @param bottom
- * @param top
- * @return Does top widget cover the one at the bottom by a considerable amount?
+ /**
+ * Does one widget cover the other?
+ *
+ * @param bottom
+ * @param top
+ * @return Does top widget cover the one at the bottom by a considerable amount?
*/
- private boolean isWidgetCovered(final Widget bottom, final Widget top)
- {
+ private boolean isWidgetCovered(final Widget bottom, final Widget top) {
final Rectangle2D w = new Rectangle2D.Double(bottom.propX().getValue(),
- bottom.propY().getValue(),
- bottom.propWidth().getValue(),
- bottom.propHeight().getValue());
+ bottom.propY().getValue(),
+ bottom.propWidth().getValue(),
+ bottom.propHeight().getValue());
final Rectangle2D o = new Rectangle2D.Double(top.propX().getValue(),
- top.propY().getValue(),
- top.propWidth().getValue(),
- top.propHeight().getValue());
+ top.propY().getValue(),
+ top.propWidth().getValue(),
+ top.propHeight().getValue());
final Rectangle2D common = w.createIntersection(o);
- if (common.getWidth() <= 0 || common.getHeight() <= 0)
+ if (common.getWidth() <= 0 || common.getHeight() <= 0)
return false;
final int overlap = (int) (common.getWidth() * common.getHeight());
@@ -404,24 +394,20 @@ private boolean isWidgetCovered(final Widget bottom, final Widget top)
return overlap > bottom_area / 2;
}
- /** Move transparent buttons to front.
- * In EDM, transparent buttons may be placed behind text etc.
- * In display builder, normal widget order would
- * then have text block mouse events from button.
- * @param children Child widgets to correct
+ /**
+ * Move transparent buttons to front.
+ * In EDM, transparent buttons may be placed behind text etc.
+ * In display builder, normal widget order would
+ * then have text block mouse events from button.
+ *
+ * @param children Child widgets to correct
*/
- private void raiseTransparentButtons(final ChildrenProperty children)
- {
+ private void raiseTransparentButtons(final ChildrenProperty children) {
final List copy = new ArrayList<>(children.getValue());
- for (Widget widget : copy)
- {
- if (widget instanceof ActionButtonWidget)
- {
- final ActionButtonWidget b = (ActionButtonWidget) widget;
- if (b.propTransparent().getValue())
- {
- try
- {
+ for (Widget widget : copy) {
+ if (widget instanceof ActionButtonWidget b) {
+ if (b.propTransparent().getValue()) {
+ try {
// Get absolute widget coords and check if widget is inside a group
final DisplayModel display = widget.getDisplayModel();
final javafx.geometry.Rectangle2D bounds = GeometryTools.getDisplayBounds(widget);
@@ -431,18 +417,15 @@ private void raiseTransparentButtons(final ChildrenProperty children)
// If it was a top-level widget, just add back to display
if (top_level)
logger.log(Level.INFO, "Raising transparent " + b);
- else
- { // If widget was in group, raising it within the group could still mean
+ else { // If widget was in group, raising it within the group could still mean
// that group is covered by something else.
// So place at absolute coords and then place in display, not original group
logger.log(Level.INFO, "Raising transparent " + b + " and moving from group to top");
- widget.propX().setValue((int)bounds.getMinX());
- widget.propY().setValue((int)bounds.getMinY());
+ widget.propX().setValue((int) bounds.getMinX());
+ widget.propY().setValue((int) bounds.getMinY());
}
display.runtimeChildren().addChild(widget);
- }
- catch (Exception ex)
- {
+ } catch (Exception ex) {
logger.log(Level.WARNING, "Failed to raise transparent " + b, ex);
}
}
@@ -450,15 +433,17 @@ private void raiseTransparentButtons(final ChildrenProperty children)
}
}
- /** @param included_display Register a display that's included by the currently converted file */
- public void addIncludedDisplay(final String included_display)
- {
+ /**
+ * @param included_display Register a display that's included by the currently converted file
+ */
+ public void addIncludedDisplay(final String included_display) {
included_displays.add(included_display);
}
- /** @param linked_display Register a display that was linked from the currently converted file */
- public void addLinkedDisplay(final String linked_display)
- {
+ /**
+ * @param linked_display Register a display that was linked from the currently converted file
+ */
+ public void addLinkedDisplay(final String linked_display) {
linked_displays.add(linked_display);
}
}
diff --git a/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/widgets/Convert_activeExitButtonClass.java b/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/widgets/Convert_activeExitButtonClass.java
index d82c8816ff..2a55f5f48f 100644
--- a/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/widgets/Convert_activeExitButtonClass.java
+++ b/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/widgets/Convert_activeExitButtonClass.java
@@ -7,43 +7,42 @@
*******************************************************************************/
package org.csstudio.display.converter.edm.widgets;
-import java.util.Collections;
-import java.util.List;
-
import org.csstudio.display.builder.model.Widget;
import org.csstudio.display.builder.model.properties.ActionInfos;
-import org.csstudio.display.builder.model.properties.ExecuteScriptActionInfo;
import org.csstudio.display.builder.model.properties.ScriptInfo;
import org.csstudio.display.builder.model.widgets.ActionButtonWidget;
import org.csstudio.display.converter.edm.EdmConverter;
import org.csstudio.opibuilder.converter.model.EdmWidget;
import org.csstudio.opibuilder.converter.model.Edm_activeExitButtonClass;
+import org.csstudio.display.actions.ExecuteScriptAction;
+
+import java.util.Collections;
+import java.util.List;
-/** Convert an EDM widget into Display Builder counterpart
- * @author Kay Kasemir
- * @author Matevz, Lei Hu, Xihui Chen et al - Original logic in Opi_.. converter
+/**
+ * Convert an EDM widget into Display Builder counterpart
+ *
+ * @author Kay Kasemir
+ * @author Matevz, Lei Hu, Xihui Chen et al - Original logic in Opi_.. converter
*/
@SuppressWarnings("nls")
-public class Convert_activeExitButtonClass extends ConverterBase
-{
+public class Convert_activeExitButtonClass extends ConverterBase {
private static final String exit =
- "from org.csstudio.display.builder.runtime.script import ScriptUtil\n" +
- "ScriptUtil.closeDisplay(widget)\n";
+ "from org.csstudio.display.builder.runtime.script import ScriptUtil\n" +
+ "ScriptUtil.closeDisplay(widget)\n";
private static final ScriptInfo script = new ScriptInfo(ScriptInfo.EMBEDDED_PYTHON, exit, false, Collections.emptyList());
- public Convert_activeExitButtonClass(final EdmConverter converter, final Widget parent, final Edm_activeExitButtonClass t)
- {
+ public Convert_activeExitButtonClass(final EdmConverter converter, final Widget parent, final Edm_activeExitButtonClass t) {
super(converter, parent, t);
convertColor(t.getBgColor(), widget.propBackgroundColor());
convertColor(t.getFgColor(), widget.propForegroundColor());
convertFont(t.getFont(), widget.propFont());
widget.propText().setValue(t.getLabel());
- widget.propActions().setValue(new ActionInfos(List.of(new ExecuteScriptActionInfo("close", script))));
+ widget.propActions().setValue(new ActionInfos(List.of(new ExecuteScriptAction("close", script))));
}
@Override
- protected ActionButtonWidget createWidget(final EdmWidget edm)
- {
+ protected ActionButtonWidget createWidget(final EdmWidget edm) {
return new ActionButtonWidget();
}
}
diff --git a/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/widgets/Convert_activeMessageButtonClass.java b/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/widgets/Convert_activeMessageButtonClass.java
index c0fdb02853..32e5a5a521 100644
--- a/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/widgets/Convert_activeMessageButtonClass.java
+++ b/app/display/convert-edm/src/main/java/org/csstudio/display/converter/edm/widgets/Convert_activeMessageButtonClass.java
@@ -7,29 +7,30 @@
*******************************************************************************/
package org.csstudio.display.converter.edm.widgets;
-import static org.csstudio.display.converter.edm.Converter.logger;
-
-import java.util.List;
-import java.util.logging.Level;
-
import org.csstudio.display.builder.model.Widget;
import org.csstudio.display.builder.model.persist.NamedWidgetColors;
-import org.csstudio.display.builder.model.properties.ActionInfos;
import org.csstudio.display.builder.model.properties.ConfirmDialog;
-import org.csstudio.display.builder.model.properties.WritePVActionInfo;
+import org.csstudio.display.builder.model.properties.ActionInfos;
import org.csstudio.display.builder.model.widgets.ActionButtonWidget;
import org.csstudio.display.builder.model.widgets.BoolButtonWidget;
import org.csstudio.display.converter.edm.EdmConverter;
import org.csstudio.opibuilder.converter.model.EdmWidget;
import org.csstudio.opibuilder.converter.model.Edm_activeMessageButtonClass;
+import org.csstudio.display.actions.WritePVAction;
+
+import java.util.List;
+import java.util.logging.Level;
-/** Convert an EDM widget into Display Builder counterpart
- * @author Kay Kasemir
- * @author Matevz, Lei Hu, Xihui Chen et al - Original logic in Opi_.. converter
+import static org.csstudio.display.converter.edm.Converter.logger;
+
+/**
+ * Convert an EDM widget into Display Builder counterpart
+ *
+ * @author Kay Kasemir
+ * @author Matevz, Lei Hu, Xihui Chen et al - Original logic in Opi_.. converter
*/
@SuppressWarnings("nls")
-public class Convert_activeMessageButtonClass extends ConverterBase
-{
+public class Convert_activeMessageButtonClass extends ConverterBase {
// No perfect match.
//
// When EDM message button is 'toggle', we use a BoolButtonWidget that writes 0, 1.
@@ -37,12 +38,10 @@ public class Convert_activeMessageButtonClass extends ConverterBase
//
// When EDM message button is 'push', we use ActionButtonWidget that writes the 'push' value,
// falling back to the 'release' value, but can't write both.
- public Convert_activeMessageButtonClass(final EdmConverter converter, final Widget parent, final Edm_activeMessageButtonClass mb)
- {
+ public Convert_activeMessageButtonClass(final EdmConverter converter, final Widget parent, final Edm_activeMessageButtonClass mb) {
super(converter, parent, mb);
- if (is_boolean(mb))
- {
+ if (is_boolean(mb)) {
// Create bool button that writes 0/1
final BoolButtonWidget b = (BoolButtonWidget) widget;
b.propShowLED().setValue(false);
@@ -56,8 +55,7 @@ public Convert_activeMessageButtonClass(final EdmConverter converter, final Widg
// EDM MB has no alarms sensitive border
b.propBorderAlarmSensitive().setValue(false);
- if (mb.getPassword() != null)
- {
+ if (mb.getPassword() != null) {
b.propConfirmDialog().setValue(ConfirmDialog.BOTH);
b.propPassword().setValue(mb.getPassword());
}
@@ -65,28 +63,22 @@ public Convert_activeMessageButtonClass(final EdmConverter converter, final Widg
final String pv = convertPVName(mb.getControlPv());
b.propPVName().setValue(pv);
- if (mb.isToggle())
- {
+ if (mb.isToggle()) {
b.propMode().setValue(BoolButtonWidget.Mode.TOGGLE);
// Toggle will always write 1 in 'on', 0 in 'off' state.
// If EDM widget reversed 1/0, swap the labels and colors.
- if ("0".equals(mb.getPressValue()))
- {
+ if ("0".equals(mb.getPressValue())) {
b.propOffLabel().setValue(mb.getOnLabel());
b.propOnLabel().setValue(mb.getOffLabel());
convertColor(mb.getOffColor(), b.propOnColor());
convertColor(mb.getOnColor(), b.propOffColor());
}
- }
- else
- if ("0".equals(mb.getPressValue()) &&
+ } else if ("0".equals(mb.getPressValue()) &&
"1".equals(mb.getReleaseValue()))
- b.propMode().setValue(BoolButtonWidget.Mode.PUSH_INVERTED);
- else
- b.propMode().setValue(BoolButtonWidget.Mode.PUSH);
- }
- else
- {
+ b.propMode().setValue(BoolButtonWidget.Mode.PUSH_INVERTED);
+ else
+ b.propMode().setValue(BoolButtonWidget.Mode.PUSH);
+ } else {
// Create action button that writes a value on 'click'
final ActionButtonWidget b = (ActionButtonWidget) widget;
convertColor(mb.getOnColor(), b.propBackgroundColor());
@@ -103,49 +95,43 @@ public Convert_activeMessageButtonClass(final EdmConverter converter, final Widg
if (mb.getControlPv() == null)
logger.log(Level.WARNING, "Message button '" + desc + "' without PV");
- else
- {
+ else {
final String pv = convertPVName(mb.getControlPv());
// Write a value when clicked.
// Ordinarily, that's the 'press' value.
// Could also be the 'release' value,
// but can only be one of them.
- final boolean have_press_value = mb.getPressValue() != null && !mb.getPressValue().isEmpty();
- final boolean have_release_value = mb.getReleaseValue() != null && !mb.getReleaseValue().isEmpty();
+ final boolean have_press_value = mb.getPressValue() != null && !mb.getPressValue().isEmpty();
+ final boolean have_release_value = mb.getReleaseValue() != null && !mb.getReleaseValue().isEmpty();
final String value;
- if (have_press_value)
- {
+ if (have_press_value) {
value = mb.getPressValue();
// If there is a release value, warn that it's ignored.
// OK to skip a release value that matches the press value,
// since we wrote it on press.
- if (have_release_value && !mb.getReleaseValue().equals(mb.getPressValue()))
+ if (have_release_value && !mb.getReleaseValue().equals(mb.getPressValue()))
logger.log(Level.WARNING, "Cannot convert EDM message 'push' button '" + desc + "' for release message '" + mb.getReleaseValue() +
"', will only write the 'press' message " + pv + " = '" + mb.getPressValue() + "'");
- }
- else if (have_release_value)
+ } else if (have_release_value)
value = mb.getReleaseValue();
- else
- {
+ else {
value = "";
logger.log(Level.WARNING, "EDM message 'push' button '" + desc + "' lacks both 'press' and 'release'; writing empty string");
}
// Set the button's $(pv_name) macro to the PV name, and use that within the write-PV action
b.propPVName().setValue(pv);
- b.propActions().setValue(new ActionInfos(List.of(new WritePVActionInfo(desc, "$(pv_name)", value))));
+ b.propActions().setValue(new ActionInfos(List.of(new WritePVAction(desc, "$(pv_name)", value))));
}
- if (mb.getPassword() != null)
- {
+ if (mb.getPassword() != null) {
b.propConfirmDialog().setValue(true);
b.propPassword().setValue(mb.getPassword());
}
// Turn invisible EDM button into transparent, no text action button
- if (mb.isInvisible())
- {
+ if (mb.isInvisible()) {
b.propBackgroundColor().setValue(NamedWidgetColors.TRANSPARENT);
b.propText().setValue("");
b.propTransparent().setValue(true);
@@ -154,8 +140,7 @@ else if (have_release_value)
}
@Override
- protected Widget createWidget(final EdmWidget edm)
- {
+ protected Widget createWidget(final EdmWidget edm) {
final Edm_activeMessageButtonClass mb = (Edm_activeMessageButtonClass) edm;
if (is_boolean(mb))
return new BoolButtonWidget();
@@ -163,11 +148,10 @@ protected Widget createWidget(final EdmWidget edm)
return new ActionButtonWidget();
}
- private boolean is_boolean(final Edm_activeMessageButtonClass mb)
- {
+ private boolean is_boolean(final Edm_activeMessageButtonClass mb) {
// When EDM button writes 1/0 or 0/1, use a BoolButtonWidget
return ("1".equals(mb.getPressValue()) && "0".equals(mb.getReleaseValue()))
- ||
- ("0".equals(mb.getPressValue()) && "1".equals(mb.getReleaseValue()));
+ ||
+ ("0".equals(mb.getPressValue()) && "1".equals(mb.getReleaseValue()));
}
}
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 684b877f27..155fd092b2 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
@@ -7,50 +7,46 @@
*******************************************************************************/
package org.csstudio.display.converter.edm.widgets;
-import static org.csstudio.display.converter.edm.Converter.logger;
-
-import java.util.ArrayList;
-import java.util.List;
-import java.util.logging.Level;
-
import org.csstudio.display.builder.model.Widget;
import org.csstudio.display.builder.model.persist.NamedWidgetColors;
-import org.csstudio.display.builder.model.properties.ActionInfo;
import org.csstudio.display.builder.model.properties.ActionInfos;
-import org.csstudio.display.builder.model.properties.OpenDisplayActionInfo;
-import org.csstudio.display.builder.model.properties.OpenDisplayActionInfo.Target;
+import org.csstudio.display.builder.model.spi.ActionInfo;
import org.csstudio.display.builder.model.widgets.ActionButtonWidget;
import org.csstudio.display.converter.edm.EdmConverter;
import org.csstudio.opibuilder.converter.model.EdmBoolean;
import org.csstudio.opibuilder.converter.model.EdmString;
import org.csstudio.opibuilder.converter.model.EdmWidget;
import org.csstudio.opibuilder.converter.model.Edm_relatedDisplayClass;
+import org.csstudio.display.actions.OpenDisplayAction;
import org.phoebus.framework.macros.Macros;
-/** Convert an EDM widget into Display Builder counterpart
- * @author Kay Kasemir
- * @author Matevz, Lei Hu, Xihui Chen et al - Original logic in Opi_.. converter
+import java.util.ArrayList;
+import java.util.List;
+import java.util.logging.Level;
+
+import static org.csstudio.display.converter.edm.Converter.logger;
+
+/**
+ * Convert an EDM widget into Display Builder counterpart
+ *
+ * @author Kay Kasemir
+ * @author Matevz, Lei Hu, Xihui Chen et al - Original logic in Opi_.. converter
*/
@SuppressWarnings("nls")
-public class Convert_relatedDisplayClass extends ConverterBase
-{
- public Convert_relatedDisplayClass(final EdmConverter converter, final Widget parent, final Edm_relatedDisplayClass t)
- {
+public class Convert_relatedDisplayClass extends ConverterBase {
+ public Convert_relatedDisplayClass(final EdmConverter converter, final Widget parent, final Edm_relatedDisplayClass t) {
super(converter, parent, t);
- if (t.isInvisible())
- {
+ if (t.isInvisible()) {
widget.propBackgroundColor().setValue(NamedWidgetColors.TRANSPARENT);
widget.propTransparent().setValue(true);
- }
- else
+ } else
convertColor(t.getBgColor(), widget.propBackgroundColor());
convertColor(t.getFgColor(), widget.propForegroundColor());
convertFont(t.getFont(), widget.propFont());
List actions = new ArrayList<>();
- for (int i=0; i
-{
- public Convert_shellCmdClass(final EdmConverter converter, final Widget parent, final Edm_shellCmdClass t)
- {
+public class Convert_shellCmdClass extends ConverterBase {
+ public Convert_shellCmdClass(final EdmConverter converter, final Widget parent, final Edm_shellCmdClass t) {
super(converter, parent, t);
- if (t.isInvisible())
- {
+ if (t.isInvisible()) {
widget.propBackgroundColor().setValue(NamedWidgetColors.TRANSPARENT);
widget.propTransparent().setValue(true);
- }
- else
+ } else
convertColor(t.getBgColor(), widget.propBackgroundColor());
convertColor(t.getFgColor(), widget.propForegroundColor());
convertFont(t.getFont(), widget.propFont());
List actions = new ArrayList<>();
- for (int i=0; i
+
diff --git a/app/display/convert-medm/pom.xml b/app/display/convert-medm/pom.xml
index da116c3361..9b5e63c52e 100644
--- a/app/display/convert-medm/pom.xml
+++ b/app/display/convert-medm/pom.xml
@@ -29,5 +29,10 @@
app-display-model
4.7.4-SNAPSHOT
+
+ org.phoebus
+ app-display-actions
+ 4.7.4-SNAPSHOT
+
diff --git a/app/display/convert-medm/src/main/java/org/csstudio/opibuilder/adl2boy/translator/MessageButton2Model.java b/app/display/convert-medm/src/main/java/org/csstudio/opibuilder/adl2boy/translator/MessageButton2Model.java
index 1d6b2f6065..6df8392c03 100644
--- a/app/display/convert-medm/src/main/java/org/csstudio/opibuilder/adl2boy/translator/MessageButton2Model.java
+++ b/app/display/convert-medm/src/main/java/org/csstudio/opibuilder/adl2boy/translator/MessageButton2Model.java
@@ -1,29 +1,28 @@
/*************************************************************************\
-* Copyright (c) 2010 UChicago Argonne, LLC
-* This file is distributed subject to a Software License Agreement found
-* in the file LICENSE that is included with this distribution.
-/*************************************************************************/
+ * Copyright (c) 2010 UChicago Argonne, LLC
+ * This file is distributed subject to a Software License Agreement found
+ * in the file LICENSE that is included with this distribution.
+ /*************************************************************************/
package org.csstudio.opibuilder.adl2boy.translator;
-import static org.csstudio.display.converter.medm.Converter.logger;
-
-import java.util.ArrayList;
-import java.util.List;
-import java.util.logging.Level;
-
import org.csstudio.display.builder.model.ChildrenProperty;
import org.csstudio.display.builder.model.Widget;
-import org.csstudio.display.builder.model.properties.ActionInfo;
-import org.csstudio.display.builder.model.properties.ActionInfos;
import org.csstudio.display.builder.model.properties.WidgetColor;
-import org.csstudio.display.builder.model.properties.WritePVActionInfo;
+import org.csstudio.display.builder.model.spi.ActionInfo;
import org.csstudio.display.builder.model.widgets.ActionButtonWidget;
import org.csstudio.display.builder.model.widgets.BoolButtonWidget;
import org.csstudio.display.builder.model.widgets.BoolButtonWidget.Mode;
import org.csstudio.display.builder.model.widgets.VisibleWidget;
import org.csstudio.utility.adlparser.fileParser.ADLWidget;
import org.csstudio.utility.adlparser.fileParser.widgets.MessageButton;
+import org.csstudio.display.actions.WritePVAction;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.logging.Level;
+
+import static org.csstudio.display.converter.medm.Converter.logger;
@SuppressWarnings("nls")
public class MessageButton2Model extends AbstractADL2Model {
@@ -38,8 +37,7 @@ public void processWidget(ADLWidget adlWidget) throws Exception {
setADLObjectProps(messageButtonWidget, widgetModel);
setADLControlProps(messageButtonWidget, widgetModel);
- if (widgetModel instanceof BoolButtonWidget)
- {
+ if (widgetModel instanceof BoolButtonWidget) {
final BoolButtonWidget bool_button = (BoolButtonWidget) widgetModel;
// Don't show LED.
@@ -52,11 +50,9 @@ public void processWidget(ADLWidget adlWidget) throws Exception {
WidgetColor color = bool_button.propBackgroundColor().getValue();
bool_button.propOffColor().setValue(color);
// Darken for 'pressed' state
- color = new WidgetColor(color.getRed()*80/100, color.getGreen()*80/100, color.getBlue()*80/100);
+ color = new WidgetColor(color.getRed() * 80 / 100, color.getGreen() * 80 / 100, color.getBlue() * 80 / 100);
bool_button.propOnColor().setValue(color);
- }
- else
- {
+ } else {
final ActionButtonWidget action_button = (ActionButtonWidget) widgetModel;
action_button.propText().setValue(messageButtonWidget.getLabel());
final List actions = new ArrayList<>();
@@ -64,53 +60,43 @@ public void processWidget(ADLWidget adlWidget) throws Exception {
final String message;
final String press_msg = messageButtonWidget.getPress_msg();
final String release_msg = messageButtonWidget.getRelease_msg();
- if (!press_msg.isEmpty() && release_msg.isEmpty())
+ if (!press_msg.isEmpty() && release_msg.isEmpty())
message = press_msg;
- else if (press_msg.isEmpty() && !release_msg.isEmpty())
- {
- logger.log(Level.FINE, "Message Button '" + messageButtonWidget.getLabel() + "' has no press_msg, so release_msg='" + release_msg + "' is written to " + messageButtonWidget.getAdlControl().getChan());
+ else if (press_msg.isEmpty() && !release_msg.isEmpty()) {
+ logger.log(Level.FINE, "Message Button '" + messageButtonWidget.getLabel() + "' has no press_msg, so release_msg='" + release_msg + "' is written to " + messageButtonWidget.getAdlControl().getChan());
message = release_msg;
- }
- else if (!press_msg.isEmpty() && !release_msg.isEmpty())
- {
- logger.log(Level.WARNING, "Message Button '" + messageButtonWidget.getLabel() + "' release_msg='" + release_msg + "' is ignored. Only writing press_msg='" + press_msg + "' to " + messageButtonWidget.getAdlControl().getChan());
+ } else if (!press_msg.isEmpty() && !release_msg.isEmpty()) {
+ logger.log(Level.WARNING, "Message Button '" + messageButtonWidget.getLabel() + "' release_msg='" + release_msg + "' is ignored. Only writing press_msg='" + press_msg + "' to " + messageButtonWidget.getAdlControl().getChan());
message = press_msg;
- }
- else
- {
- logger.log(Level.WARNING, "Message Button '" + messageButtonWidget.getLabel() + "' has neither press_msg nor release_msg, writing empty string to " + messageButtonWidget.getAdlControl().getChan());;
+ } else {
+ logger.log(Level.WARNING, "Message Button '" + messageButtonWidget.getLabel() + "' has neither press_msg nor release_msg, writing empty string to " + messageButtonWidget.getAdlControl().getChan());
+ ;
message = "";
}
- actions.add(new WritePVActionInfo("Write", messageButtonWidget.getAdlControl().getChan(), message));
-
- widgetModel.propActions().setValue(new ActionInfos(actions));
+ actions.add(new WritePVAction("Write", messageButtonWidget.getAdlControl().getChan(), message));
}
}
@Override
public void makeModel(ADLWidget adlWidget,
- Widget parentModel) {
+ Widget parentModel) {
// Turn 'message' button that writes 0/1 into 'bool' button
MessageButton messageButtonWidget = new MessageButton(adlWidget);
String press_msg = messageButtonWidget.getPress_msg();
String release_msg = messageButtonWidget.getRelease_msg();
- if ("1".equals(press_msg) && "0".equals(release_msg))
- {
+ if ("1".equals(press_msg) && "0".equals(release_msg)) {
final BoolButtonWidget bool_button = new BoolButtonWidget();
bool_button.propMode().setValue(Mode.PUSH);
logger.log(Level.FINE, "Message button for press=1, release=0 converted into boolean push button");
widgetModel = bool_button;
- }
- else if ("0".equals(press_msg) && "1".equals(release_msg))
- {
+ } else if ("0".equals(press_msg) && "1".equals(release_msg)) {
final BoolButtonWidget bool_button = new BoolButtonWidget();
bool_button.propMode().setValue(Mode.PUSH_INVERTED);
logger.log(Level.FINE, "Message button for press=0, release=1 converted into inverted boolean push button");
widgetModel = bool_button;
- }
- else // Messages other than 0,1 need action button
- widgetModel = new ActionButtonWidget();
+ } else // Messages other than 0,1 need action button
+ widgetModel = new ActionButtonWidget();
ChildrenProperty.getChildren(parentModel).addChild(widgetModel);
}
diff --git a/app/display/convert-medm/src/main/java/org/csstudio/opibuilder/adl2boy/translator/RelatedDisplay2Model.java b/app/display/convert-medm/src/main/java/org/csstudio/opibuilder/adl2boy/translator/RelatedDisplay2Model.java
index 5ddb0f613d..4531eaaefb 100644
--- a/app/display/convert-medm/src/main/java/org/csstudio/opibuilder/adl2boy/translator/RelatedDisplay2Model.java
+++ b/app/display/convert-medm/src/main/java/org/csstudio/opibuilder/adl2boy/translator/RelatedDisplay2Model.java
@@ -11,15 +11,14 @@
import org.csstudio.display.builder.model.ChildrenProperty;
import org.csstudio.display.builder.model.Widget;
-import org.csstudio.display.builder.model.properties.ActionInfo;
import org.csstudio.display.builder.model.properties.ActionInfos;
-import org.csstudio.display.builder.model.properties.OpenDisplayActionInfo;
-import org.csstudio.display.builder.model.properties.OpenDisplayActionInfo.Target;
import org.csstudio.display.builder.model.properties.WidgetColor;
+import org.csstudio.display.builder.model.spi.ActionInfo;
import org.csstudio.display.builder.model.widgets.ActionButtonWidget;
import org.csstudio.utility.adlparser.fileParser.ADLWidget;
import org.csstudio.utility.adlparser.fileParser.widgetParts.RelatedDisplayItem;
import org.csstudio.utility.adlparser.fileParser.widgets.RelatedDisplay;
+import org.csstudio.display.actions.OpenDisplayAction;
import org.phoebus.framework.macros.Macros;
/**
@@ -60,7 +59,7 @@ public void processWidget(ADLWidget adlWidget) throws Exception {
// allow user to use 'Ctrl' etc at runtime.
// Users can always close the new tab, but have no other way
// to get new tab.
- final Target target = displays.length == 1 ? Target.REPLACE : Target.TAB;
+ final OpenDisplayAction.Target target = displays.length == 1 ? OpenDisplayAction.Target.REPLACE : OpenDisplayAction.Target.TAB;
for (RelatedDisplayItem display : displays)
{
final ActionInfo action = createOpenDisplayAction(display, target);
@@ -88,7 +87,7 @@ public void processWidget(ADLWidget adlWidget) throws Exception {
* @param target
* @return ActionInfo
*/
- public ActionInfo createOpenDisplayAction(final RelatedDisplayItem rdDisplay, Target target)
+ public ActionInfo createOpenDisplayAction(final RelatedDisplayItem rdDisplay, OpenDisplayAction.Target target)
{
final String file = rdDisplay.getFileName()
.replaceAll("\"", "")
@@ -108,7 +107,7 @@ public ActionInfo createOpenDisplayAction(final RelatedDisplayItem rdDisplay, Ta
target = target.TAB;
}
- return new OpenDisplayActionInfo(description, file, getMacros(rdDisplay), target);
+ return new OpenDisplayAction(description, file, getMacros(rdDisplay), target);
}
public Macros getMacros(RelatedDisplayItem rdDisplay)
diff --git a/app/display/convert-medm/src/main/java/org/csstudio/opibuilder/adl2boy/translator/ShellCommand2Model.java b/app/display/convert-medm/src/main/java/org/csstudio/opibuilder/adl2boy/translator/ShellCommand2Model.java
index c70fdfc13c..49ea35506e 100644
--- a/app/display/convert-medm/src/main/java/org/csstudio/opibuilder/adl2boy/translator/ShellCommand2Model.java
+++ b/app/display/convert-medm/src/main/java/org/csstudio/opibuilder/adl2boy/translator/ShellCommand2Model.java
@@ -5,14 +5,13 @@
import org.csstudio.display.builder.model.ChildrenProperty;
import org.csstudio.display.builder.model.Widget;
-import org.csstudio.display.builder.model.properties.ActionInfo;
-import org.csstudio.display.builder.model.properties.ActionInfos;
-import org.csstudio.display.builder.model.properties.ExecuteCommandActionInfo;
import org.csstudio.display.builder.model.properties.WidgetColor;
+import org.csstudio.display.builder.model.spi.ActionInfo;
import org.csstudio.display.builder.model.widgets.ActionButtonWidget;
import org.csstudio.utility.adlparser.fileParser.ADLWidget;
import org.csstudio.utility.adlparser.fileParser.widgetParts.CommandItem;
import org.csstudio.utility.adlparser.fileParser.widgets.ShellCommand;
+import org.csstudio.display.actions.ExecuteCommandAction;
public class ShellCommand2Model extends AbstractADL2Model {
@@ -32,11 +31,10 @@ public void processWidget(ADLWidget adlWidget) throws Exception {
if (! cmd.getCommandName().replaceAll("\"", "").isEmpty())
{
final String command = cmd.getCommandName() + " " + cmd.getArgs();
- actions.add(new ExecuteCommandActionInfo(cmd.getLabel(), command));
+ actions.add(new ExecuteCommandAction(cmd.getLabel(), command));
}
widgetModel.propText().setValue(commandWidget.getLabel());
- widgetModel.propActions().setValue(new ActionInfos(actions));
}
@Override
diff --git a/app/display/editor/src/main/java/org/csstudio/display/builder/editor/properties/ActionsPropertyBinding.java b/app/display/editor/src/main/java/org/csstudio/display/builder/editor/properties/ActionsPropertyBinding.java
index a743f0b02c..150ab0f0d0 100644
--- a/app/display/editor/src/main/java/org/csstudio/display/builder/editor/properties/ActionsPropertyBinding.java
+++ b/app/display/editor/src/main/java/org/csstudio/display/builder/editor/properties/ActionsPropertyBinding.java
@@ -7,9 +7,9 @@
*******************************************************************************/
package org.csstudio.display.builder.editor.properties;
-import java.util.List;
-import java.util.Optional;
-
+import javafx.event.ActionEvent;
+import javafx.event.EventHandler;
+import javafx.scene.control.Button;
import org.csstudio.display.builder.editor.undo.SetWidgetPropertyAction;
import org.csstudio.display.builder.model.Widget;
import org.csstudio.display.builder.model.WidgetPropertyListener;
@@ -18,40 +18,43 @@
import org.csstudio.display.builder.representation.javafx.actionsdialog.ActionsDialog;
import org.phoebus.ui.undo.UndoableActionManager;
-import javafx.event.ActionEvent;
-import javafx.event.EventHandler;
-import javafx.scene.control.Button;
+import java.util.List;
+import java.util.Optional;
-/** Bidirectional binding between an actions property in model and Java FX Node in the property panel
- * @author Kay Kasemir
+/**
+ * Bidirectional binding between an actions property in model and Java FX Node in the property panel
+ *
+ * @author Kay Kasemir
*/
@SuppressWarnings("nls")
public class ActionsPropertyBinding
- extends WidgetPropertyBinding
-{
- /** Update property panel field as model changes */
+ extends WidgetPropertyBinding {
+ /**
+ * Update property panel field as model changes
+ */
private final WidgetPropertyListener model_listener = (p, o, n) ->
{
jfx_node.setText(widget_property.toString());
};
- /** Update model from user input */
- private EventHandler action_handler = event ->
+ private ActionsWidgetProperty p;
+
+ /**
+ * Update model from user input
+ */
+ private final EventHandler action_handler = event ->
{
final ActionsDialog dialog = new ActionsDialog(widget_property.getWidget(), widget_property.getValue(), jfx_node);
- if (! other.isEmpty())
- { // Update dialog's header to include warning about affected widgets
+ if (!other.isEmpty()) { // Update dialog's header to include warning about affected widgets
final StringBuilder buf = new StringBuilder();
buf.append(dialog.getHeaderText()).append("\n\n");
buf.append("ATTENTION, this will update the actions of ").append(other.size() + 1).append(" widgets:\n");
buf.append(" - ").append(widget_property.getWidget());
int count = 1;
- for (Widget w : other)
- {
+ for (Widget w : other) {
buf.append("\n - ").append(w);
- if (++count > 4)
- {
+ if (++count > 4) {
final int left = other.size() + 1 - count;
if (left > 0)
buf.append(" ... ").append(left).append(" more ...");
@@ -62,45 +65,44 @@ public class ActionsPropertyBinding
}
final Optional result = dialog.showAndWait();
- if (result.isPresent())
- {
+ if (result.isPresent()) {
undo.execute(new SetWidgetPropertyAction<>(widget_property, result.get()));
- if (! other.isEmpty())
- {
+ if (!other.isEmpty()) {
final String path = widget_property.getPath();
- for (Widget w : other)
- {
+ for (Widget w : other) {
final ActionsWidgetProperty other_prop = (ActionsWidgetProperty) w.getProperty(path);
undo.execute(new SetWidgetPropertyAction<>(other_prop, result.get()));
}
}
}
+ else{
+ //widget_property.setValue(p.getValue());
+ }
};
- /** @param undo Undo manager
- * @param field Gui element in editor
- * @param widget_property Actions property
- * @param other Other selected widgets
+ /**
+ * @param undo Undo manager
+ * @param field Gui element in editor
+ * @param widget_property Actions property
+ * @param other Other selected widgets
*/
public ActionsPropertyBinding(final UndoableActionManager undo,
final Button field,
final ActionsWidgetProperty widget_property,
- final List other)
- {
+ final List other) {
super(undo, field, widget_property, other);
+ p = widget_property;
}
@Override
- public void bind()
- {
+ public void bind() {
widget_property.addPropertyListener(model_listener);
jfx_node.setOnAction(action_handler);
jfx_node.setText(widget_property.toString());
}
@Override
- public void unbind()
- {
+ public void unbind() {
jfx_node.setOnAction(null);
widget_property.removePropertyListener(model_listener);
}
diff --git a/app/display/editor/src/main/java/org/csstudio/display/builder/editor/properties/PropertyPanelSection.java b/app/display/editor/src/main/java/org/csstudio/display/builder/editor/properties/PropertyPanelSection.java
index d5fde2634c..78fa18be25 100644
--- a/app/display/editor/src/main/java/org/csstudio/display/builder/editor/properties/PropertyPanelSection.java
+++ b/app/display/editor/src/main/java/org/csstudio/display/builder/editor/properties/PropertyPanelSection.java
@@ -7,16 +7,28 @@
*******************************************************************************/
package org.csstudio.display.builder.editor.properties;
-import static org.csstudio.display.builder.editor.Plugin.logger;
-
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.List;
-import java.util.Optional;
-import java.util.function.Function;
-import java.util.logging.Level;
-import java.util.function.Consumer;
-
+import javafx.event.ActionEvent;
+import javafx.event.EventHandler;
+import javafx.geometry.HPos;
+import javafx.geometry.Insets;
+import javafx.geometry.Pos;
+import javafx.scene.Node;
+import javafx.scene.control.Button;
+import javafx.scene.control.CheckBox;
+import javafx.scene.control.ComboBox;
+import javafx.scene.control.Label;
+import javafx.scene.control.Separator;
+import javafx.scene.control.Spinner;
+import javafx.scene.control.TextField;
+import javafx.scene.control.ToggleButton;
+import javafx.scene.control.Tooltip;
+import javafx.scene.image.ImageView;
+import javafx.scene.layout.BorderPane;
+import javafx.scene.layout.ColumnConstraints;
+import javafx.scene.layout.GridPane;
+import javafx.scene.layout.HBox;
+import javafx.scene.layout.Priority;
+import javafx.scene.layout.StackPane;
import org.csstudio.display.builder.editor.DisplayEditor;
import org.csstudio.display.builder.editor.Messages;
import org.csstudio.display.builder.editor.undo.SetMacroizedWidgetPropertyAction;
@@ -31,8 +43,8 @@
import org.csstudio.display.builder.model.WidgetProperty;
import org.csstudio.display.builder.model.WidgetPropertyCategory;
import org.csstudio.display.builder.model.persist.WidgetClassesService;
-import org.csstudio.display.builder.model.properties.ActionsWidgetProperty;
import org.csstudio.display.builder.model.properties.BooleanWidgetProperty;
+import org.csstudio.display.builder.model.properties.ColorMap;
import org.csstudio.display.builder.model.properties.ColorMapWidgetProperty;
import org.csstudio.display.builder.model.properties.ColorWidgetProperty;
import org.csstudio.display.builder.model.properties.CommonWidgetProperties;
@@ -40,15 +52,15 @@
import org.csstudio.display.builder.model.properties.FilenameWidgetProperty;
import org.csstudio.display.builder.model.properties.FontWidgetProperty;
import org.csstudio.display.builder.model.properties.MacrosWidgetProperty;
+import org.csstudio.display.builder.model.properties.NamedWidgetColor;
import org.csstudio.display.builder.model.properties.PVNameWidgetProperty;
+import org.csstudio.display.builder.model.properties.ActionsWidgetProperty;
import org.csstudio.display.builder.model.properties.PointsWidgetProperty;
+import org.csstudio.display.builder.model.properties.PredefinedColorMaps;
import org.csstudio.display.builder.model.properties.RulesWidgetProperty;
import org.csstudio.display.builder.model.properties.ScriptsWidgetProperty;
import org.csstudio.display.builder.model.properties.WidgetClassProperty;
import org.csstudio.display.builder.model.properties.WidgetColor;
-import org.csstudio.display.builder.model.properties.NamedWidgetColor;
-import org.csstudio.display.builder.model.properties.ColorMap;
-import org.csstudio.display.builder.model.properties.PredefinedColorMaps;
import org.csstudio.display.builder.representation.javafx.FilenameSupport;
import org.phoebus.framework.macros.MacroHandler;
import org.phoebus.ui.autocomplete.PVAutocompleteMenu;
@@ -57,60 +69,47 @@
import org.phoebus.ui.javafx.ImageCache;
import org.phoebus.ui.undo.UndoableActionManager;
-import javafx.event.ActionEvent;
-import javafx.event.EventHandler;
-import javafx.geometry.HPos;
-import javafx.geometry.Insets;
-import javafx.geometry.Pos;
-import javafx.scene.Node;
-import javafx.scene.control.Button;
-import javafx.scene.control.CheckBox;
-import javafx.scene.control.ComboBox;
-import javafx.scene.control.Label;
-import javafx.scene.control.Separator;
-import javafx.scene.control.Spinner;
-import javafx.scene.control.TextField;
-import javafx.scene.control.ToggleButton;
-import javafx.scene.control.Tooltip;
-import javafx.scene.image.ImageView;
-import javafx.scene.layout.BorderPane;
-import javafx.scene.layout.ColumnConstraints;
-import javafx.scene.layout.GridPane;
-import javafx.scene.layout.HBox;
-import javafx.scene.layout.Priority;
-import javafx.scene.layout.StackPane;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.Optional;
+import java.util.function.Consumer;
+import java.util.function.Function;
+import java.util.logging.Level;
-/** Section of Property panel
- *
- * A grid with 3 columns:
- *
- * - Name of property
- *
- Class Indicator. May be empty or show the "C" for class-defined property.
- * In class-editor mode it turns into a checkbox.
- *
- Editor for Value of Property.
- * The editor for the value of the property may be a single text field,
- * or a button or even a HBox with more elements.
- *
+import static org.csstudio.display.builder.editor.Plugin.logger;
+
+/**
+ * Section of Property panel
*
- * The {@link PropertyPanel} currently uses just one large {@link PropertyPanelSection}.
+ *
A grid with 3 columns:
+ *
+ * - Name of property
+ *
- Class Indicator. May be empty or show the "C" for class-defined property.
+ * In class-editor mode it turns into a checkbox.
+ *
- Editor for Value of Property.
+ * The editor for the value of the property may be a single text field,
+ * or a button or even a HBox with more elements.
+ *
*
- * The elements of a structure or elements of an array could be (and had in the past been)
- * placed in their own sub-{@link PropertyPanelSection}s.
- * That makes it easier to add/remove array elements by just updating the affected sub-section,
- * but is would then be much harder to get all property name and editor fields to align
- * through subsections.
+ *
The {@link PropertyPanel} currently uses just one large {@link PropertyPanelSection}.
*
- *
With one large grid, adding and removing array elements requires either shifting
- * the following properties into different rows (harder to do),
- * or to re-create the complete section (currently done).
- * See {@link ArraySizePropertyBinding} for details.
+ *
The elements of a structure or elements of an array could be (and had in the past been)
+ * placed in their own sub-{@link PropertyPanelSection}s.
+ * That makes it easier to add/remove array elements by just updating the affected sub-section,
+ * but is would then be much harder to get all property name and editor fields to align
+ * through subsections.
*
- * @author Kay Kasemir
- * @author Claudio Rosati
+ *
With one large grid, adding and removing array elements requires either shifting
+ * the following properties into different rows (harder to do),
+ * or to re-create the complete section (currently done).
+ * See {@link ArraySizePropertyBinding} for details.
+ *
+ * @author Kay Kasemir
+ * @author Claudio Rosati
*/
@SuppressWarnings("nls")
-public class PropertyPanelSection extends GridPane
-{
+public class PropertyPanelSection extends GridPane {
private static final Tooltip use_class_tooltip = new Tooltip(Messages.UseWidgetClass_TT);
private static final Tooltip using_class_tooltip = new Tooltip(Messages.UsingWidgetClass_TT);
@@ -118,55 +117,54 @@ public class PropertyPanelSection extends GridPane
private volatile boolean has_focus = false;
- private final List> bindings = new ArrayList<>();
+ private final List> bindings = new ArrayList<>();
private int next_row = -1;
// Instance initializer.
{
- getColumnConstraints().add(new ColumnConstraints( 6)); // column 0 is 3 pixels wide
- getColumnConstraints().add(new ColumnConstraints( 6)); // column 1 is 3 pixels wide
+ getColumnConstraints().add(new ColumnConstraints(6)); // column 0 is 3 pixels wide
+ getColumnConstraints().add(new ColumnConstraints(6)); // column 1 is 3 pixels wide
getColumnConstraints().add(new ColumnConstraints(32, USE_COMPUTED_SIZE, Integer.MAX_VALUE, Priority.ALWAYS, HPos.LEFT, true)); // column 2
- getColumnConstraints().add(new ColumnConstraints( 0, USE_COMPUTED_SIZE, Integer.MAX_VALUE)); // column 3 is 3 pixels wide
+ getColumnConstraints().add(new ColumnConstraints(0, USE_COMPUTED_SIZE, Integer.MAX_VALUE)); // column 3 is 3 pixels wide
getColumnConstraints().add(new ColumnConstraints(32, USE_COMPUTED_SIZE, Integer.MAX_VALUE, Priority.ALWAYS, HPos.LEFT, true)); // column 4
- getColumnConstraints().add(new ColumnConstraints( 6)); // column 5 is 3 pixels wide
- getColumnConstraints().add(new ColumnConstraints( 6)); // column 6 is 3 pixels wide
+ getColumnConstraints().add(new ColumnConstraints(6)); // column 5 is 3 pixels wide
+ getColumnConstraints().add(new ColumnConstraints(6)); // column 6 is 3 pixels wide
getColumnConstraints().get(2).setPercentWidth(40);
}
- /** @param class_mode Use 'class editor' mode? */
- public void setClassMode(final boolean class_mode)
- {
+ /**
+ * @param class_mode Use 'class editor' mode?
+ */
+ public void setClassMode(final boolean class_mode) {
this.class_mode = class_mode;
}
- /** @return Whether one of the property editors has focus */
- public boolean hasFocus()
- {
+ /**
+ * @return Whether one of the property editors has focus
+ */
+ public boolean hasFocus() {
return has_focus;
}
void fill(final UndoableActionManager undo,
final Collection> properties,
- final List other)
- {
+ final List other) {
// Add UI items for each property
WidgetPropertyCategory category = null;
- for (final WidgetProperty property : properties)
- {
+ for (final WidgetProperty property : properties) {
// Skip runtime properties
if (property.getCategory() == WidgetPropertyCategory.RUNTIME)
continue;
// 'class' is not used for the class definition itself,
// it's only shown for displays where classes are then applied
- if (property instanceof WidgetClassProperty && class_mode)
+ if (property instanceof WidgetClassProperty && class_mode)
continue;
// Start of new category that needs to be shown?
- if (property.getCategory() != category)
- {
+ if (property.getCategory() != category) {
category = property.getCategory();
final Label header = new Label(category.getDescription());
@@ -183,54 +181,48 @@ void fill(final UndoableActionManager undo,
}
}
- /** @return Next row in grid layout, i.e. row that is not populated */
- private int getNextGridRow()
- {
+ /**
+ * @return Next row in grid layout, i.e. row that is not populated
+ */
+ private int getNextGridRow() {
next_row++;
return next_row;
}
- /** Some 'simple' properties are handled in static method to allow use in the RulesDialog
- * @param undo Undo manager
- * @param bindings Bindings to update
- * @param property Property to edit
- * @param other Other selected widgets
- * @return Node, typically label and text field, for editing the property
+ /**
+ * Some 'simple' properties are handled in static method to allow use in the RulesDialog
+ *
+ * @param undo Undo manager
+ * @param bindings Bindings to update
+ * @param property Property to edit
+ * @param other Other selected widgets
+ * @return Node, typically label and text field, for editing the property
*/
- public static Node bindSimplePropertyField (
+ public static Node bindSimplePropertyField(
final UndoableActionManager undo,
- final List> bindings,
+ final List> bindings,
final WidgetProperty property,
- final List other)
- {
+ final List other) {
final Widget widget = property.getWidget();
Node field = null;
- if (property.isReadonly())
- {
+ if (property.isReadonly()) {
// If "Type", use a label with an icon.
- if (property.getName().equals(CommonWidgetProperties.propType.getName()))
- {
- if (widget instanceof DisplayModel)
- { // DisplayModel is not registered as a Widget that users can add
+ if (property.getName().equals(CommonWidgetProperties.propType.getName())) {
+ if (widget instanceof DisplayModel) { // DisplayModel is not registered as a Widget that users can add
String text = Messages.Display;
Label label = new Label(text, ImageCache.getImageView(ModelPlugin.class, "/icons/display.png"));
Tooltip.install(label, new Tooltip(text));
field = label;
- }
- else
- {
+ } else {
final String type = widget.getType();
- try
- {
+ try {
final ImageView icon = new ImageView(WidgetIcons.getIcon(type));
final String name = WidgetFactory.getInstance().getWidgetDescriptor(type).getName();
Label label = new Label(name, icon);
Tooltip.install(label, new Tooltip(name));
field = label;
- }
- catch (Exception ex)
- {
+ } catch (Exception ex) {
// Even 'unknown' widgets should have an icon,
// but fall back to just showing the type name
String text = String.valueOf(property.getValue());
@@ -239,18 +231,14 @@ public static Node bindSimplePropertyField (
field = label;
}
}
- }
- else
- {
+ } else {
final TextField text = new TextField();
text.setText(String.valueOf(property.getValue()));
text.setDisable(true);
Tooltip.install(text, new Tooltip(text.getText()));
field = text;
}
- }
- else if (property instanceof ColorWidgetProperty)
- {
+ } else if (property instanceof ColorWidgetProperty) {
final ColorWidgetProperty color_prop = (ColorWidgetProperty) property;
final WidgetColorPropertyField color_field = new WidgetColorPropertyField();
final WidgetColorPropertyBinding binding = new WidgetColorPropertyBinding(undo, color_field, color_prop, other);
@@ -259,12 +247,10 @@ else if (property instanceof ColorWidgetProperty)
{
if (widgetColor instanceof NamedWidgetColor) {
return new Tooltip(((NamedWidgetColor) widgetColor).getName());
- }
- else {
+ } else {
if (widgetColor.getAlpha() == 255) {
return new Tooltip("RGB(" + widgetColor.getRed() + "," + widgetColor.getGreen() + "," + widgetColor.getBlue() + ")");
- }
- else {
+ } else {
return new Tooltip("RGB(" + widgetColor.getRed() + "," + widgetColor.getGreen() + "," + widgetColor.getBlue() + "," + widgetColor.getAlpha() + ")");
}
}
@@ -276,9 +262,7 @@ else if (property instanceof ColorWidgetProperty)
bindings.add(binding);
binding.bind();
field = color_field;
- }
- else if (property instanceof FontWidgetProperty)
- {
+ } else if (property instanceof FontWidgetProperty) {
final FontWidgetProperty font_prop = (FontWidgetProperty) property;
final Button font_field = new Button();
font_field.setMnemonicParsing(false);
@@ -291,9 +275,7 @@ else if (property instanceof FontWidgetProperty)
bindings.add(binding);
binding.bind();
field = font_field;
- }
- else if (property instanceof EnumWidgetProperty)
- {
+ } else if (property instanceof EnumWidgetProperty) {
final EnumWidgetProperty enum_prop = (EnumWidgetProperty) property;
final ComboBox combo = new ComboBox<>();
combo.setPromptText(property.getDefaultValue().toString());
@@ -323,7 +305,7 @@ else if (property instanceof EnumWidgetProperty)
// while the combo was non-editable.
// With Java 8, it that can be ignored, so set it again
// now that the combo has become editable.
- if (use_macro && combo.getEditor().getText().isEmpty())
+ if (use_macro && combo.getEditor().getText().isEmpty())
binding.restore();
};
macroButton.setOnAction(macro_handler);
@@ -335,16 +317,13 @@ else if (property instanceof EnumWidgetProperty)
// In that case, forward focus to combo
field.focusedProperty().addListener((ob, o, focused) ->
{
- if (focused)
- {
+ if (focused) {
combo.requestFocus();
if (combo.isEditable())
combo.getEditor().selectAll();
}
});
- }
- else if (property instanceof BooleanWidgetProperty)
- {
+ } else if (property instanceof BooleanWidgetProperty) {
final BooleanWidgetProperty bool_prop = (BooleanWidgetProperty) property;
final ComboBox combo = new ComboBox<>();
combo.setPromptText(property.getDefaultValue().toString());
@@ -371,8 +350,7 @@ else if (property instanceof BooleanWidgetProperty)
if (bool) {
Tooltip.install(combo, tooltipWhenSetToTrue);
Tooltip.install(check, tooltipWhenSetToTrue);
- }
- else {
+ } else {
Tooltip.install(combo, tooltipWhenSetToTrue);
Tooltip.install(check, tooltipWhenSetToFalse);
}
@@ -390,20 +368,15 @@ else if (property instanceof BooleanWidgetProperty)
// For RulesDialog, see above
field.focusedProperty().addListener((ob, o, focused) ->
{
- if (focused)
- {
- if (combo.isVisible())
- {
+ if (focused) {
+ if (combo.isVisible()) {
combo.requestFocus();
combo.getEditor().selectAll();
- }
- else if (check.isVisible())
+ } else if (check.isVisible())
check.requestFocus();
}
});
- }
- else if (property instanceof ColorMapWidgetProperty)
- {
+ } else if (property instanceof ColorMapWidgetProperty) {
final ColorMapWidgetProperty colormap_prop = (ColorMapWidgetProperty) property;
final Button map_button = new Button();
map_button.setMnemonicParsing(false);
@@ -417,8 +390,7 @@ else if (property instanceof ColorMapWidgetProperty)
if (colorMap instanceof PredefinedColorMaps.Predefined) {
PredefinedColorMaps.Predefined predefinedColorMap = (PredefinedColorMaps.Predefined) colorMap;
return new Tooltip(predefinedColorMap.getDescription());
- }
- else {
+ } else {
return new Tooltip("Color Map");
}
};
@@ -427,9 +399,7 @@ else if (property instanceof ColorMapWidgetProperty)
colormap_prop.addPropertyListener((listener, old_value, new_value) -> Tooltip.install(map_button, colorMapToTooltip.apply(new_value)));
field = map_button;
- }
- else if (property instanceof WidgetClassProperty)
- {
+ } else if (property instanceof WidgetClassProperty) {
final WidgetClassProperty widget_class_prop = (WidgetClassProperty) property;
final ComboBox combo = new ComboBox<>();
combo.setPromptText(property.getDefaultValue().toString());
@@ -447,24 +417,19 @@ else if (property instanceof WidgetClassProperty)
widget_class_prop.addPropertyListener((listener, old_value, new_value) -> Tooltip.install(combo, new Tooltip(new_value)));
field = combo;
- }
- else if (property instanceof FilenameWidgetProperty)
- {
- final FilenameWidgetProperty file_prop = (FilenameWidgetProperty)property;
+ } else if (property instanceof FilenameWidgetProperty) {
+ final FilenameWidgetProperty file_prop = (FilenameWidgetProperty) property;
final TextField text = new TextField();
text.setPromptText(file_prop.getDefaultValue().toString());
text.setMaxWidth(Double.MAX_VALUE);
final Button select_file = new Button("...");
select_file.setOnAction(event ->
{
- try
- {
+ try {
final String filename = FilenameSupport.promptForRelativePath(widget, file_prop.getValue());
if (filename != null)
undo.execute(new SetMacroizedWidgetPropertyAction(file_prop, filename));
- }
- catch (Exception ex)
- {
+ } catch (Exception ex) {
logger.log(Level.WARNING, "Cannot prompt for " + file_prop, ex);
}
});
@@ -484,17 +449,13 @@ else if (property instanceof FilenameWidgetProperty)
if (focused)
text.requestFocus();
});
- }
- else if (property instanceof PVNameWidgetProperty)
- {
- final PVNameWidgetProperty pv_prop = (PVNameWidgetProperty)property;
+ } else if (property instanceof PVNameWidgetProperty) {
+ final PVNameWidgetProperty pv_prop = (PVNameWidgetProperty) property;
final TextField text = new TextField();
text.setPromptText(pv_prop.getDefaultValue().toString());
- final MacroizedWidgetPropertyBinding binding = new MacroizedWidgetPropertyBinding(undo, text, pv_prop, other)
- {
+ final MacroizedWidgetPropertyBinding binding = new MacroizedWidgetPropertyBinding(undo, text, pv_prop, other) {
@Override
- public void bind()
- {
+ public void bind() {
super.bind();
PVAutocompleteMenu.INSTANCE.attachField(text);
}
@@ -512,8 +473,7 @@ public void bind()
if (!result.isPresent())
return;
undo.execute(new SetMacroizedWidgetPropertyAction(pv_prop, result.get()));
- for (Widget w : other)
- {
+ for (Widget w : other) {
final MacroizedWidgetProperty other_prop = (MacroizedWidgetProperty) w.getProperty(pv_prop.getName());
undo.execute(new SetMacroizedWidgetPropertyAction(other_prop, result.get()));
}
@@ -532,10 +492,8 @@ public void bind()
if (focused)
text.requestFocus();
});
- }
- else if (property instanceof MacroizedWidgetProperty)
- { // MacroizedWidgetProperty needs to be checked _after_ subclasses like PVNameWidgetProperty, FilenameWidgetProperty
- final MacroizedWidgetProperty macro_prop = (MacroizedWidgetProperty)property;
+ } else if (property instanceof MacroizedWidgetProperty) { // MacroizedWidgetProperty needs to be checked _after_ subclasses like PVNameWidgetProperty, FilenameWidgetProperty
+ final MacroizedWidgetProperty macro_prop = (MacroizedWidgetProperty) property;
final TextField text = new TextField();
text.setPromptText(macro_prop.getDefaultValue().toString());
text.setOnKeyReleased((event) -> Tooltip.install(text, new Tooltip(text.getText())));
@@ -545,9 +503,8 @@ else if (property instanceof MacroizedWidgetProperty)
Tooltip.install(text, new Tooltip(text.getText()));
- if (CommonWidgetProperties.propText.getName().equals(property.getName()) ||
- CommonWidgetProperties.propTooltip.getName().equals(property.getName()))
- { // Allow editing multi-line text in dialog
+ if (CommonWidgetProperties.propText.getName().equals(property.getName()) ||
+ CommonWidgetProperties.propTooltip.getName().equals(property.getName())) { // Allow editing multi-line text in dialog
final Button open_editor = new Button("...");
Tooltip.install(open_editor, new Tooltip("Open Editor"));
open_editor.setOnAction(event ->
@@ -558,8 +515,7 @@ else if (property instanceof MacroizedWidgetProperty)
if (!result.isPresent())
return;
undo.execute(new SetMacroizedWidgetPropertyAction(macro_prop, result.get()));
- for (Widget w : other)
- {
+ for (Widget w : other) {
final MacroizedWidgetProperty other_prop = (MacroizedWidgetProperty) w.getProperty(macro_prop.getName());
undo.execute(new SetMacroizedWidgetPropertyAction(other_prop, result.get()));
}
@@ -574,12 +530,9 @@ else if (property instanceof MacroizedWidgetProperty)
if (focused)
text.requestFocus();
});
- }
- else
+ } else
field = text;
- }
- else if (property instanceof PointsWidgetProperty)
- {
+ } else if (property instanceof PointsWidgetProperty) {
final PointsWidgetProperty points_prop = (PointsWidgetProperty) property;
final Button points_field = new Button();
points_field.setMaxWidth(Double.MAX_VALUE);
@@ -595,20 +548,21 @@ else if (property instanceof PointsWidgetProperty)
return field;
}
- /** Add UI items for displaying or editing property
- * @param property Property (on primary widget)
- * @param other Zero or more additional widgets that have same type of property
- * @param structureIndex Index of the array structure (element) being added. It is meaningful
- * only for properties instance of {@link StructuredWidgetProperty}
- * @param indentationLevel Indentation level
+ /**
+ * Add UI items for displaying or editing property
+ *
+ * @param property Property (on primary widget)
+ * @param other Zero or more additional widgets that have same type of property
+ * @param structureIndex Index of the array structure (element) being added. It is meaningful
+ * only for properties instance of {@link StructuredWidgetProperty}
+ * @param indentationLevel Indentation level
*/
private void createPropertyUI(
final UndoableActionManager undo,
final WidgetProperty property,
final List other,
final int structureIndex,
- final int indentationLevel)
- {
+ final int indentationLevel) {
// Skip runtime properties
if (property.getCategory() == WidgetPropertyCategory.RUNTIME)
return;
@@ -622,12 +576,9 @@ private void createPropertyUI(
// setGridLinesVisible(true); // For debugging the layout
Node field = bindSimplePropertyField(undo, bindings, property, other);
- if (field != null)
- {
+ if (field != null) {
//do nothing
- }
- else if (property instanceof MacrosWidgetProperty)
- {
+ } else if (property instanceof MacrosWidgetProperty) {
final MacrosWidgetProperty macros_prop = (MacrosWidgetProperty) property;
final Button macros_field = new Button();
macros_field.setMnemonicParsing(false);
@@ -640,9 +591,7 @@ else if (property instanceof MacrosWidgetProperty)
macros_prop.addPropertyListener((listener, old_value, new_value) -> Tooltip.install(macros_field, new Tooltip(macros_field.getText())));
field = macros_field;
- }
- else if (property instanceof ActionsWidgetProperty)
- {
+ } else if (property instanceof ActionsWidgetProperty) {
final ActionsWidgetProperty actions_prop = (ActionsWidgetProperty) property;
final Button actions_field = new Button();
actions_field.setMnemonicParsing(false);
@@ -655,9 +604,7 @@ else if (property instanceof ActionsWidgetProperty)
actions_prop.addPropertyListener((listener, old_value, new_value) -> Tooltip.install(actions_field, new Tooltip(actions_field.getText())));
field = actions_field;
- }
- else if (property instanceof ScriptsWidgetProperty)
- {
+ } else if (property instanceof ScriptsWidgetProperty) {
final ScriptsWidgetProperty scripts_prop = (ScriptsWidgetProperty) property;
final Button scripts_field = new Button();
scripts_field.setMnemonicParsing(false);
@@ -670,9 +617,7 @@ else if (property instanceof ScriptsWidgetProperty)
scripts_prop.addPropertyListener((listener, old_value, new_value) -> Tooltip.install(scripts_field, new Tooltip(scripts_field.getText())));
field = scripts_field;
- }
- else if (property instanceof RulesWidgetProperty)
- {
+ } else if (property instanceof RulesWidgetProperty) {
final RulesWidgetProperty rules_prop = (RulesWidgetProperty) property;
final Button rules_field = new Button();
rules_field.setMaxWidth(Double.MAX_VALUE);
@@ -684,11 +629,9 @@ else if (property instanceof RulesWidgetProperty)
rules_prop.addPropertyListener((listener, old_value, new_value) -> Tooltip.install(rules_field, new Tooltip(rules_field.getText())));
field = rules_field;
- }
- else if (property instanceof StructuredWidgetProperty)
- {
+ } else if (property instanceof StructuredWidgetProperty) {
final StructuredWidgetProperty struct = (StructuredWidgetProperty) property;
- final Label header = new Label(struct.getDescription() + ( structureIndex > 0 ? " " + String.valueOf(1 + structureIndex) : ""));
+ final Label header = new Label(struct.getDescription() + (structureIndex > 0 ? " " + String.valueOf(1 + structureIndex) : ""));
header.getStyleClass().add("structure_property_name");
header.setMaxWidth(Double.MAX_VALUE);
@@ -704,11 +647,8 @@ else if (property instanceof StructuredWidgetProperty)
for (WidgetProperty elem : struct.getValue())
this.createPropertyUI(undo, elem, other, -1, indentationLevel);
return;
- }
- else if (property instanceof ArrayWidgetProperty)
- {
- @SuppressWarnings("unchecked")
- final ArrayWidgetProperty> array = (ArrayWidgetProperty>) property;
+ } else if (property instanceof ArrayWidgetProperty) {
+ @SuppressWarnings("unchecked") final ArrayWidgetProperty> array = (ArrayWidgetProperty>) property;
// UI for changing array size
final int min_value = array.getMinimumSize();
@@ -729,22 +669,19 @@ else if (property instanceof ArrayWidgetProperty)
fillHeaderIndent(indentationLevel, row);
add(label, indentationLevel, row, 4 - indentationLevel, 1);
- if (class_mode)
- { // Checkbox to select if array is included in class definition
+ if (class_mode) { // Checkbox to select if array is included in class definition
final CheckBox check = new CheckBox();
check.setPadding(new Insets(0, 5, 0, 0));
check.setTooltip(use_class_tooltip);
- final WidgetPropertyBinding binding = new UseWidgetClassBinding(undo, check, spinner, property, other);
+ final WidgetPropertyBinding binding = new UseWidgetClassBinding(undo, check, spinner, property, other);
bindings.add(binding);
binding.bind();
add(check, 3, row);
- }
- else
- { // Show if property is set by the class, not editable.
+ } else { // Show if property is set by the class, not editable.
final Label indicator = new Label();
indicator.setPadding(new Insets(0, 5, 0, 0));
indicator.setTooltip(using_class_tooltip);
- final WidgetPropertyBinding binding = new ShowWidgetClassBinding(spinner, property, indicator);
+ final WidgetPropertyBinding binding = new ShowWidgetClassBinding(spinner, property, indicator);
bindings.add(binding);
binding.bind();
add(indicator, 3, row);
@@ -759,8 +696,7 @@ else if (property instanceof ArrayWidgetProperty)
// array elements
final List> wpeList = array.getValue();
- for (int i = 0; i < wpeList.size(); i++)
- {
+ for (int i = 0; i < wpeList.size(); i++) {
final WidgetProperty elem = wpeList.get(i);
createPropertyUI(undo, elem, other, i, indentationLevel + 1);
}
@@ -772,7 +708,7 @@ else if (property instanceof ArrayWidgetProperty)
GridPane.setHgrow(endlabel, Priority.ALWAYS);
endlabel.getStyleClass().add("array_property_end");
fillIndent(indentationLevel, row);
- add(endlabel,0 + indentationLevel, row, 7 - 2 * indentationLevel, 1);
+ add(endlabel, 0 + indentationLevel, row, 7 - 2 * indentationLevel, 1);
separator = new Separator();
@@ -783,8 +719,7 @@ else if (property instanceof ArrayWidgetProperty)
}
// As new property types are added, they might need to be handled:
// else if (property instanceof SomeNewWidgetProperty) { ... }
- else
- { // Fallback for unknown property: read-only
+ else { // Fallback for unknown property: read-only
final TextField text = new TextField();
text.setText(String.valueOf(property.getValue()));
text.setEditable(false);
@@ -804,7 +739,7 @@ else if (property instanceof ArrayWidgetProperty)
// Update has_focus
final Node tmpfield;
if (field instanceof HBox)
- tmpfield = ((HBox)field).getChildren().get(0);
+ tmpfield = ((HBox) field).getChildren().get(0);
else
tmpfield = field;
@@ -821,33 +756,28 @@ else if (property instanceof ArrayWidgetProperty)
add(label, indentationLevel, row, 3 - indentationLevel, 1);
final Widget widget = property.getWidget();
- if (! (property == widget.getProperty("type") ||
- property == widget.getProperty("name")))
- {
- if (class_mode)
- { // Class definition mode:
+ if (!(property == widget.getProperty("type") ||
+ property == widget.getProperty("name"))) {
+ if (class_mode) { // Class definition mode:
// Check box for 'use_class', but only on the top level
// For nested properties inside an array or struct,
// the class behavior is controlled at the top-level
// for the complete array or struct
- if (indentationLevel == 0)
- {
+ if (indentationLevel == 0) {
final CheckBox check = new CheckBox();
check.setPadding(new Insets(0, 5, 0, 0));
check.setTooltip(use_class_tooltip);
- final WidgetPropertyBinding binding = new UseWidgetClassBinding(undo, check, field, property, other);
+ final WidgetPropertyBinding binding = new UseWidgetClassBinding(undo, check, field, property, other);
bindings.add(binding);
binding.bind();
add(check, 3, row);
}
- }
- else
- { // Display file mode:
+ } else { // Display file mode:
// Show if property is set by the class, not editable.
final Label indicator = new Label();
indicator.setPadding(new Insets(0, 5, 0, 0));
indicator.setTooltip(using_class_tooltip);
- final WidgetPropertyBinding binding = new ShowWidgetClassBinding(field, property, indicator);
+ final WidgetPropertyBinding binding = new ShowWidgetClassBinding(field, property, indicator);
bindings.add(binding);
binding.bind();
add(indicator, 3, row);
@@ -860,12 +790,9 @@ else if (property instanceof ArrayWidgetProperty)
add(separator, 0 + indentationLevel, getNextGridRow(), 7 - 2 * indentationLevel, 1);
}
- private void fillHeaderIndent(final int indentationLevel, final int row)
- {
- if (indentationLevel >= 0)
- {
- if (indentationLevel > 0)
- {
+ private void fillHeaderIndent(final int indentationLevel, final int row) {
+ if (indentationLevel >= 0) {
+ if (indentationLevel > 0) {
final Label indent = new Label();
indent.getStyleClass().add("array_property_filler");
indent.setMaxWidth(Double.MAX_VALUE);
@@ -893,10 +820,8 @@ private void fillHeaderIndent(final int indentationLevel, final int row)
}
}
- private void fillIndent(final int indentationLevel, final int row )
- {
- if (indentationLevel > 0)
- {
+ private void fillIndent(final int indentationLevel, final int row) {
+ if (indentationLevel > 0) {
Label indent = new Label();
indent.getStyleClass().add("array_property_filler");
indent.setMaxWidth(Double.MAX_VALUE);
@@ -923,11 +848,11 @@ private void fillIndent(final int indentationLevel, final int row )
}
}
- /** Clear the property UI
- * Removes all property bindings and their UI
+ /**
+ * Clear the property UI
+ *
Removes all property bindings and their UI
*/
- void clear()
- {
+ void clear() {
bindings.forEach(WidgetPropertyBinding::unbind);
bindings.clear();
getChildren().clear();
diff --git a/app/display/model/src/main/java/org/csstudio/display/builder/model/ActionControllerBase.java b/app/display/model/src/main/java/org/csstudio/display/builder/model/ActionControllerBase.java
new file mode 100644
index 0000000000..5f23629cd0
--- /dev/null
+++ b/app/display/model/src/main/java/org/csstudio/display/builder/model/ActionControllerBase.java
@@ -0,0 +1,36 @@
+/*
+ * Copyright (C) 2024 European Spallation Source ERIC.
+ */
+
+package org.csstudio.display.builder.model;
+
+import javafx.beans.property.SimpleStringProperty;
+import javafx.beans.property.StringProperty;
+import javafx.fxml.FXML;
+import javafx.scene.control.TextField;
+
+/**
+ * Utility base class taking care of common aspects of an action editor controller.
+ */
+public abstract class ActionControllerBase {
+
+ @SuppressWarnings("unused")
+ @FXML
+ private TextField description;
+
+ protected final StringProperty descriptionProperty = new SimpleStringProperty();
+
+ public ActionControllerBase(){}
+
+ public void initialize(){
+ description.textProperty().bindBidirectional(descriptionProperty);
+ }
+
+ public String getDescription(){
+ return descriptionProperty.get();
+ }
+
+ public void setDescription(String description){
+ descriptionProperty.set(description);
+ }
+}
diff --git a/app/display/model/src/main/java/org/csstudio/display/builder/model/Messages.java b/app/display/model/src/main/java/org/csstudio/display/builder/model/Messages.java
index ebc0bbb6db..645f4615c7 100644
--- a/app/display/model/src/main/java/org/csstudio/display/builder/model/Messages.java
+++ b/app/display/model/src/main/java/org/csstudio/display/builder/model/Messages.java
@@ -15,12 +15,7 @@
public class Messages
{
/** Externalized strings */
- public static String ActionExecuteCommand,
- ActionExecuteScript,
- ActionOpenDisplay,
- ActionOpenFile,
- ActionOpenWebPage,
- ActionWritePV,
+ public static String
Actions_N_Fmt,
ActiveTab,
ArrayWidget_Description,
@@ -128,10 +123,6 @@ public class Messages
TabsWidget_Description,
TabsWidget_Name,
TabsWidget_TabNameFmt,
- Target_Replace,
- Target_Standalone,
- Target_Tab,
- Target_Window,
Top,
TraceType_Bars,
TraceType_Errorbar,
diff --git a/app/display/model/src/main/java/org/csstudio/display/builder/model/Widget.java b/app/display/model/src/main/java/org/csstudio/display/builder/model/Widget.java
index d5fddc0031..371c6215e3 100644
--- a/app/display/model/src/main/java/org/csstudio/display/builder/model/Widget.java
+++ b/app/display/model/src/main/java/org/csstudio/display/builder/model/Widget.java
@@ -7,17 +7,13 @@
*******************************************************************************/
package org.csstudio.display.builder.model;
-import static org.csstudio.display.builder.model.ModelPlugin.logger;
-import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propActions;
-import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propHeight;
-import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propName;
-import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propRules;
-import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propScripts;
-import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propType;
-import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propWidgetClass;
-import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propWidth;
-import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propX;
-import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propY;
+import org.csstudio.display.builder.model.macros.MacroOrPropertyProvider;
+import org.csstudio.display.builder.model.properties.ActionInfos;
+import org.csstudio.display.builder.model.properties.ScriptInfo;
+import org.csstudio.display.builder.model.rules.RuleInfo;
+import org.csstudio.display.builder.model.widgets.EmbeddedDisplayWidget;
+import org.phoebus.framework.macros.MacroValueProvider;
+import org.phoebus.framework.macros.Macros;
import java.util.ArrayList;
import java.util.Collections;
@@ -31,56 +27,63 @@
import java.util.function.Function;
import java.util.stream.Collectors;
-import org.csstudio.display.builder.model.macros.MacroOrPropertyProvider;
-import org.csstudio.display.builder.model.properties.ActionInfos;
-import org.csstudio.display.builder.model.properties.ScriptInfo;
-import org.csstudio.display.builder.model.rules.RuleInfo;
-import org.csstudio.display.builder.model.widgets.EmbeddedDisplayWidget;
-import org.phoebus.framework.macros.MacroValueProvider;
-import org.phoebus.framework.macros.Macros;
+import static org.csstudio.display.builder.model.ModelPlugin.logger;
+import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propActions;
+import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propHeight;
+import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propName;
+import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propRules;
+import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propScripts;
+import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propType;
+import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propWidgetClass;
+import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propWidth;
+import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propX;
+import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propY;
-/** Base class for all widgets.
+/**
+ * Base class for all widgets.
*
- *
A Widget has properties, supporting read access, subscription
- * and for most properties also write access.
+ *
A Widget has properties, supporting read access, subscription
+ * and for most properties also write access.
*
- *
Properties can be accessed in a most generic way based on the
- * property name:
- *
+ * Properties can be accessed in a most generic way based on the
+ * property name:
+ *
* getPropertyValue("text")
* setPropertyValue("text", "Hello")
* getPropertyValue("x")
* setPropertyValue("x", 60)
*
*
- * While this is ideal for access from scripts,
- * Java code that deals with a specific widget can access
- * properties in the type-safe way:
- *
+ * While this is ideal for access from scripts,
+ * Java code that deals with a specific widget can access
+ * properties in the type-safe way:
+ *
* LabelWidget label;
* label.positionX().getValue();
* label.positionX().setValue(60);
*
*
- * Widgets are part of a hierarchy.
- * Their parent is either the {@link DisplayModel} or another
- * widget with a {@link ChildrenProperty}
+ *
Widgets are part of a hierarchy.
+ * Their parent is either the {@link DisplayModel} or another
+ * widget with a {@link ChildrenProperty}
*
- * @author Kay Kasemir
+ * @author Kay Kasemir
*/
@SuppressWarnings("nls")
-public class Widget
-{
- /** Initial version for all Display Builder widgets.
+public class Widget {
+ /**
+ * Initial version for all Display Builder widgets.
*
- *
Legacy used 1.0.0 for most widgets,
- * so 2.0.0 indicates an update.
- * Selected legacy widgets had incremented to a higher version,
- * which needs to be handled for each such widget.
+ *
Legacy used 1.0.0 for most widgets,
+ * so 2.0.0 indicates an update.
+ * Selected legacy widgets had incremented to a higher version,
+ * which needs to be handled for each such widget.
*/
public static final Version BASE_WIDGET_VERSION = new Version(2, 0, 0);
- /** Typical version of legacy BOY display widgets */
+ /**
+ * Typical version of legacy BOY display widgets
+ */
public static final Version TYPICAL_LEGACY_WIDGET_VERSION = new Version(1, 0, 0);
// These user data keys are reserved for internal use
@@ -97,38 +100,46 @@ public class Widget
// They all start with an underscore to indicate that they
// are meant to be private, not to be used as API.
- /** Reserved widget user data key for storing the representation.
+ /**
+ * Reserved widget user data key for storing the representation.
*
- *
The WidgetRepresentation for each {@link Widget}
- * is stored under this key.
+ *
The WidgetRepresentation for each {@link Widget}
+ * is stored under this key.
*/
public static final String USER_DATA_REPRESENTATION = "_representation";
- /** Reserved user data key for Widget that has 'children', i.e. is a parent,
- * to store the toolkit parent item
+ /**
+ * Reserved user data key for Widget that has 'children', i.e. is a parent,
+ * to store the toolkit parent item
*/
public static final String USER_DATA_TOOLKIT_PARENT = "_toolkit_parent";
- /** Reserved widget user data key for storing the runtime.
+ /**
+ * Reserved widget user data key for storing the runtime.
*
- *
The WidgetRuntime for each {@link Widget}
- * is stored under this key.
+ *
The WidgetRuntime for each {@link Widget}
+ * is stored under this key.
*/
public static final String USER_DATA_RUNTIME = "_runtime";
- /** Reserved widget user data key for storing script support.
+ /**
+ * Reserved widget user data key for storing script support.
*
- *
ScriptSupport is attached to the top-level root
- * of the widget tree, i.e. the {@link DisplayModel}
- * that is obtained by traversing up via {@link EmbeddedDisplayWidget}s
- * to the top-level model.
+ *
ScriptSupport is attached to the top-level root
+ * of the widget tree, i.e. the {@link DisplayModel}
+ * that is obtained by traversing up via {@link EmbeddedDisplayWidget}s
+ * to the top-level model.
*/
public static final String USER_DATA_SCRIPT_SUPPORT = "_script_support";
- /** Parent widget */
+ /**
+ * Parent widget
+ */
private volatile Widget parent = null;
- /** All properties, ordered by category, then sequence of definition */
+ /**
+ * All properties, ordered by category, then sequence of definition
+ */
protected final Set> properties;
// Design decision:
@@ -147,45 +158,53 @@ public class Widget
// The API for widget users would remain the same:
// getProperties(), getProperty(), getPropertyValue(), setPropertyValue()
- /** Map of property names to properties */
+ /**
+ * Map of property names to properties
+ */
// Map is final, all properties are collected in widget constructor.
// Values of properties can change, but the list of properties itself
// is thread safe
protected final Map> property_map;
// Actual properties
- private WidgetProperty type;
- private WidgetProperty name;
- private WidgetProperty widget_class;
- private WidgetProperty x;
- private WidgetProperty y;
- private WidgetProperty width;
- private WidgetProperty height;
- private WidgetProperty actions;
- private WidgetProperty> rules;
- private WidgetProperty> scripts;
-
- /** Map of user data */
+ private final WidgetProperty type;
+ private final WidgetProperty name;
+ private final WidgetProperty widget_class;
+ private final WidgetProperty x;
+ private final WidgetProperty y;
+ private final WidgetProperty width;
+ private final WidgetProperty height;
+ private final WidgetProperty actions;
+ private final WidgetProperty> rules;
+ private final WidgetProperty> scripts;
+
+ /**
+ * Map of user data
+ */
protected final Map user_data = new ConcurrentHashMap<>(4); // Reserve room for "representation", "runtime"
- /** Loaded without errors? */
+ /**
+ * Loaded without errors?
+ */
protected volatile Boolean clean;
- /** Widget constructor.
- * @param type Widget type
+ /**
+ * Widget constructor.
+ *
+ * @param type Widget type
*/
- public Widget(final String type)
- {
+ public Widget(final String type) {
this(type, 100, 20);
}
- /** Widget constructor.
- * @param type Widget type
- * @param default_width Default width
- * @param default_height .. and height
+ /**
+ * Widget constructor.
+ *
+ * @param type Widget type
+ * @param default_width Default width
+ * @param default_height .. and height
*/
- public Widget(final String type, final int default_width, final int default_height)
- {
+ public Widget(final String type, final int default_width, final int default_height) {
// Collect properties
final List> prelim_properties = new ArrayList<>();
@@ -226,90 +245,96 @@ public Widget(final String type, final int default_width, final int default_heig
Collectors.toMap(WidgetProperty::getName, Function.identity()));
}
- /** Unique runtime identifier of a widget
+ /**
+ * Unique runtime identifier of a widget
*
- * At runtime, this ID can be used to construct
- * PVs that are unique and specific to this instance
- * of a widget.
- * Even if the same display is opened multiple times
- * within the same JVM, the widget is very likely
- * to receive a new, unique identifier.
+ *
At runtime, this ID can be used to construct
+ * PVs that are unique and specific to this instance
+ * of a widget.
+ * Even if the same display is opened multiple times
+ * within the same JVM, the widget is very likely
+ * to receive a new, unique identifier.
*
- * @return Unique Runtime Identifier for widget
+ * @return Unique Runtime Identifier for widget
*/
- public final String getID()
- { // Base on ID hash code
+ public final String getID() { // Base on ID hash code
final int id = System.identityHashCode(this);
return "WD" + Integer.toHexString(id);
}
- /** Get widget version
- * @return Widget version number
+ /**
+ * Get widget version
+ *
+ * @return Widget version number
*/
- public Version getVersion()
- {
+ public Version getVersion() {
return BASE_WIDGET_VERSION;
}
- /** @return Widget Type */
- public final String getType()
- {
+ /**
+ * @return Widget Type
+ */
+ public final String getType() {
return type.getValue();
}
- /** @return Widget Name */
- public final String getName()
- {
+ /**
+ * @return Widget Name
+ */
+ public final String getName() {
return name.getValue();
}
- /** @return Widget class to use for updating properties that use the class */
- public final String getWidgetClass()
- {
+ /**
+ * @return Widget class to use for updating properties that use the class
+ */
+ public final String getWidgetClass() {
return widget_class.getValue();
}
- /** @return Parent widget in Widget tree */
- public final Optional getParent()
- {
+ /**
+ * @return Parent widget in Widget tree
+ */
+ public final Optional getParent() {
return Optional.ofNullable(parent);
}
- /** Invoked by the parent widget
- * @param parent Parent widget
+ /**
+ * Invoked by the parent widget
+ *
+ * @param parent Parent widget
*/
- protected void setParent(final Widget parent)
- {
+ protected void setParent(final Widget parent) {
if (parent == this)
throw new IllegalArgumentException();
this.parent = parent;
}
- /** Locate display model, i.e. root of widget tree
+ /**
+ * Locate display model, i.e. root of widget tree
*
- * Note that for embedded displays, this would
- * return the embedded model, not the top-level
- * model of the window.
- * Compare getTopDisplayModel()
+ *
Note that for embedded displays, this would
+ * return the embedded model, not the top-level
+ * model of the window.
+ * Compare getTopDisplayModel()
*
- * @return {@link DisplayModel} for widget
- * @throws Exception if widget is not part of a model
+ * @return {@link DisplayModel} for widget
+ * @throws Exception if widget is not part of a model
*/
- public final DisplayModel getDisplayModel() throws Exception
- {
+ public final DisplayModel getDisplayModel() throws Exception {
final DisplayModel model = checkDisplayModel();
if (model == null)
throw new Exception("Missing DisplayModel for " + this);
return model;
}
- /** Locate display model, i.e. root of widget tree
+ /**
+ * Locate display model, i.e. root of widget tree
*
- * @return {@link DisplayModel} for widget or null
- * @see #getDisplayModel() version that throws exception
+ * @return {@link DisplayModel} for widget or null
+ * @see #getDisplayModel() version that throws exception
*/
- public final DisplayModel checkDisplayModel()
- {
+ public final DisplayModel checkDisplayModel() {
Widget candidate = this;
while (candidate.getParent().isPresent())
candidate = candidate.getParent().get();
@@ -318,57 +343,55 @@ public final DisplayModel checkDisplayModel()
return null;
}
- /** Locate top display model.
+ /**
+ * Locate top display model.
*
- *
For embedded displays, getDisplayModel
- * only provides the embedded model.
- * This method traverses up via the {@link EmbeddedDisplayWidget}
- * to the top-level display model.
+ *
For embedded displays, getDisplayModel
+ * only provides the embedded model.
+ * This method traverses up via the {@link EmbeddedDisplayWidget}
+ * to the top-level display model.
*
- * @return Top-level {@link DisplayModel} for widget
- * @throws Exception if widget is not part of a model
+ * @return Top-level {@link DisplayModel} for widget
+ * @throws Exception if widget is not part of a model
*/
- public final DisplayModel getTopDisplayModel() throws Exception
- {
+ public final DisplayModel getTopDisplayModel() throws Exception {
DisplayModel model = getDisplayModel();
- while (true)
- {
- final Widget embedder = model.getUserData(DisplayModel.USER_DATA_EMBEDDING_WIDGET);
- if (embedder == null)
- return model;
- model = embedder.getTopDisplayModel();
- }
+ while (true) {
+ final Widget embedder = model.getUserData(DisplayModel.USER_DATA_EMBEDDING_WIDGET);
+ if (embedder == null)
+ return model;
+ model = embedder.getTopDisplayModel();
+ }
}
- /** Set result of widget configurator
- * @param configurator WidgetConfigurator
+ /**
+ * Set result of widget configurator
+ *
+ * @param configurator WidgetConfigurator
*/
- public final void setConfiguratorResult(final WidgetConfigurator configurator)
- {
+ public final void setConfiguratorResult(final WidgetConfigurator configurator) {
if (this.clean != null)
throw new RuntimeException("Cannot change cleanliness of Widget");
// Only set it if not clean; DisplayModel needs to update it when all the children are loaded
- if (configurator.isClean() == false)
+ if (!configurator.isClean())
this.clean = Boolean.valueOf(configurator.isClean());
}
- /** @return true if this widget was loaded without errors,
- * false if there were errors
+ /**
+ * @return true if this widget was loaded without errors,
+ * false if there were errors
*/
- public boolean isClean()
- {
+ public boolean isClean() {
Boolean safe = clean;
- if (safe != null && ! safe.booleanValue())
+ if (safe != null && !safe.booleanValue())
return false;
java.util.Optional> child_dm_prop = checkProperty(EmbeddedDisplayWidget.runtimeModel.getName());
- if (child_dm_prop.isPresent())
- {
+ if (child_dm_prop.isPresent()) {
final DisplayModel child_dm = child_dm_prop.get().getValue();
- if (child_dm != null && child_dm.isClean() == false)
- {
+ if (child_dm != null && !child_dm.isClean()) {
clean = Boolean.valueOf(false);
return false;
}
@@ -377,15 +400,15 @@ public boolean isClean()
return true;
}
- /** Called on construction to define widget's properties.
+ /**
+ * Called on construction to define widget's properties.
*
- * Mandatory properties have already been defined.
- * Derived class overrides to add its own properties.
+ *
Mandatory properties have already been defined.
+ * Derived class overrides to add its own properties.
*
- * @param properties List to which properties must be added
+ * @param properties List to which properties must be added
*/
- protected void defineProperties(final List> properties)
- {
+ protected void defineProperties(final List> properties) {
// Derived class should invoke
// super.defineProperties(properties)
// and may then add its own properties.
@@ -396,424 +419,413 @@ protected void defineProperties(final List> properties)
// but are useful in IDE when dealing with
// known widget type
- /** @return 'name' property */
- public final WidgetProperty propName()
- {
+ /**
+ * @return 'name' property
+ */
+ public final WidgetProperty propName() {
return name;
}
- /** @return 'class' property */
- public final WidgetProperty propClass()
- {
+ /**
+ * @return 'class' property
+ */
+ public final WidgetProperty propClass() {
return widget_class;
}
- /** @return 'x' property */
- public final WidgetProperty propX()
- {
+ /**
+ * @return 'x' property
+ */
+ public final WidgetProperty propX() {
return x;
}
- /** @return 'y' property */
- public final WidgetProperty propY()
- {
+ /**
+ * @return 'y' property
+ */
+ public final WidgetProperty propY() {
return y;
}
- /** @return 'width' property */
- public final WidgetProperty propWidth()
- {
+ /**
+ * @return 'width' property
+ */
+ public final WidgetProperty propWidth() {
return width;
}
- /** @return 'height' property */
- public final WidgetProperty propHeight()
- {
+ /**
+ * @return 'height' property
+ */
+ public final WidgetProperty propHeight() {
return height;
}
- /** @return 'actions' property */
- public final WidgetProperty propActions()
- {
+ public final WidgetProperty propActions() {
return actions;
}
- /** @return 'rules' property */
- public final WidgetProperty> propRules()
- {
+ /**
+ * @return 'rules' property
+ */
+ public final WidgetProperty> propRules() {
return rules;
}
- /** @return 'scripts' property */
- public final WidgetProperty> propScripts()
- {
+ /**
+ * @return 'scripts' property
+ */
+ public final WidgetProperty> propScripts() {
return scripts;
}
- /** Obtain configurator.
+ /**
+ * Obtain configurator.
*
- * While typically using the default {@link WidgetConfigurator},
- * widget may provide a different configurator for reading older
- * persisted date.
- * @param persisted_version Version of the persisted data.
- * @return Widget configurator for that version
- * @throws Exception if persisted version cannot be handled
+ *
While typically using the default {@link WidgetConfigurator},
+ * widget may provide a different configurator for reading older
+ * persisted date.
+ *
+ * @param persisted_version Version of the persisted data.
+ * @return Widget configurator for that version
+ * @throws Exception if persisted version cannot be handled
*/
public WidgetConfigurator getConfigurator(final Version persisted_version)
- throws Exception
- {
+ throws Exception {
// if (persisted_version.getMajor() < 1)
// throw new Exception("Can only handle version 1.0.0 and higher");
return new WidgetConfigurator(persisted_version);
}
- /** Get all properties of the widget.
+ /**
+ * Get all properties of the widget.
+ *
+ *
Properties are ordered by category and sequence of definition.
*
- *
Properties are ordered by category and sequence of definition.
- * @return Unmodifiable set
+ * @return Unmodifiable set
*/
- public final Set> getProperties()
- {
+ public final Set> getProperties() {
return properties;
}
- /** Helper for obtaining the complete property name 'paths'
+ /**
+ * Helper for obtaining the complete property name 'paths'
*
- * For a scalar property, this method simply returns that property name.
+ *
For a scalar property, this method simply returns that property name.
*
- *
For arrays or structures, it returns names for each array resp. structure element.
+ *
For arrays or structures, it returns names for each array resp. structure element.
*
- * @param property The widget property.
- * @return List of property names
+ * @param property The widget property.
+ * @return List of property names
*/
- public static final List expandPropertyNames(final WidgetProperty property)
- {
+ public static final List expandPropertyNames(final WidgetProperty property) {
final List names = new ArrayList<>();
doAddPropertyNames(names, property.getName(), property);
return names;
}
- private static final void doAddPropertyNames(final List names, String path, final WidgetProperty property)
- {
- if (property instanceof ArrayWidgetProperty)
- {
- final ArrayWidgetProperty array = (ArrayWidgetProperty) property;
- for (int i=0; i names, String path, final WidgetProperty property) {
+ if (property instanceof ArrayWidgetProperty array) {
+ for (int i = 0; i < array.size(); ++i)
doAddPropertyNames(names, path + "[" + i + "]", array.getElement(i));
- }
- else if (property instanceof StructuredWidgetProperty)
- {
- final StructuredWidgetProperty struct = (StructuredWidgetProperty) property;
- for (int i=0; i item = struct.getElement(i);
doAddPropertyNames(names, path + "." + item.getName(), item);
}
- }
- else
+ } else
names.add(path);
}
- /** Check if widget has a given property.
+ /**
+ * Check if widget has a given property.
*
- * This is called by code that needs to
- * test if a widget has a certain property.
+ *
This is called by code that needs to
+ * test if a widget has a certain property.
*
- *
Only checks for direct properties of
- * the widget, neither mapping legacy property names
- * nor allowing for complex property paths.
+ *
Only checks for direct properties of
+ * the widget, neither mapping legacy property names
+ * nor allowing for complex property paths.
*
- * @param name Property name
- * @param Type of the property's value.
- * @return Optional {@link WidgetProperty}
- * @see #getProperty(String)
+ * @param name Property name
+ * @param Type of the property's value.
+ * @return Optional {@link WidgetProperty}
+ * @see #getProperty(String)
*/
- public final Optional> checkProperty(final String name)
- {
- @SuppressWarnings("unchecked")
- final WidgetProperty property = (WidgetProperty) property_map.get(name);
+ public final Optional> checkProperty(final String name) {
+ @SuppressWarnings("unchecked") final WidgetProperty property = (WidgetProperty) property_map.get(name);
return Optional.ofNullable(property);
}
- /** Check if widget has a given property.
- * @param property_description Property descriptor
- * @param Type of the property's value.
- * @return Optional {@link WidgetProperty}
- * @see #checkProperty(WidgetPropertyDescriptor)
+ /**
+ * Check if widget has a given property.
+ *
+ * @param property_description Property descriptor
+ * @param Type of the property's value.
+ * @return Optional {@link WidgetProperty}
+ * @see #checkProperty(WidgetPropertyDescriptor)
*/
- public final Optional> checkProperty(final WidgetPropertyDescriptor property_description)
- {
+ public final Optional> checkProperty(final WidgetPropertyDescriptor property_description) {
return checkProperty(property_description.getName());
}
- /** Get widget property.
+ /**
+ * Get widget property.
*
- * Property access based on property description allows
- * type-safe access.
+ *
Property access based on property description allows
+ * type-safe access.
*
- * @param property_description Property description
- * @param Type of the property's value.
- * @return {@link WidgetProperty}
- * @throws IllegalArgumentException if property is unknown
- * @see #checkProperty(WidgetPropertyDescriptor)
+ * @param property_description Property description
+ * @param Type of the property's value.
+ * @return {@link WidgetProperty}
+ * @throws IllegalArgumentException if property is unknown
+ * @see #checkProperty(WidgetPropertyDescriptor)
*/
@SuppressWarnings("unchecked")
- public final WidgetProperty getProperty(final WidgetPropertyDescriptor property_description)
- {
+ public final WidgetProperty getProperty(final WidgetPropertyDescriptor property_description) {
final WidgetProperty property = getProperty(property_description.getName());
- return (WidgetProperty)property;
+ return (WidgetProperty) property;
}
- /** Get widget property.
+ /**
+ * Get widget property.
*
- * Meant for rules, scripts and similar code
- * which does not know the exact widget type
- * and thus fetches properties by name.
+ *
Meant for rules, scripts and similar code
+ * which does not know the exact widget type
+ * and thus fetches properties by name.
*
- *
Supports access to complex properties by path name,
- * for example "y_axes[1].minimum" to get the minimum
- * property of the second Y axis of a plot.
+ *
Supports access to complex properties by path name,
+ * for example "y_axes[1].minimum" to get the minimum
+ * property of the second Y axis of a plot.
*
- *
To allow use of legacy scripts and rules,
- * the widget implementation may override to
- * handle deprecated property names.
+ *
To allow use of legacy scripts and rules,
+ * the widget implementation may override to
+ * handle deprecated property names.
*
- *
Caller presumes that the widget actually
- * has the requested property, otherwise throwing Exception.
+ *
Caller presumes that the widget actually
+ * has the requested property, otherwise throwing Exception.
*
- * @param name Property name
- * @return {@link WidgetProperty}
- * @throws IllegalArgumentException if property is unknown
- * @see #checkProperty(String)
- * @throws IllegalArgumentException if path includes invalid elements,
- * IndexOutOfBoundsException for access to array beyond size
+ * @param name Property name
+ * @return {@link WidgetProperty}
+ * @throws IllegalArgumentException if property is unknown
+ * @throws IllegalArgumentException if path includes invalid elements,
+ * IndexOutOfBoundsException for access to array beyond size
+ * @see #checkProperty(String)
*/
- public WidgetProperty getProperty(final String name) throws IllegalArgumentException, IndexOutOfBoundsException
- { // Is name a path "struct_prop.array_prop[2].element" ?
- if (name.indexOf('.') >=0 || name.indexOf('[') >= 0)
+ public WidgetProperty getProperty(final String name) throws IllegalArgumentException, IndexOutOfBoundsException { // Is name a path "struct_prop.array_prop[2].element" ?
+ if (name.indexOf('.') >= 0 || name.indexOf('[') >= 0)
return getPropertyByPath(name, false);
// Plain property name
final WidgetProperty property = property_map.get(name);
if (property == null)
- throw new IllegalArgumentException(toString() + " has no '" + name + "' property");
+ throw new IllegalArgumentException(this + " has no '" + name + "' property");
return property;
}
- /** Get property via path
- * @param path_name "struct_prop.array_prop[2].element"
- * @param create_elements Create missing array elements?
- * @return Property for "element"
- * @throws IllegalArgumentException if path includes invalid elements,
- * IndexOutOfBoundsException for access to array beyond size
+ /**
+ * Get property via path
+ *
+ * @param path_name "struct_prop.array_prop[2].element"
+ * @param create_elements Create missing array elements?
+ * @return Property for "element"
+ * @throws IllegalArgumentException if path includes invalid elements,
+ * IndexOutOfBoundsException for access to array beyond size
*/
@SuppressWarnings("rawtypes")
- public WidgetProperty getPropertyByPath(final String path_name, final boolean create_elements) throws IllegalArgumentException, IndexOutOfBoundsException
- {
+ public WidgetProperty getPropertyByPath(final String path_name, final boolean create_elements) throws IllegalArgumentException, IndexOutOfBoundsException {
final String[] path = path_name.split("\\.");
WidgetProperty property = null;
- for (String item : path)
- { // Does item refer to array element?
+ for (String item : path) { // Does item refer to array element?
final String name;
final int index;
final int braces = item.indexOf('[');
- if (braces >= 0)
- {
- if (! item.endsWith("]"))
+ if (braces >= 0) {
+ if (!item.endsWith("]"))
throw new IllegalArgumentException("Missing ']' for end of array element");
name = item.substring(0, braces);
- index = Integer.parseInt(item.substring(braces+1, item.length() - 1));
- }
- else
- {
+ index = Integer.parseInt(item.substring(braces + 1, item.length() - 1));
+ } else {
name = item;
index = -1;
}
// Get property for the 'name'.
// For first item, from widget. Later descent into structure.
- if (property == null)
- {
+ if (property == null) {
property = property_map.get(name);
if (property == null)
throw new IllegalArgumentException("Cannot locate '" + name + "' for '" + path_name + "'");
- }
- else if (property instanceof StructuredWidgetProperty)
- property = ((StructuredWidgetProperty)property).getElement(name);
+ } else if (property instanceof StructuredWidgetProperty)
+ property = ((StructuredWidgetProperty) property).getElement(name);
else
throw new IllegalArgumentException("Cannot locate '" + name + "' for '" + path_name + "'");
// Fetch individual array element?
if (index >= 0)
- if (property instanceof ArrayWidgetProperty)
- {
- final ArrayWidgetProperty array = (ArrayWidgetProperty)property;
+ if (property instanceof ArrayWidgetProperty array) {
// Add array elements?
- if (create_elements)
- {
+ if (create_elements) {
while (array.size() <= index)
array.addElement();
- }
- else
- if (array.size() < index)
- throw new IndexOutOfBoundsException("'" + name + "' of '" + path_name +
- "' has only " + array.size() + " elements");
+ } else if (array.size() < index)
+ throw new IndexOutOfBoundsException("'" + name + "' of '" + path_name +
+ "' has only " + array.size() + " elements");
property = array.getElement(index);
- }
- else
+ } else
throw new IllegalArgumentException("'" + name + "' of '" + path_name + "' it not an array");
}
return property;
}
- /** Get widget property value.
+ /**
+ * Get widget property value.
*
- *
Property access based on property description allows
- * type-safe access.
+ *
Property access based on property description allows
+ * type-safe access.
*
- * @param property_description Property description
- * @param Type of the property's value.
- * @return Value of the property
- * @throws IllegalArgumentException if property is unknown
+ * @param property_description Property description
+ * @param Type of the property's value.
+ * @return Value of the property
+ * @throws IllegalArgumentException if property is unknown
*/
- public final PT getPropertyValue(final WidgetPropertyDescriptor property_description)
- {
+ public final PT getPropertyValue(final WidgetPropertyDescriptor property_description) {
return getProperty(property_description).getValue();
}
- /** Get widget property value.
+ /**
+ * Get widget property value.
*
- * Property access based on property name returns generic
- * WidgetProperty without known type.
- * Data is cast to the receiver type, but that cast may fail
- * if actual data type differs.
- *
- * @param name Property name, may also be path like "struct_prop.array_prop[2].element"
- * @param Data is cast to the receiver's type
- * @return Value of the property
- * @throws IllegalArgumentException if property is unknown
- * @throws IndexOutOfBoundsException for array access beyond last element
+ * Property access based on property name returns generic
+ * WidgetProperty without known type.
+ * Data is cast to the receiver type, but that cast may fail
+ * if actual data type differs.
*
+ * @param name Property name, may also be path like "struct_prop.array_prop[2].element"
+ * @param Data is cast to the receiver's type
+ * @return Value of the property
+ * @throws IllegalArgumentException if property is unknown
+ * @throws IndexOutOfBoundsException for array access beyond last element
*/
@SuppressWarnings("unchecked")
- public final TYPE getPropertyValue(final String name)
- {
+ public final TYPE getPropertyValue(final String name) {
return (TYPE) getProperty(name).getValue();
}
- /** Set widget property value.
+ /**
+ * Set widget property value.
*
- * Property access based on property description allows
- * type-safe access.
+ *
Property access based on property description allows
+ * type-safe access.
*
- * @param property_description Property description
- * @param Type of the property's value.
- * @param value New value of the property
- * @throws IllegalArgumentException if property is unknown
+ * @param property_description Property description
+ * @param Type of the property's value.
+ * @param value New value of the property
+ * @throws IllegalArgumentException if property is unknown
*/
public final void setPropertyValue(final WidgetPropertyDescriptor property_description,
- final PT value)
- {
+ final PT value) {
getProperty(property_description).setValue(value);
}
- /** Set widget property value.
+ /**
+ * Set widget property value.
*
- * Property access based on property name returns generic
- * WidgetProperty without known type.
+ *
Property access based on property name returns generic
+ * WidgetProperty without known type.
*
- * @param name Property name
- * @param value New value of the property
- * @throws IllegalArgumentException if property is unknown
- * @throws Exception if value is unsuitable for this property
+ * @param name Property name
+ * @param value New value of the property
+ * @throws IllegalArgumentException if property is unknown
+ * @throws Exception if value is unsuitable for this property
*/
public final void setPropertyValue(final String name,
- final Object value) throws Exception
- {
+ final Object value) throws Exception {
getProperty(name).setValueFromObject(value);
}
- /** Expand macros for this widget and potential child widgets
- * @param input Input that should be used to expand macros
+ /**
+ * Expand macros for this widget and potential child widgets
+ *
+ * @param input Input that should be used to expand macros
*/
- public void expandMacros(final Macros input)
- {
+ public void expandMacros(final Macros input) {
// Plain widget has no macros to expand
}
- /** Determine effective macros.
+ /**
+ * Determine effective macros.
*
- *
Default implementation requests macros
- * from parent.
+ *
Default implementation requests macros
+ * from parent.
*
- *
Macros will be null while
- * the widget is loaded until it is included in a model.
+ *
Macros will be null while
+ * the widget is loaded until it is included in a model.
*
- * @return {@link Macros}
+ * @return {@link Macros}
*/
- public Macros getEffectiveMacros()
- {
+ public Macros getEffectiveMacros() {
final Optional the_parent = getParent();
- if (! the_parent.isPresent())
+ if (!the_parent.isPresent())
return null;
return the_parent.get().getEffectiveMacros();
}
- /** @return Macro provider for effective macros, falling back to properties */
- public MacroValueProvider getMacrosOrProperties()
- {
+ /**
+ * @return Macro provider for effective macros, falling back to properties
+ */
+ public MacroValueProvider getMacrosOrProperties() {
return new MacroOrPropertyProvider(this);
}
- /** Set user data
+ /**
+ * Set user data
*
- * User code can attach arbitrary data to a widget.
- * This data is _not_ persisted with the model,
- * and there is no change notification.
+ *
User code can attach arbitrary data to a widget.
+ * This data is _not_ persisted with the model,
+ * and there is no change notification.
*
- *
User code should avoid using reserved keys
- * which start with an underscore "_...".
+ *
User code should avoid using reserved keys
+ * which start with an underscore "_...".
*
- * @param key Key
- * @param data Data
+ * @param key Key
+ * @param data Data
*/
- public final void setUserData(final String key, final Object data)
- {
+ public final void setUserData(final String key, final Object data) {
user_data.put(key, data);
}
- /** @param key Key
- * @param Data is cast to the receiver's type
- * @return User data associated with key, or null
- * @see #setUserData(String, Object)
+ /**
+ * @param key Key
+ * @param Data is cast to the receiver's type
+ * @return User data associated with key, or null
+ * @see #setUserData(String, Object)
*/
@SuppressWarnings("unchecked")
- public final TYPE getUserData(final String key)
- {
- if (key == null)
- { // Debug gimmick:
+ public final TYPE getUserData(final String key) {
+ if (key == null) { // Debug gimmick:
// null is not supported as valid key,
// but triggers dump of all user properties
logger.info(this + " user data: " + user_data.entrySet());
return null;
}
final Object data = user_data.get(key);
- return (TYPE)data;
+ return (TYPE) data;
}
- /** Remove a user data entry
- * @param key Key for which to remove user data
- * @param User data is cast to the receiver's type
- * @return User data associated with key that has been removed, or null
+ /**
+ * Remove a user data entry
+ *
+ * @param key Key for which to remove user data
+ * @param User data is cast to the receiver's type
+ * @return User data associated with key that has been removed, or null
*/
@SuppressWarnings("unchecked")
- public final TYPE clearUserData(final String key)
- {
- return (TYPE)user_data.remove(key);
+ public final TYPE clearUserData(final String key) {
+ return (TYPE) user_data.remove(key);
}
@Override
- public String toString()
- {
+ public String toString() {
// Show name's specification, not value, because otherwise
// a plain debug printout can trigger macro resolution for the name
- return "Widget '" + ((MacroizedWidgetProperty)name).getSpecification() + "' (" + getType() + ")";
+ return "Widget '" + ((MacroizedWidgetProperty) name).getSpecification() + "' (" + getType() + ")";
}
}
diff --git a/app/display/model/src/main/java/org/csstudio/display/builder/model/properties/ActionInfo.java b/app/display/model/src/main/java/org/csstudio/display/builder/model/properties/ActionInfo.java
deleted file mode 100644
index 394011b143..0000000000
--- a/app/display/model/src/main/java/org/csstudio/display/builder/model/properties/ActionInfo.java
+++ /dev/null
@@ -1,107 +0,0 @@
-/*******************************************************************************
- * Copyright (c) 2015-2016 Oak Ridge National Laboratory.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
- *******************************************************************************/
-package org.csstudio.display.builder.model.properties;
-
-import java.net.URL;
-import java.util.Collections;
-import java.util.Objects;
-
-import org.csstudio.display.builder.model.Messages;
-import org.csstudio.display.builder.model.properties.OpenDisplayActionInfo.Target;
-import org.phoebus.framework.macros.Macros;
-
-/** Information about an action
- *
- * @author Kay Kasemir
- */
-@SuppressWarnings("nls")
-public abstract class ActionInfo
-{
- /** Description of a type of action: Name, icon */
- public enum ActionType
- {
- /** Open a display */
- OPEN_DISPLAY(Messages.ActionOpenDisplay, "/icons/open_display.png"),
- /** Write fixed value to a PV */
- WRITE_PV(Messages.ActionWritePV, "/icons/write_pv.png"),
- /** Execute a script */
- EXECUTE_SCRIPT(Messages.ActionExecuteScript, "/icons/execute_script.png"),
- /** Execute external command */
- EXECUTE_COMMAND(Messages.ActionExecuteCommand, "/icons/execute_script.png"),
- /** Open a file with its associated tool */
- OPEN_FILE(Messages.ActionOpenFile, "/icons/open_file.png"),
- /** Open a wen page in system browser */
- OPEN_WEBPAGE(Messages.ActionOpenWebPage, "/icons/web_browser.png");
-
- private final String name, icon_path;
-
- private ActionType(final String name, final String icon_path)
- {
- this.name = name;
- this.icon_path = icon_path;
- }
-
- /** @return URL of icon */
- public URL getIconURL()
- {
- return ActionInfo.class.getResource(icon_path);
- }
-
- @Override
- public String toString()
- {
- return name;
- }
- };
-
- /** Create action with generic values
- * @param type Action type
- * @return Action of that type
- */
- public static ActionInfo createAction(final ActionType type)
- {
- switch (type)
- {
- case OPEN_DISPLAY:
- return new OpenDisplayActionInfo(type.toString(), "", new Macros(), Target.REPLACE);
- case WRITE_PV:
- return new WritePVActionInfo(type.toString(), "$(pv_name)", "0");
- case EXECUTE_SCRIPT:
- return new ExecuteScriptActionInfo(type.toString(),
- new ScriptInfo(ScriptInfo.EMBEDDED_PYTHON,
- ScriptInfo.EXAMPLE_PYTHON,
- false,
- Collections.emptyList()));
- case EXECUTE_COMMAND:
- return new ExecuteCommandActionInfo(type.toString(), "some_command");
- case OPEN_FILE:
- return new OpenFileActionInfo(type.toString(), "");
- case OPEN_WEBPAGE:
- return new OpenWebpageActionInfo(type.toString(), "");
- default:
- throw new IllegalStateException("Unknown type " + type);
- }
- }
-
- private final String description;
-
- /** @param description Action description */
- public ActionInfo(final String description)
- {
- this.description = Objects.requireNonNull(description);
- }
-
- /** @return Type info */
- abstract public ActionType getType();
-
- /** @return Action description */
- public String getDescription()
- {
- return description;
- }
-}
diff --git a/app/display/model/src/main/java/org/csstudio/display/builder/model/properties/ActionInfoBase.java b/app/display/model/src/main/java/org/csstudio/display/builder/model/properties/ActionInfoBase.java
new file mode 100644
index 0000000000..9f45916249
--- /dev/null
+++ b/app/display/model/src/main/java/org/csstudio/display/builder/model/properties/ActionInfoBase.java
@@ -0,0 +1,106 @@
+/*
+ * Copyright (C) 2024 European Spallation Source ERIC.
+ */
+
+package org.csstudio.display.builder.model.properties;
+
+import javafx.scene.Node;
+import javafx.scene.control.MenuItem;
+import javafx.scene.image.ImageView;
+import org.csstudio.display.builder.model.Widget;
+import org.csstudio.display.builder.model.WidgetProperty;
+import org.csstudio.display.builder.model.macros.MacroHandler;
+import org.csstudio.display.builder.model.persist.XMLTags;
+import org.csstudio.display.builder.model.spi.ActionInfo;
+
+import javax.xml.stream.XMLStreamWriter;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+/**
+ * Utility base class taking care of common aspects of an {@link ActionInfo} implementation.
+ */
+public abstract class ActionInfoBase implements ActionInfo {
+
+ protected String description;
+ protected String type;
+ protected Node editorUi;
+
+ private static final Logger logger = Logger.getLogger(ActionInfoBase.class.getName());
+
+ @Override
+ public void setDescription(String description) {
+ this.description = description;
+ }
+
+ @Override
+ public String getDescription() {
+ return description;
+ }
+
+ @Override
+ public String getType() {
+ return type;
+ }
+
+
+ protected MenuItem createMenuItem(final Widget widget, final String description) {
+ // Expand macros in action description
+ String desc;
+ try {
+ desc = MacroHandler.replace(widget.getEffectiveMacros(), description);
+ } catch (Exception ex) {
+ logger.log(Level.WARNING, "Cannot expand macros in action description '" + description + "'", ex);
+ desc = description;
+ }
+
+ final ImageView icon = new ImageView(getImage());
+ final MenuItem item = new MenuItem(desc, icon);
+
+ final Optional> enabled_prop = widget.checkProperty(CommonWidgetProperties.propEnabled);
+ if (enabled_prop.isPresent() && !enabled_prop.get().getValue()) {
+ item.setDisable(true);
+ return item;
+ }
+
+ return item;
+ }
+
+
+
+ @Override
+ public String toString() {
+ return description;
+ }
+
+ /**
+ * Writes the description tag if non-empty, as it is common for all {@link ActionInfo}s.
+ *
+ * @param writer A {@link XMLStreamWriter}
+ * @throws Exception upon failure...
+ */
+ protected void writeDescriptionToXML(final XMLStreamWriter writer, String description) throws Exception {
+ if (!description.isEmpty()) {
+ writer.writeStartElement(XMLTags.DESCRIPTION);
+ writer.writeCharacters(description);
+ writer.writeEndElement();
+ }
+ }
+
+ /**
+ * Adds a single menu item corresponding to the action's description. If the {@link ActionInfo} implementation
+ * needs additional items, it should override this method.
+ * @param widget Widget associated with the context menu.
+ * @return A list of {@link MenuItem}s.
+ */
+ @Override
+ public List