8342096: Popup menus that request focus are not shown on Linux with Wayland

Author: azvegint

src/java.desktop/unix/classes/sun/awt/UNIXToolkit.java

@@ -51,7 +51,6 @@
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStreamReader;
-import java.util.Arrays;
 
 import sun.awt.X11.XBaseWindow;
 import com.sun.java.swing.plaf.gtk.GTKConstants.TextDirection;
@@ -521,6 +520,18 @@ public boolean isRunningOnWayland() {
     // application icons).
     private static final WindowFocusListener waylandWindowFocusListener;
 
+    private static boolean containsWaylandWindowFocusListener(Window window) {
+        if (window == null) {
+            return false;
+        }
+        for (WindowFocusListener focusListener : window.getWindowFocusListeners()) {
+            if (focusListener == waylandWindowFocusListener) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     static {
         if (isOnWayland()) {
             waylandWindowFocusListener = new WindowAdapter() {
@@ -530,10 +541,10 @@ public void windowLostFocus(WindowEvent e) {
                     Window oppositeWindow = e.getOppositeWindow();
 
                     // The focus can move between the window calling the popup,
-                    // and the popup window itself.
+                    // and the popup window itself or its children.
                     // We only dismiss the popup in other cases.
                     if (oppositeWindow != null) {
-                        if (window == oppositeWindow.getParent() ) {
+                        if (containsWaylandWindowFocusListener(oppositeWindow.getOwner())) {
                             addWaylandWindowFocusListenerToWindow(oppositeWindow);
                             return;
                         }
@@ -557,10 +568,7 @@ public void windowLostFocus(WindowEvent e) {
     }
 
     private static void addWaylandWindowFocusListenerToWindow(Window window) {
-        if (!Arrays
-                .asList(window.getWindowFocusListeners())
-                .contains(waylandWindowFocusListener)
-        ) {
+        if (!containsWaylandWindowFocusListener(window)) {
             window.addWindowFocusListener(waylandWindowFocusListener);
         }
     }

test/jdk/javax/swing/JPopupMenu/FocusablePopupDismissTest.java

@@ -24,7 +24,7 @@
  /*
   * @test
   * @key headful
-  * @bug 8319103
+  * @bug 8319103 8342096
   * @requires (os.family == "linux")
   * @library /java/awt/regtesthelpers
   * @build PassFailJFrame
@@ -35,6 +35,7 @@
 
 import javax.swing.JButton;
 import javax.swing.JFrame;
+import javax.swing.JMenu;
 import javax.swing.JPopupMenu;
 import javax.swing.JTextField;
 import java.awt.Window;
@@ -47,14 +48,15 @@ public class FocusablePopupDismissTest {
 
             Click on the "Click me" button.
 
-            If the JTextField popup with "Some text" is not showing on the screen,
-            click Fail.
+            A menu should appear next to the window. If you move the cursor over it,
+            the JTextField popup with "Some text" should appear on the screen.
+            If it doesn't, click Fail.
 
             The following steps require some focusable system window to be displayed
             on the screen. This could be a system settings window, file manager, etc.
 
             Click on the "Click me" button if the popup is not displayed
-            on the screen.
+            on the screen, move the mouse pointer over the menu.
 
             While the popup is displayed, click on some other window on the desktop.
             If the popup has disappeared, click Pass, otherwise click Fail.
@@ -84,7 +86,10 @@ static List<Window> createTestUI() {
         button.addActionListener(e -> {
             JPopupMenu popupMenu = new JPopupMenu();
             JTextField textField = new JTextField("Some text", 10);
-            popupMenu.add(textField);
+
+            JMenu menu = new JMenu("Menu");
+            menu.add(textField);
+            popupMenu.add(menu);
             popupMenu.show(button, 0, button.getHeight());
         });
         frame.pack();

test/jdk/javax/swing/JPopupMenu/NestedFocusablePopupTest.java

@@ -0,0 +1,104 @@
+/*
+ * Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @summary tests if nested menu is displayed on Wayland
+ * @key headful
+ * @bug 8342096
+ * @requires (os.family == "linux")
+ */
+
+import javax.swing.JButton;
+import javax.swing.JFrame;
+import javax.swing.JMenu;
+import javax.swing.JPanel;
+import javax.swing.JPopupMenu;
+import javax.swing.SwingUtilities;
+import java.awt.Dimension;
+import java.awt.Point;
+import java.awt.Robot;
+import java.awt.event.InputEvent;
+
+public class NestedFocusablePopupTest {
+
+    static volatile JMenu menu;
+    static volatile JPopupMenu popupMenu;
+    static volatile JFrame frame;
+
+    public static void main(String[] args) throws Exception {
+        if (System.getenv("WAYLAND_DISPLAY") == null) {
+            //test is valid only when running on Wayland.
+            return;
+        }
+
+        Robot robot = new Robot();
+        robot.setAutoDelay(50);
+
+        try {
+            SwingUtilities.invokeAndWait(NestedFocusablePopupTest::initAndShowGui);
+            robot.waitForIdle();
+            robot.delay(500);
+
+            Point frameLocation = frame.getLocationOnScreen();
+            robot.mouseMove(frameLocation.x + frame.getWidth() / 2,
+                    frameLocation.y + frame.getHeight() / 2);
+
+            robot.mousePress(InputEvent.BUTTON3_DOWN_MASK);
+            robot.mouseRelease(InputEvent.BUTTON3_DOWN_MASK);
+
+            robot.waitForIdle();
+            robot.delay(100);
+
+            Point menuLocation = menu.getLocationOnScreen();
+            robot.mouseMove(menuLocation.x + 5, menuLocation.y + 5);
+            robot.waitForIdle();
+            robot.delay(200);
+
+            if (!popupMenu.isVisible()) {
+                throw new RuntimeException("Popup is not visible");
+            }
+        } finally {
+            SwingUtilities.invokeAndWait(frame::dispose);
+        }
+    }
+
+
+    private static void initAndShowGui() {
+        frame = new JFrame("NestedFocusablePopupTest");
+        JPanel panel = new JPanel();
+        panel.setPreferredSize(new Dimension(200,180));
+
+
+        popupMenu = new JPopupMenu();
+        menu = new JMenu("menu to hover");
+        menu.add(new JButton("JButton"));
+        popupMenu.add(menu);
+
+        panel.setComponentPopupMenu(popupMenu);
+        frame.add(panel);
+        frame.pack();
+        frame.setLocationRelativeTo(null);
+        frame.setVisible(true);
+    }
+}