Merge pull request #3277 from ControlSystemStudio/embedded_display_rollback

Revert EmbeddedDisplayRepresentation due to side effects

Author: georgweiss

app/display/representation-javafx/src/main/java/org/csstudio/display/builder/representation/javafx/widgets/EmbeddedDisplayRepresentation.java

@@ -29,7 +29,6 @@
 
 import javafx.geometry.Insets;
 import javafx.scene.Parent;
-import javafx.scene.Group;
 import javafx.scene.control.ScrollPane;
 import javafx.scene.control.ScrollPane.ScrollBarPolicy;
 import javafx.scene.layout.Background;
@@ -61,23 +60,23 @@ public class EmbeddedDisplayRepresentation extends RegionBaseRepresentation<Pane
     private static final Background TRANSPARENT_BACKGROUND = new Background(new BackgroundFill(Color.TRANSPARENT, CornerRadii.EMPTY, Insets.EMPTY));
     private static final Background EDIT_TRANSPARENT_BACKGROUND = new Background(new BackgroundFill(
             new LinearGradient(
-                0, 0, 10, 10, false, CycleMethod.REPEAT,
-                new Stop(0.0, new Color(0.53, 0.52, 0.51, 0.15)),
-                new Stop(0.5, new Color(0.53, 0.52, 0.51, 0.15)),
-                new Stop(0.5, Color.TRANSPARENT),
-                new Stop(1.0, Color.TRANSPARENT)
+                    0, 0, 10, 10, false, CycleMethod.REPEAT,
+                    new Stop(0.0, new Color(0.53, 0.52, 0.51, 0.15)),
+                    new Stop(0.5, new Color(0.53, 0.52, 0.51, 0.15)),
+                    new Stop(0.5, Color.TRANSPARENT),
+                    new Stop(1.0, Color.TRANSPARENT)
             ), CornerRadii.EMPTY, Insets.EMPTY
-        ));
+    ));
 
     private static final Background EDIT_OVERDRAWN_BACKGROUND = new Background(new BackgroundFill(
             new LinearGradient(
-                10, 0, 0, 10, false, CycleMethod.REPEAT,
-                new Stop(0.0, Color.TRANSPARENT),
-                new Stop(0.5, Color.TRANSPARENT),
-                new Stop(0.5, new Color(0.93, 0.1, 0.1, 0.45)),
-                new Stop(1.0, new Color(0.93, 0.1, 0.1, 0.45))
+                    10, 0, 0, 10, false, CycleMethod.REPEAT,
+                    new Stop(0.0, Color.TRANSPARENT),
+                    new Stop(0.5, Color.TRANSPARENT),
+                    new Stop(0.5, new Color(0.93, 0.1, 0.1, 0.45)),
+                    new Stop(1.0, new Color(0.93, 0.1, 0.1, 0.45))
             ), CornerRadii.EMPTY, Insets.EMPTY
-        ));
+    ));
 
     private final DirtyFlag dirty_sizes = new DirtyFlag();
     private final DirtyFlag dirty_background = new DirtyFlag();
@@ -90,16 +89,12 @@ public class EmbeddedDisplayRepresentation extends RegionBaseRepresentation<Pane
     private volatile double zoom_factor_y = 1.0;
 
 
-    /** Inner pane & group that holds child widgets
-     *  We need the group, since the Pane does NOT account for child widget transforms
-     *  when computing prefWidth / prefHeight, making embedded displays larger than
-     *  they actually are, when containing a tall (interpreted as wide) rotated child widget.
+    /** Inner pane that holds child widgets
      *
      *  <p>Set to null when representation is disposed,
      *  which is used as indicator to pending display updates.
      */
     private volatile Pane inner;
-    private volatile Group inner_parent;
     private volatile Background inner_background = Background.EMPTY;
 
     /** Zoom for 'inner' pane */
@@ -108,7 +103,7 @@ public class EmbeddedDisplayRepresentation extends RegionBaseRepresentation<Pane
     /** Optional scroll pane between 'jfx_node' Pane and 'inner'.
      *
      *  To allow scrolling, the scene graph is
-     *      jfx_node -> scroll -> inner -> inner_parent.
+     *      jfx_node -> scroll -> inner.
      *
      *  If no scrolling is desired, the scrollbars can be hidden via
      *  scroll.setHbarPolicy(ScrollBarPolicy.NEVER),
@@ -118,7 +113,7 @@ public class EmbeddedDisplayRepresentation extends RegionBaseRepresentation<Pane
      *
      *  The easiest way to remove the scroll bars and any of its impact on
      *  event handling is to simply remove the scrollpane from the scene graph:
-     *      jfx_node-> inner -> inner_parent.
+     *      jfx_node-> inner.
      */
     private ScrollPane scroll;
 
@@ -142,20 +137,12 @@ protected boolean isFilteringEditModeClicks()
     @Override
     public Pane createJFXNode() throws Exception
     {
-        // rotated child widgets break the prefWidth / prefHeight of a Pane as its own prefWidth / prefHeight uses
-        // the non-transformed dimensions of its children. So the child widget parent must be a Group instead
-        // See https://forums.oracle.com/ords/apexds/post/java-fx-strange-behaviour-when-trying-to-write-a-label-vert-3164
-        // This is easily reproducible, by creating an embedded display with sufficient width and height,
-        // and placing a very tall rotated label inside of it. The resulting embedded display will get a horizontal
-        // scrollbar, as the pane containing it would be wider than it is shown to be.
-        inner_parent = new Group();
-
         // inner.setScaleX() and setScaleY() zoom from the center
         // and not the top-left edge, requiring adjustments to
         // inner.setTranslateX() and ..Y() to compensate.
         // Using a separate Scale transformation does not have that problem.
         // See http://stackoverflow.com/questions/10707880/javafx-scale-and-translate-operation-results-in-anomaly
-        inner = new Pane(inner_parent);
+        inner = new Pane();
         inner.getTransforms().add(zoom = new Scale());
 
         scroll = new NonCachingScrollPane(inner);
@@ -178,7 +165,7 @@ public Pane createJFXNode() throws Exception
     @Override
     protected Parent getChildParent(final Parent parent)
     {
-        return inner_parent;
+        return inner;
     }
 
     @Override
@@ -256,7 +243,7 @@ else if (resize == Resize.StretchContent)
     private void fileChanged(final WidgetProperty<?> property, final Object old_value, final Object new_value)
     {
         final DisplayAndGroup file_and_group =
-            new DisplayAndGroup(model_widget.propFile().getValue(), model_widget.propGroupName().getValue());
+                new DisplayAndGroup(model_widget.propFile().getValue(), model_widget.propGroupName().getValue());
 
         // System.out.println("Requested: " + file_and_group);
         final DisplayAndGroup skipped = pending_display_and_group.getAndSet(file_and_group);
@@ -356,7 +343,7 @@ private void representContent(final DisplayModel content_model)
             zoom.setX(zoom_factor_x);
             zoom.setY(zoom_factor_y);
 
-            toolkit.representModel(inner_parent, content_model);
+            toolkit.representModel(inner, content_model);
             backgroundChanged(null, null, null);
         }
         catch (final Exception ex)
@@ -439,7 +426,7 @@ public void updateChanges()
             else
             {   // Don't use a scroll pane
                 scroll.setContent(null);
-                jfx_node.getChildren().setAll(inner_parent);
+                jfx_node.getChildren().setAll(inner);
 
                 // During runtime or if the resize property is set to Crop we clip inner
                 // but allow 'overdrawing' in edit mode so the out-of-region widgets are visible to the user
@@ -463,7 +450,7 @@ else if (inner.getHeight() != 0.0 && inner.getWidth() != 0.0)
                             rect.setManaged(false);
                             rect.resizeRelocate(0, scaled_height, inner.getWidth(), inner.getHeight() - scaled_height);
                             rect.setBackground(EDIT_OVERDRAWN_BACKGROUND);
-                            inner_parent.getChildren().addAll(rect);
+                            inner.getChildren().addAll(rect);
                         }
 
                         // Check if wider than allowed
@@ -473,7 +460,7 @@ else if (inner.getHeight() != 0.0 && inner.getWidth() != 0.0)
                             rect.setManaged(false);
                             rect.resizeRelocate(scaled_width, 0, inner.getWidth() - scaled_width, inner.getHeight());
                             rect.setBackground(EDIT_OVERDRAWN_BACKGROUND);
-                            inner_parent.getChildren().addAll(rect);
+                            inner.getChildren().addAll(rect);
                         }
                     }
                 }