8048109: JToggleButton does not fire actionPerformed under certain conditions #600

trebari · 2020-10-12T08:01:43Z

Please review the following fix for jdk16.

Issue : There is a JToggleButton that will post/take down a JPopupMenu when the button is selected. If the button is selected and the menu is not posted the action listener will post the menu. If the button is selected and the menu is displayed the action listener will take the menu down. The use case is:
1 - select button
2 - menu posted
3 - select button
4 - menu taken down

With MetalLookAndFeel the above use case works fine, but with WindowsLookAndFeel the second button selection does not fire the actionPerformed event, button needs to be selected third time for the menu to be taken down.

The issue is that the button must be selected twice after the menu is posted to have the actionPerformed event to fire when using the Windows look and feel.

Fix : MouseGrabber is not removed while uninstalling the listeners in the BasicPopupMenuUI.
By removing the mouseGrabber in the uninstallListeners() methods fixes this issue.

Added a test to test the same in all the LookAndFeels

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change must be properly reviewed

Issue

JDK-8048109: JToggleButton does not fire actionPerformed under certain conditions

Reviewers

Sergey Bylokhov (@mrserb - Reviewer)
Prasanta Sadhukhan (@prsadhuk - Reviewer)
Victor Dyakov (@victordyakov - Author)

Download

$ git fetch https://git.openjdk.java.net/jdk pull/600/head:pull/600
$ git checkout pull/600

bridgekeeper · 2020-10-12T08:01:57Z

👋 Welcome back trebari! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

openjdk · 2020-10-12T08:02:55Z

@trebari The following label will be automatically applied to this pull request:

swing

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

mlbridge · 2020-10-13T08:29:22Z

Webrevs

test/jdk/javax/swing/JPopupMenu/SetInvokerJPopupMenuTest.java

psadhukhan-personal

Hi @psadhukhan-personal, thanks for making a comment in an OpenJDK project!

All comments and discussions in the OpenJDK Community must be made available under the OpenJDK Terms of Use. If you already are an OpenJDK Author, Committer or Reviewer, please click here to open a new issue so that we can record that fact. Please Use "Add GitHub user psadhukhan-personal for the summary.

If you are not an OpenJDK Author, Committer or Reviewer, simply check the box below to accept the OpenJDK Terms of Use for your comments.

I agree to the OpenJDK Terms of Use for all comments I make in a project in the OpenJDK GitHub organization.

Your comment will be automatically restored once you have accepted the OpenJDK Terms of Use.

bridgekeeper · 2020-11-12T07:09:35Z

@trebari This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

mrserb · 2020-11-30T17:30:53Z

@prsadhuk looks like your comment was added using the wrong account.

prsadhuk · 2020-11-30T17:43:10Z

not wrong but different account but that doesnot make the comment invalid, I guess.

mrserb · 2020-11-30T17:47:47Z

not wrong but different account but that doesnot make the comment invalid, I guess.

But nobody sees it, it is hidden.

prsadhuk · 2020-11-30T17:53:48Z

Well, the comment was added on Oct 15 and it got hidden on Oct28 because the ac was not of github author/committer. I think the fix submitter should have seen the comment lying there for 2 weeks before it got hidden.

trebari · 2020-12-01T02:40:27Z

I have seen the comment, it is not visible in github but its there in mailing-list.

"It seems the effect is in WindowsLookAndFeel but you are fixing in Basic L&F. If the cause is in Basic L&F, then it
would have affected other L&F also like Metal,Nimbus, doesn't it? If MouseGrabber not removed is the problem, the I
guess MouseGrabber.uninstall() is not called. This is called in BasicLookAndFeel#uninitialize() and is overridden in
WindowsLookAndFeel. Metal does not override this so maybe that's why the issue is not seen in Metal. Probably the
right fix is to call this MouseGrabber.uninstall() in Windows:LookAndFeel.uninitialize() same way as is done in
BasicLookAndFeel.uninitialize()"

the current fix doesn't looks correct so working on finding the correct fix.

trebari · 2020-12-10T16:00:28Z

In case of the first attempt to bring down the popup menu the event was consumed by following code of BasicPopupMenuUI
boolean consumeEvent =
UIManager.getBoolean("PopupMenu.consumeEventOnClose");
// Consume the event so that normal processing stops.
if(consumeEvent && !(src instanceof MenuElement)) {
me.consume();
}
The PopupMenu.consumeEventOnClose is true for Windows, Motif, Nimbus, and GTK LAF and this issue is seen in all these LookAndFeels.
For Metal LAF this variable is never set to true so it uses of BasicLookAndFeel which is set to FALSE
This issue is not seen on MetalLAF.

So changed PopupMenu.consumeEventOnClose to FALSE for Windows, Motif, Nimbus, and GTK LAF and
it fixes the issue.

prsadhuk · 2020-12-11T10:18:12Z

Any idea why commenting popup.setInvoker(jtb); line in the test works even without the fix?

trebari · 2020-12-12T12:44:43Z

In case of commenting popup.setInvoker(jtb);
the following line of code in BasicPopupMenuUI is never called

boolean consumeEvent =UIManager.getBoolean("PopupMenu.consumeEventOnClose");
// Consume the event so that normal processing stops.
if(consumeEvent && !(src instanceof MenuElement)) {
me.consume();
}

So the event is not consumed here by me.consume() and the the issue is not seen.

openjdk · 2020-12-14T03:56:03Z

@trebari This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8048109: JToggleButton does not fire actionPerformed under certain conditions

Reviewed-by: serb, psadhukhan, vdyakov

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 1467 new commits pushed to the master branch:

270014a: 8234131: Miscellaneous changes imported from jsr166 CVS 2021-01
63e3bd7: 8246677: LinkedTransferQueue and SynchronousQueue synchronization updates
5cfa8c9: 8246585: ForkJoin updates
6472104: 6278172: TextComponent.getSelectedText() throws StringIndexOutOfBoundsException
a653928: 8259512: Update --release 16 symbol information for JDK 16 build 31
7e6677b: 8259446: runtime/jni/checked/TestCheckedReleaseArrayElements.java fails with stderr not empty
628c546: 8258796: [test] Apply HexFormat to tests for java.security
876c7fb: 8259493: [test] Use HexFormat instead of adhoc hex utilities in network code and locale SoftKeys
090bd3a: 8259397: ThreadsSMRSupport::print_info_on() should use try_lock_without_rank_check()
10a6b0d: 8234773: Fix ThreadsSMRSupport::_bootstrap_list
... and 1457 more: https://git.openjdk.java.net/jdk/compare/04775f11fe637029b6040b494bb495939c6d3fcf...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

trebari · 2020-12-16T05:53:43Z

@mrserb please take a look.

mrserb · 2020-12-18T00:18:22Z

src/java.desktop/share/classes/com/sun/java/swing/plaf/gtk/GTKLookAndFeel.java

@@ -803,7 +803,7 @@ public Object createValue(UIDefaults table) {
            "PasswordField.font", new FontLazyValue(Region.PASSWORD_FIELD),


-            "PopupMenu.consumeEventOnClose", Boolean.TRUE,
+            "PopupMenu.consumeEventOnClose", Boolean.FALSE,


This property was added to support some kind of "native" behavior.
The code from the BasicPopupMenuUI.java:

// Ask UIManager about should we consume event that closes // popup. This made to match native apps behaviour. boolean consumeEvent = UIManager.getBoolean("PopupMenu.consumeEventOnClose"); // Consume the event so that normal processing stops. if(consumeEvent && !(src instanceof MenuElement)) { me.consume(); }

So after this fix, the mouse event that causes the popup to close will be not be dispatched to the next component?

Before the fix the mouse event that cause the popup to close was consumed here as the "PopupMenu.consumeEventOnClose" was true.

After the fix the mouse event that cause the popup to close will not be consumed here as "PopupMenu.consumeEventOnClose" is set to false in the fix for Windows, GTK, Nimbus and Motif LAF.

And does it match the native behavior? I mean different values of "consumeEventOnClose" weren't a bug. It was intentionally set to the appropriate value.

yeah , i have checked in windows and ubuntu native apps and it is matching native behaviour.
The issue is seen in Motif, Nimbus, GTK and windows which sets consumeEventOnClose to true.
It is not seen in Metal And Aqua which doesn't set this variable and the value from BasicLookAndFeel.java is used which is false.

Can you recheck that using the next usecase:

Create menu in the frame

Add jbutton to the frame exactly in the place where the menu popup is opened

Open menu and click some menu item, will the jbutton be clicked?

Open menu and click some menu item, will the jbutton be clicked?
No, the JButton is not clicked in this use case.

mrserb

OK, let's see how it will work.

trebari · 2021-01-10T12:37:33Z

/integrate

openjdk · 2021-01-10T12:38:36Z

@trebari Since your change was applied there have been 1468 commits pushed to the master branch:

81db63e: 8259517: Incorrect test path in test cases
270014a: 8234131: Miscellaneous changes imported from jsr166 CVS 2021-01
63e3bd7: 8246677: LinkedTransferQueue and SynchronousQueue synchronization updates
5cfa8c9: 8246585: ForkJoin updates
6472104: 6278172: TextComponent.getSelectedText() throws StringIndexOutOfBoundsException
a653928: 8259512: Update --release 16 symbol information for JDK 16 build 31
7e6677b: 8259446: runtime/jni/checked/TestCheckedReleaseArrayElements.java fails with stderr not empty
628c546: 8258796: [test] Apply HexFormat to tests for java.security
876c7fb: 8259493: [test] Use HexFormat instead of adhoc hex utilities in network code and locale SoftKeys
090bd3a: 8259397: ThreadsSMRSupport::print_info_on() should use try_lock_without_rank_check()
... and 1458 more: https://git.openjdk.java.net/jdk/compare/04775f11fe637029b6040b494bb495939c6d3fcf...master

Your commit was automatically rebased without conflicts.

Pushed as commit 65ca5c6.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

Fix for JDK-8048109 and added a test

3a7b134

openjdk bot added the swing client-libs-dev@openjdk.org label Oct 12, 2020

trebari added 4 commits October 12, 2020 15:17

minor changes

db2f088

made intenal classes static and moved them inside main class

3fe4038

changes permission of the test file

2d2360c

changed mode of src file

a60ffa6

openjdk bot added the rfr Pull request is ready for review label Oct 13, 2020

mrserb suggested changes Oct 14, 2020

View reviewed changes

test/jdk/javax/swing/JPopupMenu/SetInvokerJPopupMenuTest.java Outdated Show resolved Hide resolved

test/jdk/javax/swing/JPopupMenu/SetInvokerJPopupMenuTest.java Outdated Show resolved Hide resolved

test/jdk/javax/swing/JPopupMenu/SetInvokerJPopupMenuTest.java Show resolved Hide resolved

psadhukhan-personal reviewed Oct 15, 2020

View reviewed changes

modified the test after suggestions

65c08ed

reworked fix, also fixed for nimbus,motif,GTK LAF

036633b

openjdk bot removed the rfr Pull request is ready for review label Dec 10, 2020

changed mode of files

f07a172

openjdk bot added the rfr Pull request is ready for review label Dec 10, 2020

prsadhuk approved these changes Dec 14, 2020

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Dec 14, 2020

mrserb reviewed Dec 18, 2020

View reviewed changes

victordyakov approved these changes Dec 18, 2020

View reviewed changes

mrserb approved these changes Jan 10, 2021

View reviewed changes

openjdk bot closed this Jan 10, 2021

openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jan 10, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8048109: JToggleButton does not fire actionPerformed under certain conditions #600

8048109: JToggleButton does not fire actionPerformed under certain conditions #600

trebari commented Oct 12, 2020 •

edited by openjdk bot

Loading

bridgekeeper bot commented Oct 12, 2020

openjdk bot commented Oct 12, 2020

mlbridge bot commented Oct 13, 2020 •

edited

Loading

psadhukhan-personal left a comment •

edited

Loading

bridgekeeper bot commented Nov 12, 2020

mrserb commented Nov 30, 2020

prsadhuk commented Nov 30, 2020

mrserb commented Nov 30, 2020

prsadhuk commented Nov 30, 2020

trebari commented Dec 1, 2020

trebari commented Dec 10, 2020

prsadhuk commented Dec 11, 2020

trebari commented Dec 12, 2020

openjdk bot commented Dec 14, 2020 •

edited

Loading

trebari commented Dec 16, 2020

mrserb Dec 18, 2020

trebari Dec 18, 2020

mrserb Dec 18, 2020

trebari Dec 21, 2020

mrserb Dec 23, 2020

trebari Jan 6, 2021

mrserb left a comment

trebari commented Jan 10, 2021

openjdk bot commented Jan 10, 2021

8048109: JToggleButton does not fire actionPerformed under certain conditions #600

8048109: JToggleButton does not fire actionPerformed under certain conditions #600

Conversation

trebari commented Oct 12, 2020 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Download

bridgekeeper bot commented Oct 12, 2020

openjdk bot commented Oct 12, 2020

mlbridge bot commented Oct 13, 2020 • edited Loading

Webrevs

psadhukhan-personal left a comment • edited Loading

Choose a reason for hiding this comment

bridgekeeper bot commented Nov 12, 2020

mrserb commented Nov 30, 2020

prsadhuk commented Nov 30, 2020

mrserb commented Nov 30, 2020

prsadhuk commented Nov 30, 2020

trebari commented Dec 1, 2020

trebari commented Dec 10, 2020

prsadhuk commented Dec 11, 2020

trebari commented Dec 12, 2020

openjdk bot commented Dec 14, 2020 • edited Loading

trebari commented Dec 16, 2020

mrserb Dec 18, 2020

Choose a reason for hiding this comment

trebari Dec 18, 2020

Choose a reason for hiding this comment

mrserb Dec 18, 2020

Choose a reason for hiding this comment

trebari Dec 21, 2020

Choose a reason for hiding this comment

mrserb Dec 23, 2020

Choose a reason for hiding this comment

trebari Jan 6, 2021

Choose a reason for hiding this comment

mrserb left a comment

Choose a reason for hiding this comment

trebari commented Jan 10, 2021

openjdk bot commented Jan 10, 2021

trebari commented Oct 12, 2020 •

edited by openjdk bot

Loading

mlbridge bot commented Oct 13, 2020 •

edited

Loading

psadhukhan-personal left a comment •

edited

Loading

openjdk bot commented Dec 14, 2020 •

edited

Loading