JBR-2872 improve: JBR-2866 JCEF: Markdown editor steals focus from a different frame

(cherry picked from commit bad748e3d0)

src/java.desktop/windows/native/libawt/windows/awt_Window.cpp

@@ -221,6 +221,7 @@ AwtWindow::AwtWindow() {
     m_isFocusableWindow = TRUE;
     m_isRetainingHierarchyZOrder = FALSE;
     m_filterFocusAndActivation = FALSE;
+    m_isIgnoringMouseEvents = FALSE;
 
     if (AwtWindow::ms_instanceCounter == 1) {
         AwtWindow::ms_hCBTFilter =
@@ -1182,6 +1183,7 @@ AwtWindow* AwtWindow::Create(jobject self, jobject parent)
             DWORD exStyle = WS_EX_NOACTIVATE;
             if (JNU_CallMethodByName(env, NULL, target, "isIgnoreMouseEvents", "()Z").z) {
                 exStyle |= WS_EX_LAYERED | WS_EX_TRANSPARENT;
+                window->m_isIgnoringMouseEvents = TRUE;
             }
             if (GetRTL()) {
                 exStyle |= WS_EX_RIGHT | WS_EX_LEFTSCROLLBAR;
@@ -1403,9 +1405,9 @@ void AwtWindow::Show()
     }
     if (!done) {
         // transient windows shouldn't change the owner window's position in the z-order
-        if (IsRetainingHierarchyZOrder()){
+        if (IsRetainingHierarchyZOrder() || m_isIgnoringMouseEvents) {
             UINT flags = SWP_NOSIZE | SWP_NOMOVE | SWP_SHOWWINDOW | SWP_NOOWNERZORDER;
-            if (nCmdShow == SW_SHOWNA) {
+            if (nCmdShow == SW_SHOWNA || m_isIgnoringMouseEvents) {
                 flags |= SWP_NOACTIVATE;
             }
             // This flag allows the toplevel to be bellow other process toplevels.
@@ -1420,7 +1422,15 @@ void AwtWindow::Show()
                 }
             }
 
-            ::SetWindowPos(GetHWnd(), isLightweightDialog ? HWND_TOP : HWND_TOPMOST, 0, 0, 0, 0, flags);
+            HWND hInsertAfter = isLightweightDialog ? HWND_TOP : HWND_TOPMOST;
+            if (m_isIgnoringMouseEvents) {
+                HWND hFgWindow = ::GetForegroundWindow();
+                HWND hOwner = ::GetWindow(GetHWnd(), GW_OWNER);
+                if (hFgWindow != NULL && hOwner != hFgWindow) {
+                    hInsertAfter = ::GetWindow(hOwner, GW_HWNDPREV); // insert below the wnd above the owner
+                }
+            }
+            ::SetWindowPos(GetHWnd(), hInsertAfter, 0, 0, 0, 0, flags);
         } else {
             ::ShowWindow(GetHWnd(), nCmdShow);
         }

src/java.desktop/windows/native/libawt/windows/awt_Window.h

@@ -291,7 +291,7 @@ private:
     BOOL m_isRetainingHierarchyZOrder; // Is this a window that shouldn't change z-order of any window
                                        // from its hierarchy when shown. Currently applied to instances of
                                        // javax/swing/Popup$HeavyWeightWindow class.
-
+    BOOL m_isIgnoringMouseEvents; // Make window transparent for mouse events (used for JCEF)
     RECT m_boundsOnDPIChange; /* bounds to asynchronously adjust on DPI change */
 
     // SetTranslucency() is the setter for the following two fields

test/jdk/jb/java/jcef/HwFacadeWindowNoFrontTest.java

@@ -0,0 +1,141 @@
+// Copyright 2000-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
+
+import javax.swing.*;
+import java.awt.*;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.util.concurrent.Callable;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+import java.util.function.Consumer;
+
+/**
+ * @test
+ * @key headful
+ * @requires (os.family == "windows")
+ * @summary JBR-2866 - Tests that HwFacade window used in IDEA does not bring to front when shown.
+ * @author Anton Tarasov
+ * @run main/othervm HwFacadeWindowNoFrontTest
+ */
+ public class HwFacadeWindowNoFrontTest {
+    static final Color TRANSPARENT_COLOR = new Color(1, 1, 1, 0);
+    static final Color BG_COLOR = Color.red;
+
+    static volatile JFrame bottomFrame;
+    static volatile JFrame topFrame;
+    static volatile JWindow window;
+
+    public static void main(String[] args) throws InterruptedException, AWTException, InvocationTargetException {
+        performAndWait(latch -> EventQueue.invokeLater(() -> showGUI(latch)), "initializing GUI");
+        performAndWait(latch -> waitVisibilityChanged(window, latch, true), "waiting for the window to show");
+
+        Robot robot = new Robot();
+
+        //
+        // 1) Check window is below top frame
+        //
+        performAndRepeat(10, robot, "window is not below the top frame", () -> {
+            Color pixel = robot.getPixelColor(topFrame.getX() + 100, topFrame.getY() + 100);
+            return !pixel.equals(BG_COLOR);
+        });
+
+        EventQueue.invokeLater(() -> topFrame.dispose());
+        performAndWait(latch -> waitVisibilityChanged(topFrame, latch, false), "waiting for the top frame to dispose");
+
+        //
+        // 2) Check window is above bottom frame
+        //
+        performAndRepeat(10, robot, "window is not above the bottom frame", () -> {
+            Color pixel = robot.getPixelColor(bottomFrame.getX() + 100, bottomFrame.getY() + 100);
+            return pixel.equals(BG_COLOR);
+        });
+
+        EventQueue.invokeLater(() -> {
+            bottomFrame.dispose();
+            window.dispose();
+        });
+
+        System.out.println("Test PASSED");
+    }
+
+    static void showGUI(CountDownLatch latch) {
+        bottomFrame = new JFrame("frame1");
+        bottomFrame.setSize(400, 200);
+        bottomFrame.setLocationRelativeTo(null);
+
+        window = new JWindow(bottomFrame);
+        window.add(new JPanel() {
+            {
+                setBackground(TRANSPARENT_COLOR);
+            }
+            @Override
+            protected void paintComponent(Graphics g) {
+                super.paintComponent(g);
+                g.setColor(BG_COLOR);
+                g.fillRect(0, 0, window.getWidth(), window.getHeight());
+            }
+        });
+        setIgnoreMouseEvents(window);
+        window.setBackground(TRANSPARENT_COLOR);
+        window.setSize(500, 300);
+        window.setLocationRelativeTo(null);
+
+        topFrame = new JFrame("frame2");
+        topFrame.setSize(400, 200);
+        topFrame.setLocationRelativeTo(null);
+
+        // the order matters
+        bottomFrame.setVisible(true);
+        topFrame.setVisible(true);
+        window.setVisible(true);
+
+        latch.countDown();
+    }
+
+    private static void waitVisibilityChanged(Window window, CountDownLatch latch, boolean shown) {
+        EventQueue.invokeLater(() -> {
+            boolean locationRetrieved = false;
+            try {
+                locationRetrieved = window.getLocationOnScreen() != null;
+            } catch (IllegalComponentStateException ignored) {
+            }
+            if (shown == !locationRetrieved) {
+                waitVisibilityChanged(window, latch, shown);
+                return;
+            }
+            latch.countDown();
+        });
+    }
+
+    private static void setIgnoreMouseEvents(Window window) {
+        window.setEnabled(false);
+        try {
+            Method m = Window.class.getDeclaredMethod("setIgnoreMouseEvents", boolean.class);
+            m.setAccessible(true);
+            m.invoke(window, true);
+        } catch (Throwable ignore) {
+        }
+    }
+
+    private static void performAndWait(Consumer<CountDownLatch> performer, String errMsg) {
+        CountDownLatch latch = new CountDownLatch(1);
+        performer.accept(latch);
+        try {
+            if (!latch.await(2, TimeUnit.SECONDS)) {
+                throw new RuntimeException("Test ERROR: " + errMsg);
+            }
+        } catch (InterruptedException ignored) {
+        }
+    }
+
+    private static void performAndRepeat(int count, Robot robot, String errMsg, Callable<Boolean> action) {
+        while (count-- >= 0) {
+            try {
+                if (action.call()) return;
+                robot.delay(50);
+            } catch (Exception ignored) {
+            }
+        }
+        throw new RuntimeException("Test ERROR: " + errMsg);
+    }
+}