8225505: ctrl-F1 does not show the tooltip of a menu item (JMenuItems)
Reviewed-by: psadhukhan, serb
--- a/src/java.desktop/share/classes/javax/swing/ToolTipManager.java Mon Aug 19 12:13:47 2019 +0530
+++ b/src/java.desktop/share/classes/javax/swing/ToolTipManager.java Fri Aug 23 14:25:20 2019 +0100
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2019, 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
@@ -29,6 +29,8 @@
import java.awt.event.*;
import java.awt.*;
import java.util.Objects;
+import javax.swing.event.MenuKeyEvent;
+import javax.swing.event.MenuKeyListener;
/**
* Manages all the <code>ToolTips</code> in the system.
@@ -415,8 +417,14 @@
component.addMouseListener(this);
component.removeMouseMotionListener(moveBeforeEnterListener);
component.addMouseMotionListener(moveBeforeEnterListener);
- component.removeKeyListener(accessibilityKeyListener);
- component.addKeyListener(accessibilityKeyListener);
+ // use MenuKeyListener for menu items/elements
+ if (component instanceof JMenuItem) {
+ ((JMenuItem) component).removeMenuKeyListener((MenuKeyListener) accessibilityKeyListener);
+ ((JMenuItem) component).addMenuKeyListener((MenuKeyListener) accessibilityKeyListener);
+ } else {
+ component.removeKeyListener(accessibilityKeyListener);
+ component.addKeyListener(accessibilityKeyListener);
+ }
}
/**
@@ -427,7 +435,11 @@
public void unregisterComponent(JComponent component) {
component.removeMouseListener(this);
component.removeMouseMotionListener(moveBeforeEnterListener);
- component.removeKeyListener(accessibilityKeyListener);
+ if (component instanceof JMenuItem) {
+ ((JMenuItem) component).removeMenuKeyListener((MenuKeyListener) accessibilityKeyListener);
+ } else {
+ component.removeKeyListener(accessibilityKeyListener);
+ }
}
// implements java.awt.event.MouseListener
@@ -867,7 +879,7 @@
* Post Tip: Ctrl+F1
* Unpost Tip: Esc and Ctrl+F1
*/
- private class AccessibilityKeyListener extends KeyAdapter {
+ private class AccessibilityKeyListener extends KeyAdapter implements MenuKeyListener {
public void keyPressed(KeyEvent e) {
if (!e.isConsumed()) {
JComponent source = (JComponent) e.getComponent();
@@ -884,5 +896,32 @@
}
}
}
+
+ @Override
+ public void menuKeyTyped(MenuKeyEvent e) {}
+
+ @Override
+ public void menuKeyPressed(MenuKeyEvent e) {
+ if (postTip.equals(KeyStroke.getKeyStrokeForEvent(e))) {
+ // get element for the event
+ MenuElement path[] = e.getPath();
+ MenuElement element = path[path.length - 1];
+
+ // retrieve currently highlighted element
+ MenuSelectionManager msm = e.getMenuSelectionManager();
+ MenuElement selectedPath[] = msm.getSelectedPath();
+ MenuElement selectedElement = selectedPath[selectedPath.length - 1];
+
+ if (element.equals(selectedElement)) {
+ // show/hide tooltip message
+ JComponent source = (JComponent) element.getComponent();
+ ToolTipManager.this.show(source);
+ e.consume();
+ }
+ }
+ }
+
+ @Override
+ public void menuKeyReleased(MenuKeyEvent e) {}
}
}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/test/jdk/javax/swing/ToolTipManager/JMenuItemToolTipKeyBindingsTest/JMenuItemToolTipKeyBindingsTest.java Fri Aug 23 14:25:20 2019 +0100
@@ -0,0 +1,144 @@
+/*
+ * Copyright (c) 2019, 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
+ * @key headful
+ * @bug 8225505
+ * @summary CTRL + 1 does not show tooltip message for menu items
+ * @run main/manual JMenuItemToolTipKeyBindingsTest
+ */
+
+import javax.swing.JFrame;
+import javax.swing.JMenu;
+import javax.swing.JMenuBar;
+import javax.swing.JMenuItem;
+import javax.swing.SwingUtilities;
+import java.awt.Button;
+import java.awt.Dialog;
+import java.awt.Panel;
+import java.awt.TextArea;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+public class JMenuItemToolTipKeyBindingsTest {
+ private static final long TIMEOUT = 5 * 60 * 1000;
+ private static final AtomicBoolean testCompleted = new AtomicBoolean(false);
+ private static volatile boolean testResult = false;
+
+ private static Dialog controlDialog;
+ private static JFrame testFrame;
+
+ private static final String instructions =
+ "Verify that \"CTRL\" + \"F1\" key sequence shows/hides tool tip message" +
+ "\nfor menu items.\n" +
+ "\n1. Open pop-up menu \"Menu\", (i.e. press \"F10\")." +
+ "\n2. Navigate to some menu element using keyboard." +
+ "\n3. Press \"CTRL\" + \"F1\" once menu item is selected." +
+ "\nIf tooltip message is displayed for the item then press \"Pass\"," +
+ "\n otherwise press \"Fail\".";
+
+ public static void main(String[] args) throws Exception {
+ try {
+ SwingUtilities.invokeAndWait(() -> createAndShowGUI());
+
+ waitForCompleting();
+ if (!testResult) {
+ throw new RuntimeException("Test FAILED!");
+ }
+ } finally {
+ if (controlDialog != null) {
+ controlDialog.dispose();
+ }
+ if (testFrame != null) {
+ testFrame.dispose();
+ }
+ }
+ }
+
+ private static void createAndShowGUI() {
+ controlDialog = new Dialog((JFrame)null, "JMenuItemToolTipKeyBindingsTest");
+
+ TextArea messageArea = new TextArea(instructions, 15, 80, TextArea.SCROLLBARS_BOTH);
+ controlDialog.add("North", messageArea);
+
+ Button passedButton = new Button("Pass");
+ passedButton.addActionListener(new ActionListener() {
+ @Override
+ public void actionPerformed(ActionEvent e) {
+ testResult = true;
+ completeTest();
+ }
+ });
+
+ Button failedButton = new Button("Fail");
+ failedButton.addActionListener(new ActionListener() {
+ @Override
+ public void actionPerformed(ActionEvent e) {
+ testResult = false;
+ completeTest();
+ }
+ });
+
+ Panel buttonPanel = new Panel();
+ buttonPanel.add("West",passedButton);
+ buttonPanel.add("East", failedButton);
+ controlDialog.add("South", buttonPanel);
+
+ controlDialog.setBounds(250, 0, 500, 500);
+ controlDialog.setVisible(true);
+
+ testFrame = new JFrame("JMenuItemToolTipKeyBindingsTest");
+ testFrame.setSize(200, 200);
+ JMenuBar jMenuBar = new JMenuBar();
+ JMenu jMenu = new JMenu("Menu");
+ for (int i = 0; i < 3; i++) {
+ JMenuItem jMenuItem = new JMenuItem("Item " + i);
+ jMenuItem.setToolTipText("Tooltip " + i);
+ jMenu.add(jMenuItem);
+ }
+ jMenuBar.add(jMenu);
+ testFrame.setJMenuBar(jMenuBar);
+ testFrame.setVisible(true);
+ }
+
+ private static void completeTest() {
+ testCompleted.set(true);
+ synchronized (testCompleted) {
+ testCompleted.notifyAll();
+ }
+ }
+
+ private static void waitForCompleting() throws Exception {
+ synchronized (testCompleted) {
+ long startTime = System.currentTimeMillis();
+ while (!testCompleted.get()) {
+ testCompleted.wait(TIMEOUT);
+ if (System.currentTimeMillis() - startTime >= TIMEOUT) {
+ break;
+ }
+ }
+ }
+ }
+}
+