8341311: [Accessibility,macOS,VoiceOver] VoiceOver announces incorrect number of items in submenu of JPopupMenu #25470

kumarabhi006 · 2025-05-27T17:01:16Z

VoiceOver announce incorrect number of child for a submenu of JPopupMenu when it is visible for the first time only. After that VO is able to announce the number of items correctly.

Issue: Problem is with the a11y subsystem method call to get the accessible children details.

Analysis: When the Submenu of a JPopupMenu is opened, accessible component of PopupMenu is created dynamically in the native side implementation and PostMenuOpened notification is sent to the a11y subsystem for the newly created PopupMenu. Once the notification is sent to a11y sub-system, it invokes the accessibilityChildren method to get the children details for the menu component. A11y subsystem always retrieve the information of the root level PopupMenu irrespective of the submenu's PopupMenu (PopupMenu is associated with each JMenu) and thus announce the root level PopupMenu child count which is incorrect.

Proposed Fix: Proposed fix is to ensure the correct child details are sent back to a11y sub-system for correct announcement. So, whenever the accessibilityChildren method is invoked, first try to find out the current accessible PopupMenu which is opened for the Submenu and then return the child details.

Testing : Manual test case is attached to verify the fix and there is no failure with fix in CI pipeline.

Current fix also ensures the correct child counts are announced for the JMenu's Submenu which are present in the JMenubar.

Note : While verifying the fix, a new issue is unearthed for multi-level submenu where VO is failed to announce the Submenu's text. Since the issue exists without the proposed fix too, it shall be treated as a new bug finding and will raise a separate JBS issue.

Progress

Change must be properly reviewed (1 review required, with at least 1 Reviewer)
Change must not contain extraneous whitespace
Commit message must refer to an issue

Issue

JDK-8341311: [Accessibility,macOS,VoiceOver] VoiceOver announces incorrect number of items in submenu of JPopupMenu (Bug - P3)

Reviewers

Artem Semenov (@savoptik - Committer)
Alexander Zuev (@azuev-java - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/25470/head:pull/25470
$ git checkout pull/25470

Update a local copy of the PR:
$ git checkout pull/25470
$ git pull https://git.openjdk.org/jdk.git pull/25470/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 25470

View PR using the GUI difftool:
$ git pr show -t 25470

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/25470.diff

Using Webrev

Link to Webrev Comment

bridgekeeper · 2025-05-27T17:02:07Z

👋 Welcome back abhiscxk! 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 · 2025-05-27T17:02:47Z

@kumarabhi006 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:

8341311: [Accessibility,macOS,VoiceOver] VoiceOver announces incorrect number of items in submenu of JPopupMenu

Reviewed-by: asemenov, kizune

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 65 new commits pushed to the master branch:

79aff26: 8354724: Methods in java.io.Reader to read all characters and all lines
d8a7830: 8357999: SA: FileMapInfo.metadataTypeArray initialization issue after JDK-8355003
4cf729c: 8323497: On x64, use 32-bit immediate moves for narrow klass base if possible
... and 62 more: https://git.openjdk.org/jdk/compare/78d0dc75029dba7b4ba388f9a7f5f7b22e4b838e...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.

openjdk · 2025-05-27T17:03:24Z

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

client

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.

kumarabhi006 · 2025-05-27T17:10:54Z

@azuev-java Please review the proposed fix.

kumarabhi006 · 2025-05-27T17:54:35Z

/dummy

openjdk · 2025-05-27T17:55:29Z

@kumarabhi006 Unknown command dummy - for a list of valid commands use /help.

mlbridge · 2025-05-27T17:58:30Z

Webrevs

myankelev · 2025-05-27T18:57:32Z

test/jdk/javax/accessibility/TestPopupMenuChildCount.java

+ * @run main/manual TestPopupMenuChildCount
+ */
+
+public class TestPopupMenuChildCount {


Nitpick: as far as I understand, this is for macOS only. Do you think it would make more sense to have a name mention that the test is Mac only? The same for test description. Seems to me a bit confusing otherwise

It's fine with me if you leave it as it is though.

This test is only for macOS and that is conveyed through the jtreg tag here. I don't think test name needs to be changed.

Although it is not essentially required but will update the test summary and instruction.

This test is only for macOS and that is conveyed through the jtreg tag here. I don't think test name needs to be changed.

Although it is not essentially required but will update the test summary and instruction.

It seems to me that this test should be generalized for all a11y platforms, since it is a regression test and can help identify regression of this functionality on other platforms.

The behaviour on Windows with a11y clients (JAWS or NVDA) is different. They don't announce the child count for the menu and submenus for java application and it is similar to the native application (notepad++) too.

So, the regression test restricted for macOS seems suitable for now.

savoptik · 2025-05-28T15:01:47Z

src/java.desktop/macosx/classes/sun/lwawt/macosx/CAccessibility.java

+        AccessibleContext ac = a.getAccessibleContext();
+        if (ac != null) {
+            Accessible aComp = null;
+            for (int i = 0; i < ac.getAccessibleChildrenCount(); i++) {


I suggest replacing for with while. If the desired submenu is at the beginning of the list, there’s no need to traverse it further.

I think even though the submenu is at the beginning but if it is not visible then we need to traverse further to check for other submenu if present.

Optimized the code to not traverse further if the desired submenu is fetched. Verified the recent change with the test code.

Optimized the code to not traverse further if the desired submenu is fetched. Verified the recent change with the test code.

You could, of course, put this in the while condition, but this way is also fine.

savoptik · 2025-05-28T15:25:40Z

src/java.desktop/macosx/native/libawt_lwawt/awt/a11y/MenuAccessibility.m

+    JNIEnv *env = [ThreadUtilities getJNIEnv];
+    GET_CACCESSIBILITY_CLASS_RETURN(nil);
+    DECLARE_STATIC_METHOD_RETURN(sjm_getCurrentAccessiblePopupMenu, sjc_CAccessibility,
+            "getCurrentAccessiblePopupMenu",


Won’t it be possible to get the correct object like this, as it’s done in outlineRowAccessibility.m?

jobject currentAccessible = [self currentAccessibleWithENV:env];

I tried to utilize this method but getCurrentAccessiblePopupMenu throws NPE.
java.lang.NullPointerException: Cannot invoke "sun.swing.SwingAccessor$AccessibleComponentAccessor.getCurrentAccessible(javax.accessibility.AccessibleContext)" because the return value of "sun.swing.SwingAccessor.getAccessibleComponentAccessor()" is null

savoptik

LGTM

azuev-java

Looks good.

kumarabhi006 · 2025-05-30T06:23:07Z

Note : While verifying the fix, a new issue is unearthed for multi-level submenu where VO is failed to announce the Submenu's text. Since the issue exists without the proposed fix too, it shall be treated as a new bug finding and will raise a separate JBS issue.

@azuev-java @savoptik Created a new JBS bug JDK-8358121 to track the multi level submenu text announcement issue

kumarabhi006 · 2025-05-30T06:24:42Z

/integrate

openjdk · 2025-05-30T06:25:12Z

Going to push as commit e33eeee.
Since your change was applied there have been 77 commits pushed to the master branch:

6f9e117: 8356246: C2: Compilation fails with "assert(bol->is_Bool()) failed: unexpected if shape" in StringConcat::eliminate_unneeded_control
2000551: 8353500: [s390x] Intrinsify Unsafe::setMemory
fd51b03: 8351369: [macos] Use --install-dir option with DMG packaging
... and 74 more: https://git.openjdk.org/jdk/compare/78d0dc75029dba7b4ba388f9a7f5f7b22e4b838e...master

Your commit was automatically rebased without conflicts.

openjdk · 2025-05-30T06:25:19Z

@kumarabhi006 Pushed as commit e33eeee.

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

Popupmenu child count fix

a225bf4

openjdk bot added the client client-libs-dev@openjdk.org label May 27, 2025

openjdk bot added the rfr Pull request is ready for review label May 27, 2025

myankelev reviewed May 27, 2025

View reviewed changes

Minor update

6cebdff

savoptik reviewed May 28, 2025

View reviewed changes

code optimization

0984d03

savoptik approved these changes May 29, 2025

View reviewed changes

azuev-java approved these changes May 29, 2025

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label May 29, 2025

openjdk bot added the integrated Pull request has been integrated label May 30, 2025

openjdk bot closed this May 30, 2025

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels May 30, 2025

8341311: [Accessibility,macOS,VoiceOver] VoiceOver announces incorrect number of items in submenu of JPopupMenu #25470

8341311: [Accessibility,macOS,VoiceOver] VoiceOver announces incorrect number of items in submenu of JPopupMenu #25470

Uh oh!

Conversation

kumarabhi006 commented May 27, 2025 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented May 27, 2025

Uh oh!

openjdk bot commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openjdk bot commented May 27, 2025

Uh oh!

kumarabhi006 commented May 27, 2025

Uh oh!

kumarabhi006 commented May 27, 2025

Uh oh!

openjdk bot commented May 27, 2025

Uh oh!

mlbridge bot commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

savoptik left a comment

Choose a reason for hiding this comment

Uh oh!

azuev-java left a comment

Choose a reason for hiding this comment

Uh oh!

kumarabhi006 commented May 30, 2025

Uh oh!

kumarabhi006 commented May 30, 2025

Uh oh!

openjdk bot commented May 30, 2025

Uh oh!

openjdk bot commented May 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

4 participants

kumarabhi006 commented May 27, 2025 •

edited by openjdk bot

Loading

openjdk bot commented May 27, 2025 •

edited

Loading

mlbridge bot commented May 27, 2025 •

edited

Loading