8041909: Uncaught exceptions in JComboBox listeners cause listener not to receive events
authoraghaisas
Mon, 20 Jun 2016 17:01:02 +0530
changeset 39521 c169f36c9a4b
parent 39520 df99c6e834bc
child 39522 812e919823bb
8041909: Uncaught exceptions in JComboBox listeners cause listener not to receive events Reviewed-by: alexsch, serb
jdk/src/java.desktop/share/classes/javax/swing/JComboBox.java
jdk/test/javax/swing/JComboBox/8041909/ActionListenerExceptionTest.java
--- a/jdk/src/java.desktop/share/classes/javax/swing/JComboBox.java	Fri Jun 17 16:52:38 2016 +0530
+++ b/jdk/src/java.desktop/share/classes/javax/swing/JComboBox.java	Mon Jun 20 17:01:02 2016 +0530
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2016, 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
@@ -1240,19 +1240,22 @@
             } else if (currentEvent instanceof ActionEvent) {
                 modifiers = ((ActionEvent)currentEvent).getModifiers();
             }
-            // Process the listeners last to first, notifying
-            // those that are interested in this event
-            for ( int i = listeners.length-2; i>=0; i-=2 ) {
-                if ( listeners[i]==ActionListener.class ) {
-                    // Lazily create the event:
-                    if ( e == null )
-                        e = new ActionEvent(this,ActionEvent.ACTION_PERFORMED,
-                                            getActionCommand(),
-                                            mostRecentEventTime, modifiers);
-                    ((ActionListener)listeners[i+1]).actionPerformed(e);
+            try {
+                // Process the listeners last to first, notifying
+                // those that are interested in this event
+                for ( int i = listeners.length-2; i>=0; i-=2 ) {
+                    if ( listeners[i]==ActionListener.class ) {
+                        // Lazily create the event:
+                        if ( e == null )
+                            e = new ActionEvent(this,ActionEvent.ACTION_PERFORMED,
+                                                getActionCommand(),
+                                                mostRecentEventTime, modifiers);
+                        ((ActionListener)listeners[i+1]).actionPerformed(e);
+                    }
                 }
+            } finally {
+                firingActionEvent = false;
             }
-            firingActionEvent = false;
         }
     }
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/jdk/test/javax/swing/JComboBox/8041909/ActionListenerExceptionTest.java	Mon Jun 20 17:01:02 2016 +0530
@@ -0,0 +1,178 @@
+/*
+ * Copyright (c) 2016, 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
+  * @bug 8041909
+  * @summary Test to check JComboBox does not lose its ability to invoke
+  * registerd ActionListener in case of exception in ActionListener
+  * @run main ActionListenerExceptionTest
+  */
+
+import java.awt.AWTEvent;
+import java.awt.AWTException;
+import java.awt.Dimension;
+import java.awt.EventQueue;
+import java.awt.Point;
+import java.awt.Robot;
+import java.awt.Toolkit;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.InputEvent;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import javax.swing.JComboBox;
+import javax.swing.JComponent;
+import javax.swing.JFrame;
+import javax.swing.JPopupMenu;
+import javax.swing.SwingUtilities;
+
+public class ActionListenerExceptionTest {
+
+    static final int TOTAL_MENU_ITEMS = 3;
+    private volatile int count = 0;
+    private JFrame frame;
+    private JComboBox combo;
+
+    private int menuItemHeight = 0;
+    private int yPos = 0;
+    private Point cbPos = null;
+    private Dimension cbSize = null;
+
+
+    public static void main(String[] args) throws Exception {
+
+        // See EvenQueueProxy class description below.
+        EventQueue queue = Toolkit.getDefaultToolkit().getSystemEventQueue();
+        queue.push(new EventQueueProxy());
+
+        ActionListenerExceptionTest testObject = new ActionListenerExceptionTest();
+
+        testObject.createGUI();
+
+        testObject.test();
+
+        testObject.disposeGUI();
+
+        if (testObject.getCount() != TOTAL_MENU_ITEMS) {
+            throw new RuntimeException("ActionListener is not invoked expected number of times");
+        }
+    }
+
+    private void createGUI() throws Exception {
+        SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                frame = new JFrame();
+                frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
+
+                combo = new JComboBox(new String[]{"One", "Two", "Three"});
+                combo.addActionListener(new ActionListener() {
+
+                    @Override
+                    public void actionPerformed(ActionEvent e) {
+                        count++;
+                        throw new RuntimeException();
+                    }
+                });
+                combo.setSize(200, 20);
+                frame.add(combo);
+                frame.pack();
+                frame.setLocationRelativeTo(null);
+                frame.setVisible(true);
+
+            }
+        });
+    }
+
+    private void disposeGUI() throws Exception {
+        SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                frame.dispose();
+            }
+        });
+    }
+
+    private void test() throws Exception {
+        Robot testRobot = new Robot();
+        testRobot.delay(200); // delay to make test frame visible on screen
+
+        SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                cbPos = combo.getLocationOnScreen();
+                cbSize = combo.getSize();
+            }
+        });
+
+        Point center = new Point((cbPos.x + cbSize.width / 2), (cbPos.y + cbSize.height - 5));
+        testRobot.mouseMove(center.x, center.y);
+        testRobot.delay(100);
+
+        testRobot.mousePress(InputEvent.BUTTON1_DOWN_MASK);
+        testRobot.mouseRelease(InputEvent.BUTTON1_DOWN_MASK);
+        testRobot.delay(500); // delay to make popup visible
+
+        SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                Object comp = combo.getUI().getAccessibleChild(combo, 0);
+                JComponent scrollPane = (JComponent) ((JPopupMenu) comp).getComponent(0);
+
+                menuItemHeight = scrollPane.getSize().height / TOTAL_MENU_ITEMS;
+                yPos = scrollPane.getLocationOnScreen().y + menuItemHeight / 2;
+            }
+        });
+
+        for (int i = 0; i < TOTAL_MENU_ITEMS; i++) {
+
+            testRobot.mouseMove(center.x, yPos);
+
+            testRobot.mousePress(InputEvent.BUTTON1_DOWN_MASK);
+            testRobot.delay(100);
+            testRobot.mouseRelease(InputEvent.BUTTON1_DOWN_MASK);
+            testRobot.delay(200);
+
+            yPos += menuItemHeight;
+        }
+
+    }
+
+    private int getCount() {
+        return count;
+    }
+}
+
+// Proxy class to invoke dispatchEvent and catch exceptions
+//
+// This is needed in order to test Exceptions from ActionListener
+// Without this, jtreg reports test failure at first exception from ActionListener and
+// we cannot test whether ActionListener is invoked again
+class EventQueueProxy extends EventQueue {
+
+    protected void dispatchEvent(AWTEvent evt) {
+        try {
+            super.dispatchEvent(evt);
+        } catch (Exception e) {
+            System.out.println("Intentionally consumed Exception from ActionListener");
+            e.printStackTrace();
+        }
+    }
+}
+