8379347: VoiceOver Doesn't Correctly Identify JToggleButtons as "toggle buttons" by mickleness · Pull Request #30096 · openjdk/jdk

mickleness · 2026-03-05T19:52:36Z

With this PR: VoiceOver correctly identifies a JToggleButton as a "toggle button" (instead of a "checkbox")

This adds the subrole of NSAccessibilityToggleSubrole (which Accessibility Inspector shows as the subrole "AXToggle").

In the screenshot the subrole appears as expected, and the "class" (in the "element") section is different from production:

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-8379347: VoiceOver Doesn't Correctly Identify JToggleButtons as "toggle buttons" (Bug - P4)

Reviewers

Phil Race (@prrace - Reviewer) Review applies to 4808253b
Harshitha Onkar (@honkar-jdk - Reviewer)
Alexander Zuev (@azuev-java - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 30096

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

Using diff file

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

Using Webrev

Link to Webrev Comment

If a button uses Swing's AccessibleRole.TOGGLE_BUTTON, then as far as Apple's UI is concerned: it should have a role of NSAccessibilityCheckBoxRole and a subrole of NSAccessibilityToggleSubrole

bridgekeeper · 2026-03-05T19:58:13Z

👋 Welcome back jwood! 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 · 2026-03-05T19:59:05Z

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

8379347: VoiceOver Doesn't Correctly Identify JToggleButtons as "toggle buttons"

Reviewed-by: honkar, kizune, prr

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

7e4ac14: 8380686: GenerateOopMap logging crashes in rewriter
7ffc4a4: 8381019: Remove AppContext usage from AccessBridge
79668b0: 8380710: nmethod::finalize_relocations() should be called before ICache::invalidate_range() is called
... and 332 more: https://git.openjdk.org/jdk/compare/3d6856c251cb2476fe3d3139084d9c61c3835744...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.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@prrace, @honkar-jdk, @azuev-java) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

openjdk · 2026-03-05T20:29:35Z

@mickleness 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.

mlbridge · 2026-03-06T00:38:34Z

Webrevs

01: Full - Incremental (adc8c755)
00: Full (4808253b)

prrace · 2026-03-26T21:28:56Z

@azuev-java please review
Also @honkar-jdk please review

honkar-jdk

VO announces first part correctly and then it says "To select or deselect the checkbox press Ctrl+Option+Space" Shouldn't it say toggleButton here?

honkar-jdk · 2026-03-27T00:44:04Z

    return NSAccessibilityCheckBoxRole;
 }

+- (NSAccessibilitySubrole _Nullable)accessibilitySubrole


Since this is JToggleButton, do we need to add this subrole to ButtonAccessbility.m ?

I'm not sure I understand your question.

Currently if any java.awt.Component has the role AccessibleRole.TOGGLE_BUTTON: then (based on the new proposed changes to CommonComponentAccessibility) that java.awt.Component is mapped to a CheckboxAccessibility object.

By contrast: if a java.awt.Component uses AccessibleRole.PUSH_BUTTON, then it is mapped to a ButtonAccessibility object.

... so as I understand it: assuming roles are immutable, we'll never use ButtonAccessibility.m for toggle buttons. So I don't think ButtonAccessibility.m will benefit from the subrole getter here. (We could add it someday for other subroles, like NSAccessibilityToolbarButtonSubrole, but that's outside the scope of this ticket.)

Does that speak to your question, or did I misunderstand what you're asking?

Let me re-phrase for clarity:

Initially I thought for JToggleButton, AccessibleRole => Button and AccessibleSubRole => toggleButton made more logical sense.

I made slight modification as below -
[rolesMap setObject:@"ButtonAccessibility" forKey:@"togglebutton"];
and moved the above code snippet to ButtonAccessbility.m.

With this change the VO announces that it is JToggleButton and to select/deselect button press Ctrl + Option + Space which seemed correct.

Revisited the code and I believe "checkbox" Role is more appropriate for JToggleButton for another reason as well - accessibilityValue for NSAccessibilityButtonRole is NULL which may not be the correct return value for JToggleButton.

In short, your changes look good. Thanks for the details.

honkar-jdk · 2026-03-27T00:45:13Z

+        String INSTRUCTIONS = "INSTRUCTIONS (Mac-only):\n" +
+                "1. Open VoiceOver\n" +
+                "2. Move the VoiceOver cursor over the JToggleButton.\n" +
+                "3. Observe how VoiceOver identifies the toggle button.\n\n" +
+                "Expected behavior: VoiceOver should identify it as a " +
+                "\"toggle button\". It should not say \"checkbox\".\n\n" +
+                "If you select the link using \"Accessibility " +
+                "Inspector\": it should identify its subrole as AXToggle.";


You could use text blocks here

OK, this is updated

mickleness · 2026-03-27T02:39:15Z

VO announces first part correctly and then it says "To select or deselect the checkbox press Ctrl+Option+Space" Shouldn't it say toggleButton here?

Good question, but I think this is the standard behavior.

Here is an example of a toggle button in Font Book, which presumably is working according to Apple's standards/expectations. Here VO also says "to select or deselect this checkbox":

toggle.button.demo.mp4

This is in response to: https://github.com/openjdk/jdk/pull/30096/changes#r2998420677

This is in response to: openjdk#30096 (review)

azuev-java

Looks good.

honkar-jdk

Changes LGTM

honkar-jdk · 2026-03-27T23:50:49Z

    return NSAccessibilityCheckBoxRole;
 }

+- (NSAccessibilitySubrole _Nullable)accessibilitySubrole


Let me re-phrase for clarity:

Initially I thought for JToggleButton, AccessibleRole => Button and AccessibleSubRole => toggleButton made more logical sense.

I made slight modification as below -
[rolesMap setObject:@"ButtonAccessibility" forKey:@"togglebutton"];
and moved the above code snippet to ButtonAccessbility.m.

With this change the VO announces that it is JToggleButton and to select/deselect button press Ctrl + Option + Space which seemed correct.

Revisited the code and I believe "checkbox" Role is more appropriate for JToggleButton for another reason as well - accessibilityValue for NSAccessibilityButtonRole is NULL which may not be the correct return value for JToggleButton.

In short, your changes look good. Thanks for the details.

honkar-jdk · 2026-03-27T23:53:28Z

VO announces first part correctly and then it says "To select or deselect the checkbox press Ctrl+Option+Space" Shouldn't it say toggleButton here?

Good question, but I think this is the standard behavior.

Here is an example of a toggle button in Font Book, which presumably is working according to Apple's standards/expectations. Here VO also says "to select or deselect this checkbox":

Sounds reasonable. Good to match it with native app behavior.

mickleness · 2026-03-28T08:28:52Z

/integrate

openjdk · 2026-03-28T08:29:33Z

@mickleness
Your change (at version adc8c75) is now ready to be sponsored by a Committer.

azuev-java · 2026-03-28T09:32:38Z

/sponsor

openjdk · 2026-03-28T09:33:32Z

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

7e4ac14: 8380686: GenerateOopMap logging crashes in rewriter
7ffc4a4: 8381019: Remove AppContext usage from AccessBridge
79668b0: 8380710: nmethod::finalize_relocations() should be called before ICache::invalidate_range() is called
... and 332 more: https://git.openjdk.org/jdk/compare/3d6856c251cb2476fe3d3139084d9c61c3835744...master

Your commit was automatically rebased without conflicts.

openjdk · 2026-03-28T09:33:42Z

@azuev-java @mickleness Pushed as commit ac24255.

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

mickleness added 2 commits March 5, 2026 14:23

8379347: give toggle buttons subrole

d1d82a4

If a button uses Swing's AccessibleRole.TOGGLE_BUTTON, then as far as Apple's UI is concerned: it should have a role of NSAccessibilityCheckBoxRole and a subrole of NSAccessibilityToggleSubrole

8379347: add VoiceOverToggleButtonRole test

4808253

openjdk Bot added the client client-libs-dev@openjdk.org label Mar 5, 2026

mickleness changed the title ~~VoiceOver Doesn't Correctly Identify JToggleButtons as "toggle buttons"~~ 8379347: VoiceOver Doesn't Correctly Identify JToggleButtons as "toggle buttons" Mar 6, 2026

openjdk Bot added the rfr Pull request is ready for review label Mar 6, 2026

prrace approved these changes Mar 26, 2026

View reviewed changes

openjdk Bot added the ready Pull request is ready to be integrated label Mar 26, 2026

honkar-jdk reviewed Mar 27, 2026

View reviewed changes

mickleness added 2 commits March 26, 2026 23:05

8379347: use text block

23fe979

This is in response to: https://github.com/openjdk/jdk/pull/30096/changes#r2998420677

8379347: clarify expected behavior for testers

adc8c75

This is in response to: openjdk#30096 (review)

openjdk Bot removed the ready Pull request is ready to be integrated label Mar 27, 2026

azuev-java approved these changes Mar 27, 2026

View reviewed changes

openjdk Bot added the ready Pull request is ready to be integrated label Mar 27, 2026

honkar-jdk approved these changes Mar 27, 2026

View reviewed changes

openjdk Bot added the sponsor Pull request is ready to be sponsored label Mar 28, 2026

openjdk Bot added the integrated Pull request has been integrated label Mar 28, 2026

openjdk Bot closed this Mar 28, 2026

openjdk Bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Mar 28, 2026

openjdk Bot removed the sponsor Pull request is ready to be sponsored label Mar 28, 2026

Conversation

mickleness commented Mar 5, 2026 • 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 Mar 5, 2026

Uh oh!

openjdk Bot commented Mar 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openjdk Bot commented Mar 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mlbridge Bot commented Mar 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

prrace commented Mar 26, 2026

Uh oh!

honkar-jdk left a comment

Choose a reason for hiding this comment

Uh oh!

honkar-jdk Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

mickleness Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

honkar-jdk Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

honkar-jdk Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

mickleness Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

mickleness commented Mar 27, 2026

Uh oh!

azuev-java left a comment

Choose a reason for hiding this comment

Uh oh!

honkar-jdk left a comment

Choose a reason for hiding this comment

Uh oh!

honkar-jdk Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

honkar-jdk commented Mar 27, 2026

Uh oh!

mickleness commented Mar 28, 2026

Uh oh!

openjdk Bot commented Mar 28, 2026

Uh oh!

azuev-java commented Mar 28, 2026

Uh oh!

openjdk Bot commented Mar 28, 2026

Uh oh!

openjdk Bot commented Mar 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

4 participants

mickleness commented Mar 5, 2026 •

edited by openjdk Bot

Loading

openjdk Bot commented Mar 5, 2026 •

edited

Loading

openjdk Bot commented Mar 5, 2026 •

edited

Loading

mlbridge Bot commented Mar 6, 2026 •

edited

Loading