test/jdk/java/awt/TrayIcon/TrayIconMouseTest/TrayIconMouseTest.java

/*
 * Copyright (c) 2007, 2025, 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 jdk.test.lib.Platform;
import jtreg.SkippedException;

import java.awt.EventQueue;
import java.awt.Point;
import java.awt.SystemTray;
import java.awt.TrayIcon;
import java.awt.event.InputEvent;
import java.awt.image.BufferedImage;

/*
 * @test
 * @bug 6384991
 * @key headful
 * @summary Check if ActionEvent is triggered by a TrayIcon when
 *          it is double clicked with mouse button 1 on windows
 *          or single clicked with button 3 on Mac OS X
 *          or single clicked with button 1 on rest.
 * @modules java.desktop/java.awt:open
 * @library
 *          /java/awt/patchlib
 *          /java/awt/TrayIcon
 *          /lib/client
 *          /test/lib
 * @build
 *          java.desktop/java.awt.Helper
 *          jdk.test.lib.Platform
 *          jtreg.SkippedException
 *          ExtendedRobot
 *          SystemTrayIconHelper
 * @run main TrayIconMouseTest
 */

public class TrayIconMouseTest {

    TrayIcon icon;
    ExtendedRobot robot;

    volatile boolean actionPerformed = false;
    final Object actionLock = new Object();

    static boolean isMacOS = false;
    static boolean isWinOS = false;
    static boolean isOelOS = false;
    String caption = "Sample Icon";
    int[] buttonTypes = {
        InputEvent.BUTTON1_DOWN_MASK,
        InputEvent.BUTTON2_DOWN_MASK,
        InputEvent.BUTTON3_DOWN_MASK
    };
    String[] buttonNames = {
        "BUTTON1",
        "BUTTON2",
        "BUTTON3"
    };

    public static void main(String[] args) throws Exception {
        if (Platform.isOnWayland()) {
            // The current robot implementation does not support
            // clicking in the system tray area.
            throw new SkippedException("Skipped on Wayland");
        }

        if (!SystemTray.isSupported()) {
            throw new SkippedException("SystemTray is not supported on this platform.");
        }

        if (Platform.isOSX()) {
            isMacOS = true;
        } else if (Platform.isWindows()) {
            isWinOS = true;
        } else {
            isOelOS = SystemTrayIconHelper.isOel7orLater();
        }
        new TrayIconMouseTest().doTest();
    }

    TrayIconMouseTest() throws Exception {
        robot = new ExtendedRobot();
        EventQueue.invokeAndWait(this::initializeGUI);
    }

    void initializeGUI() {
        SystemTray tray = SystemTray.getSystemTray();
        icon = new TrayIcon(
                new BufferedImage(20, 20, BufferedImage.TYPE_INT_RGB), caption);
        icon.addActionListener(event -> {
            actionPerformed = true;
            synchronized (actionLock) {
                try {
                    actionLock.notifyAll();
                } catch (Exception e) {
                }
            }
        });
        try {
            tray.add(icon);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    private 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();

        for (int i = 0; i < buttonTypes.length; i++) {
            actionPerformed = false;
            robot.click(buttonTypes[i]);
            robot.waitForIdle();
            delayIfRequired();

            if (isMacOS && i == 2 && !actionPerformed) {
                throw new RuntimeException("FAIL: ActionEvent NOT triggered "
                    + "when " + buttonNames[i] + " is single clicked on Mac");
            } else if (isWinOS && actionPerformed) {
                throw new RuntimeException("FAIL: ActionEvent triggered "
                    + "when " + buttonNames[i] + " is single clicked");
            } else if (!isMacOS && !isWinOS && i == 0 && !actionPerformed) {
                throw new RuntimeException("FAIL: ActionEvent NOT triggered "
                    + "when " + buttonNames[i] + " is single clicked");
            }
        }

        if (!isMacOS && !isOelOS) {
            for (int i = 0; i < buttonTypes.length; i++) {
                for (int j = 0; j < buttonTypes.length; j++) {
                    if (j != i) {
                        actionPerformed = false;
                        robot.mousePress(buttonTypes[i]);
                        robot.mousePress(buttonTypes[j]);
                        robot.mouseRelease(buttonTypes[j]);
                        robot.mouseRelease(buttonTypes[i]);
                        robot.waitForIdle();
                        delayIfRequired();

                        if (isWinOS) {
                            if (actionPerformed) {
                                throw new RuntimeException(
                                    "FAIL: ActionEvent triggered when "
                                    + buttonNames[i] + " & " + buttonNames[j]
                                    + " is clicked and released");
                            }

                        } else if ((i == 0 || j == 0) && !actionPerformed) {
                            throw new RuntimeException("FAIL: ActionEvent is "
                                + "NOT triggered when " + buttonNames[i] + " & "
                                + buttonNames[j] + " is pressed & released");
                        }
                    }
                }
            }

            for (int i = 0; i < buttonTypes.length; i++) {
                actionPerformed = false;
                robot.mousePress(buttonTypes[i]);
                robot.mouseRelease(buttonTypes[i]);
                robot.delay(50);
                robot.mousePress(buttonTypes[i]);
                robot.mouseRelease(buttonTypes[i]);
                robot.waitForIdle();
                delayIfRequired();

                if (i == 0) {
                    if (!actionPerformed) {
                        throw new RuntimeException("FAIL: ActionEvent not "
                                + "triggered when " + buttonNames[i]
                                + " is double clicked");
                    }
                } else if (actionPerformed) {
                    throw new RuntimeException("FAIL: ActionEvent "
                            + "triggered when " + buttonNames[i]
                            + " is double clicked");
                }
            }
        }
    }

    public void delayIfRequired() {
        if (!actionPerformed) {
            synchronized (actionLock) {
                try {
                    actionLock.wait(500);
                } catch (Exception e) {
                }
            }
        }
    }
}