8146537: TrayIcon Action Listener doesnt work in WIndows 10
authorsveerabhadra
Tue, 12 Dec 2017 12:43:05 +0530
changeset 48288 752f0e49c3f0
parent 48287 e53948132278
child 48289 054fecf0c1d2
8146537: TrayIcon Action Listener doesnt work in WIndows 10 Reviewed-by: serb, ssadetsky
src/java.desktop/windows/native/libawt/windows/awt_TrayIcon.cpp
test/jdk/java/awt/TrayIcon/TrayIconPopup/TrayIconPopupClickTest.java
--- a/src/java.desktop/windows/native/libawt/windows/awt_TrayIcon.cpp	Tue Dec 12 12:31:49 2017 +0530
+++ b/src/java.desktop/windows/native/libawt/windows/awt_TrayIcon.cpp	Tue Dec 12 12:43:05 2017 +0530
@@ -411,12 +411,15 @@
 
 MsgRouting AwtTrayIcon::WmBalloonUserClick(UINT flags, int x, int y)
 {
-    if (AwtComponent::GetJavaModifiers() & java_awt_event_InputEvent_BUTTON1_DOWN_MASK) {
-        MSG msg;
-        AwtComponent::InitMessage(&msg, lastMessage, flags, MAKELPARAM(x, y), x, y);
-        SendActionEvent(java_awt_event_ActionEvent_ACTION_PERFORMED, ::JVM_CurrentTimeMillis(NULL, 0),
-                        AwtComponent::GetActionModifiers(), &msg);
-    }
+    // The windows api GetKeyState() when read would provide the key state of the requrested key
+    // but it is not guaranteed to receive the same as it is stored in the thread message queue and
+    // unless the thread runs faster.
+    // Event NIN_BALLOONUSERCLICK is received only upon left mouse click. Hence the additional check
+    // is not required.
+    MSG msg;
+    AwtComponent::InitMessage(&msg, lastMessage, flags, MAKELPARAM(x, y), x, y);
+    SendActionEvent(java_awt_event_ActionEvent_ACTION_PERFORMED, ::JVM_CurrentTimeMillis(NULL, 0),
+                    AwtComponent::GetActionModifiers(), &msg);
     return mrConsume;
 }
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/jdk/java/awt/TrayIcon/TrayIconPopup/TrayIconPopupClickTest.java	Tue Dec 12 12:43:05 2017 +0530
@@ -0,0 +1,124 @@
+/*
+ * Copyright (c) 2017, 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.
+ */
+import java.awt.TrayIcon;
+import java.awt.SystemTray;
+import java.awt.EventQueue;
+import java.awt.Point;
+import java.awt.AWTException;
+import java.awt.event.MouseEvent;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.InputEvent;
+import java.awt.event.MouseAdapter;
+import java.awt.image.BufferedImage;
+
+/*
+ * @test
+ * @summary Check if a action performed event is received when TrayIcon display
+ *          message is clicked on.
+ * @author Shashidhara Veerabhadraiah (shashidhara.veerabhadraiah@oracle.com)
+ * @modules java.desktop/java.awt:open
+ * @library /java/awt/patchlib
+ * @library ../../../../lib/testlibrary ../
+ * @build java.desktop/java.awt.Helper
+ * @build ExtendedRobot SystemTrayIconHelper
+ * @run main TrayIconPopupClickTest
+ */
+
+public class TrayIconPopupClickTest {
+
+    TrayIcon icon;
+    ExtendedRobot robot;
+    boolean actionPerformed = false;
+
+    public static void main(String[] args) throws Exception {
+        if (!SystemTray.isSupported()) {
+            System.out.println("SystemTray not supported on the platform under test. " +
+                    "Marking the test passed");
+        } else {
+            if (System.getProperty("os.name").toLowerCase().startsWith("win"))
+                System.err.println("Test can fail if the icon hides to a tray icons pool " +
+                        "in Windows 7/10, which is behavior by default.\n" +
+                        "Set \"Right mouse click\" -> \"Customize notification icons\" -> " +
+                        "\"Always show all icons and notifications on the taskbar\" true " +
+                        "to avoid this problem. Or change behavior only for Java SE " +
+                        "tray icon.");
+            new TrayIconPopupClickTest().doTest();
+        }
+    }
+
+    TrayIconPopupClickTest() throws Exception {
+        robot = new ExtendedRobot();
+        EventQueue.invokeAndWait(this::initializeGUI);
+        robot.waitForIdle(1000);
+    }
+
+    private void initializeGUI() {
+        SystemTray tray = SystemTray.getSystemTray();
+        icon = new TrayIcon(new BufferedImage(20, 20, BufferedImage.TYPE_INT_RGB), "Sample Icon");
+        icon.addMouseListener(new MouseAdapter() {
+            public void mousePressed(MouseEvent event) {
+                icon.displayMessage("Sample Icon", "This is a test message for the tray icon", TrayIcon.MessageType.INFO);
+            }
+        });
+
+        try {
+            tray.add(icon);
+        } catch (AWTException e) {
+            throw new RuntimeException(e);
+        }
+
+        icon.getActionCommand();
+        icon.addActionListener(new ActionListener() {
+            @Override
+            public void actionPerformed(ActionEvent e) {
+                actionPerformed = true;
+            }
+        });
+    }
+
+    void doTest() throws Exception {
+
+        Point iconPosition = SystemTrayIconHelper.getTrayIconLocation(icon);
+        if (iconPosition == null)
+            throw new RuntimeException("Unable to find the icon location!");
+
+        robot.mouseMove(iconPosition.x, iconPosition.y);
+        robot.waitForIdle();
+        robot.mousePress(InputEvent.BUTTON1_MASK);
+        robot.delay(50);
+        robot.mouseRelease(InputEvent.BUTTON1_MASK);
+        robot.delay(50);
+
+        robot.mouseMove(iconPosition.x, iconPosition.y + 10);
+        robot.waitForIdle();
+        robot.mousePress(InputEvent.BUTTON1_MASK);
+        robot.delay(50);
+        robot.mouseRelease(InputEvent.BUTTON1_MASK);
+        robot.delay(50);
+
+        if (!actionPerformed)
+            throw new RuntimeException("FAIL: ActionEvent not triggered when " +
+                    "tray icon message was clicked on");
+    }
+}