JBR-10014 Wayland: popup positioning to work with 'screen' coordinates

Author: mkartashev

src/java.desktop/share/classes/javax/swing/JPopupMenu.java

@@ -336,9 +336,7 @@ public JMenuItem add(Action a) {
     Point adjustPopupLocationToFitScreen(int xPosition, int yPosition) {
         Point popupLocation = new Point(xPosition, yPosition);
 
-        if(popupPositionFixDisabled
-                || GraphicsEnvironment.isHeadless()
-                || PopupFactory.isPopupPositionedRelatively()) {
+        if(popupPositionFixDisabled || GraphicsEnvironment.isHeadless()) {
             return popupLocation;
         }
 
@@ -992,7 +990,7 @@ public void show(Component invoker, int x, int y) {
             }
         }
         Point invokerOrigin;
-        if (invoker != null && !PopupFactory.isPopupPositionedRelatively()) {
+        if (invoker != null) {
             invokerOrigin = invoker.getLocationOnScreen();
 
             // To avoid integer overflow

src/java.desktop/share/classes/javax/swing/ToolTipManager.java

@@ -262,57 +262,49 @@ void showTipWindow() {
             Point location;
             Rectangle sBounds = null;
 
-            boolean isTooltipPositionedAbsolutely = !isTooltipPositionedRelatively();
-            if (isTooltipPositionedAbsolutely) {
-                Point toFind;
-                if (preferredLocation != null) {
-                    toFind = new Point(screenLocation.x + preferredLocation.x,
-                            screenLocation.y + preferredLocation.y);
+            Point toFind;
+            if (preferredLocation != null) {
+                toFind = new Point(screenLocation.x + preferredLocation.x,
+                        screenLocation.y + preferredLocation.y);
+            } else {
+                if (mouseEvent != null) {
+                    toFind = mouseEvent.getLocationOnScreen();
                 } else {
-                    if (mouseEvent != null) {
-                        toFind = mouseEvent.getLocationOnScreen();
-                    } else {
-                        toFind = screenLocation;
-                    }
+                    toFind = screenLocation;
                 }
+            }
 
-                GraphicsConfiguration gc = getDrawingGC(toFind);
+            GraphicsConfiguration gc = getDrawingGC(toFind);
+            if (gc == null) {
+                if (mouseEvent != null) {
+                    toFind = mouseEvent.getLocationOnScreen();
+                    gc = getDrawingGC(toFind);
+                }
                 if (gc == null) {
-                    if (mouseEvent != null) {
-                        toFind = mouseEvent.getLocationOnScreen();
-                        gc = getDrawingGC(toFind);
-                    }
-                    if (gc == null) {
-                        gc = insideComponent.getGraphicsConfiguration();
-                    }
+                    gc = insideComponent.getGraphicsConfiguration();
                 }
+            }
 
-                sBounds = gc.getBounds();
-                Insets screenInsets = Toolkit.getDefaultToolkit()
-                        .getScreenInsets(gc);
-                // Take into account screen insets, decrease viewport
-                sBounds.x += screenInsets.left;
-                sBounds.y += screenInsets.top;
-                sBounds.width -= (screenInsets.left + screenInsets.right);
-                sBounds.height -= (screenInsets.top + screenInsets.bottom);
-
-                if (preferredLocation != null) {
-                    location = toFind;
-                } else {
-                    if (mouseEvent != null) {
-                        location = new Point(screenLocation.x + mouseEvent.getX(),
-                                screenLocation.y + mouseEvent.getY() + 20);
-                    } else {
-                        location = screenLocation;
-                    }
-                }
+            sBounds = gc.getBounds();
+            Insets screenInsets = Toolkit.getDefaultToolkit()
+                    .getScreenInsets(gc);
+            // Take into account screen insets, decrease viewport
+            sBounds.x += screenInsets.left;
+            sBounds.y += screenInsets.top;
+            sBounds.width -= (screenInsets.left + screenInsets.right);
+            sBounds.height -= (screenInsets.top + screenInsets.bottom);
+
+            if (preferredLocation != null) {
+                location = toFind;
             } else {
                 if (mouseEvent != null) {
-                    location = new Point(mouseEvent.getX(), mouseEvent.getY() + 20);
+                    location = new Point(screenLocation.x + mouseEvent.getX(),
+                            screenLocation.y + mouseEvent.getY() + 20);
                 } else {
                     location = screenLocation;
                 }
             }
+
             boolean leftToRight
                     = SwingUtilities.isLeftToRight(insideComponent);
             // Just to be paranoid
@@ -335,18 +327,16 @@ void showTipWindow() {
             popupRect.setBounds(location.x, location.y,
                     size.width, size.height);
 
-            if (isTooltipPositionedAbsolutely) {
-                // Fit as much of the tooltip on screen as possible
-                if (location.x < sBounds.x) {
-                    location.x = sBounds.x;
-                } else if (location.x - sBounds.x + size.width > sBounds.width) {
-                    location.x = sBounds.x + Math.max(0, sBounds.width - size.width);
-                }
-                if (location.y < sBounds.y) {
-                    location.y = sBounds.y;
-                } else if (location.y - sBounds.y + size.height > sBounds.height) {
-                    location.y = sBounds.y + Math.max(0, sBounds.height - size.height);
-                }
+            // Fit as much of the tooltip on screen as possible
+            if (location.x < sBounds.x) {
+                location.x = sBounds.x;
+            } else if (location.x - sBounds.x + size.width > sBounds.width) {
+                location.x = sBounds.x + Math.max(0, sBounds.width - size.width);
+            }
+            if (location.y < sBounds.y) {
+                location.y = sBounds.y;
+            } else if (location.y - sBounds.y + size.height > sBounds.height) {
+                location.y = sBounds.y + Math.max(0, sBounds.height - size.height);
             }
 
             PopupFactory popupFactory = PopupFactory.getSharedInstance();

src/java.desktop/unix/classes/sun/awt/wl/WLComponentPeer.java

@@ -345,18 +345,19 @@ static void moveToOverlap(Rectangle what, Rectangle where) {
         assert what.intersects(where) : String.format("Failed to move %s to overlap %s", what, where);
     }
 
-    Point nativeLocationForPopup(Window popup, Component popupParent, Window toplevel) {
+    Point nativeLocationForPopup(Window popup, Window toplevel) {
+        Objects.requireNonNull(popup);
+        Objects.requireNonNull(toplevel);
         // NB: all the coordinates are in the "surface" space as consumed by Wayland,
         //     not in pixels and not in the Java units.
 
-        // We need to provide popup's "parent" location relative to the surface this parent is painted upon:
-        Point parentLocation = javaUnitsToSurfaceUnits(getRelativeLocation(popupParent, toplevel));
-
-        // Offset is relative to the top-left corner of the "parent".
-        Point offsetFromParent = javaUnitsToSurfaceUnits(popup.getLocation());
+        Point popupOnScreen = popup.getLocation();
+        Point toplevelOnScreen = toplevel.getLocationOnScreen();
+        Point popupOnToplevel = new Point(popupOnScreen.x - toplevelOnScreen.x, popupOnScreen.y - toplevelOnScreen.y);
+        Point offsetFromToplevel = javaUnitsToSurfaceUnits(popupOnToplevel);
         var popupBounds = new Rectangle(
-                parentLocation.x + offsetFromParent.x,
-                parentLocation.y + offsetFromParent.y,
+                offsetFromToplevel.x,
+                offsetFromToplevel.y,
                 wlSize.getSurfaceWidth(),
                 wlSize.getSurfaceHeight());
         var safeToplevelBounds = toplevel.getSize();
@@ -372,7 +373,7 @@ Point nativeLocationForPopup(Window popup, Component popupParent, Window topleve
             // go outside the parent surface's bounds.
             moveToOverlap(popupBounds, safePopupBounds);
         }
-        return popupBounds.getLocation();
+        return popupBounds.getLocation(); // This is offset relative to the top-left corner of the toplevel
     }
 
     private boolean isPopupPositionUnconstrained() {
@@ -454,7 +455,7 @@ private void show() {
                     Window popup = (Window) target;
                     Component popupParent = AWTAccessor.getWindowAccessor().getPopupParent(popup);
                     Window toplevel = getToplevelFor(popupParent);
-                    Point nativeLocation = nativeLocationForPopup(popup, popupParent, toplevel);
+                    Point nativeLocation = nativeLocationForPopup(popup, toplevel);
                     nativeCreatePopup(nativePtr, getNativePtrFor(toplevel), wlSurfacePtr,
                             thisWidth, thisHeight, nativeLocation.x, nativeLocation.y, isUnconstrained);
                     stage = 1;
@@ -518,7 +519,7 @@ protected void notifyNativeWindowToBeHidden(long nativePtr) {
      * Returns true if our target should be treated as a popup in Wayland's sense,
      * i.e. it has to have a parent to position relative to.
      */
-    protected boolean targetIsWlPopup() {
+    protected final boolean targetIsWlPopup() {
         return target instanceof Window window && isWlPopup(window);
     }
 
@@ -588,7 +589,7 @@ public void updateSurfaceSize() {
             Window popup = (Window) target;
             final Component popupParent = AWTAccessor.getWindowAccessor().getPopupParent(popup);
             final Window toplevel = getToplevelFor(popupParent);
-            Point nativeLocation = nativeLocationForPopup(popup, popupParent, toplevel);
+            Point nativeLocation = nativeLocationForPopup(popup, toplevel);
             boolean isUnconstrained = isPopupPositionUnconstrained();
             nativeRepositionWLPopup(nativePtr, surfaceWidth, surfaceHeight, nativeLocation.x, nativeLocation.y, isUnconstrained);
         }
@@ -830,18 +831,8 @@ private Point getFakeLocationOnScreen() {
         // their parents' fake screen location.
         if (targetIsWlPopup()) {
             Window popup = (Window) target;
-            Component popupParent = AWTAccessor.getWindowAccessor().getPopupParent(popup);
-            Window toplevel = getToplevelFor(popupParent);
-            Point popupOffset = popup.getLocation(); // popup's offset from its parent
-            if (toplevel != null) {
-                Point parentOffset = getRelativeLocation(popupParent, toplevel);
-                Point thisLocation = toplevel.getLocationOnScreen();
-                thisLocation.translate(parentOffset.x, parentOffset.y);
-                thisLocation.translate(popupOffset.x, popupOffset.y);
-                return thisLocation;
-            } else {
-                return popupOffset;
-            }
+            // Popup's Window location is the "location on screen"
+            return popup.getLocation();
         } else {
             GraphicsConfiguration graphicsConfig = target.getGraphicsConfiguration();
             if (graphicsConfig != null) {
@@ -1784,14 +1775,15 @@ void notifyConfigured(int newSurfaceX, int newSurfaceY, int newSurfaceWidth, int
             int newX = surfaceUnitsToJavaUnits(newSurfaceX);
             int newY = surfaceUnitsToJavaUnits(newSurfaceY);
 
-            // The popup itself stores its location relative to its parent, but what we've got is
+            // The popup location is in it toplevel's screen coordinate system, but what we've got is
             // the location relative to the toplevel. Let's convert:
             Window popup = (Window) target;
             Component popupParent = AWTAccessor.getWindowAccessor().getPopupParent(popup);
             Window toplevel = getToplevelFor(popupParent);
-            Point parentLocation = getRelativeLocation(popupParent, toplevel);
-            Point locationRelativeToParent = new Point(newX - parentLocation.x, newY - parentLocation.y);
-            resetTargetLocationTo(locationRelativeToParent.x, locationRelativeToParent.y);
+            Point toplevelOnScreen = toplevel == null // highly unlikely, if at all possible
+                    ? target.getGraphicsConfiguration().getBounds().getLocation()
+                    : toplevel.getLocationOnScreen();
+            resetTargetLocationTo(newX + toplevelOnScreen.x, newY + toplevelOnScreen.y);
         }
 
         // From xdg-shell.xml: "If the width or height arguments are zero,
@@ -1869,7 +1861,22 @@ void checkIfOnNewScreen() {
             if (oldDevice != newDevice) {
                 oldDevice.removeWindow(this);
                 newDevice.addWindow(this);
+
+                if (targetIsWlPopup()) {
+                    Point loc = target.getLocation();
+                    Point oldScreenLocation = oldDevice.getBounds().getLocation();
+                    loc.translate(-oldScreenLocation.x, -oldScreenLocation.y);
+                    Point newScreenLocation = newDevice.getBounds().getLocation();
+                    loc.translate(newScreenLocation.x, newScreenLocation.y);
+                    resetTargetLocationTo(loc.x, loc.y);
+                } else {
+                    // A window has been moved to another screen. Since windows are assumed to be located at (0, 0)
+                    // on their respective screens, update the location to reflect that.
+                    Point newLocation = newDevice.getBounds().getLocation();
+                    resetTargetLocationTo(newLocation.x, newLocation.y);
+                }
             }
+
             performUnlocked(() -> {
                 var acc = AWTAccessor.getComponentAccessor();
                 acc.setGraphicsConfiguration(target, gc);

test/jdk/jb/javax/swing/wayland/WLPopupAsParent.java

@@ -21,15 +21,8 @@
  * questions.
  */
 
-import javax.swing.JFrame;
-import javax.swing.JLabel;
-import javax.swing.JPanel;
-import javax.swing.JWindow;
-import javax.swing.SwingUtilities;
-import java.awt.Color;
-import java.awt.Robot;
-import java.awt.Toolkit;
-import java.awt.Window;
+import javax.swing.*;
+import java.awt.*;
 
 import static javax.swing.WindowConstants.EXIT_ON_CLOSE;
 
@@ -39,7 +32,6 @@
  *          itself is a popup
  * @requires os.family == "linux"
  * @key headful
- * @modules java.desktop/sun.awt
  * @run main WLPopupAsParent
  * @run main/othervm -Dsun.java2d.uiScale.enabled=true -Dsun.java2d.uiScale=1.0 WLPopupAsParent
  * @run main/othervm -Dsun.java2d.uiScale.enabled=true -Dsun.java2d.uiScale=1.25 WLPopupAsParent
@@ -48,7 +40,7 @@
  */
 public class WLPopupAsParent {
     private static JFrame frame;
-    private static JWindow popup1;
+    private static Popup popup1;
 
     private static void createAndShowUI() {
         frame = new JFrame("WLPopupAsParent Test");
@@ -58,25 +50,23 @@ private static void createAndShowUI() {
     }
 
     private static void showPopup1() {
-        JPanel popupContents = new JPanel();
-        popupContents.add(new JLabel("test popup"));
-        popup1 = new JWindow(frame);
-        popup1.setType(Window.Type.POPUP);
-        sun.awt.AWTAccessor.getWindowAccessor().setPopupParent(popup1, frame);
-        popup1.setBounds(15, 33, 100, 50);
-        popup1.add(popupContents);
-        popup1.setVisible(true);
+        Point p = frame.getLocationOnScreen();
+        popup1 = PopupFactory.getSharedInstance().getPopup(
+                frame,
+                new JLabel("test popup"),
+                p.x + 15,
+                p.y + 33);
+        popup1.show();
     }
 
     private static void showPopup2() {
-        JPanel popupContents = new JPanel();
-        popupContents.add(new JLabel("second-level popup"));
-        JWindow popup2 = new JWindow(popup1);
-        popup2.setType(Window.Type.POPUP);
-        sun.awt.AWTAccessor.getWindowAccessor().setPopupParent(popup2, popup1);
-        popup2.setBounds(85, 267, 200, 100);
-        popup2.add(popupContents);
-        popup2.setVisible(true);
+        Point p = frame.getLocationOnScreen();
+        Popup popup2 = PopupFactory.getSharedInstance().getPopup(
+                frame,
+                new JLabel("second-level popup"),
+                p.x + 85,
+                p.y + 267);
+        popup2.show();
     }
 
     public static void main(String[] args) throws Exception {