Skip to content

8361283: [Accessibility,macOS,VoiceOver] VoiceOver announced Tab items of JTabbedPane as RadioButton on macOS #26096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

kumarabhi006
Copy link
Contributor

@kumarabhi006 kumarabhi006 commented Jul 2, 2025

Issue : VO doesn't announce Tab items of a JTabbedPane as RadioButton which is wrong.

Analysis : That is due to the role mapping of tab items as NSAccessibilityRadioButtonRole in JavaAccessibilityUtilities.m file. Since the accessibility role description is fetched in accessibilityRoleDescription API if CommonComponentAccessiblity.m file, the sub-role passed as a parameter is nil, returned value is RadioButton..

Proposed Fix : Fix is to get the correct accessibility role description from Appkit, we should pass NSAccessibilityTabButtonSubrole in the subrole parameter and that returns the accessibility role as Tab and is announced correctly by VO.

Testing : Manual test case has been added to verify the fix.


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-8361283: [Accessibility,macOS,VoiceOver] VoiceOver announced Tab items of JTabbedPane as RadioButton on macOS (Bug - P3)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 26096

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

Using diff file

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

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Jul 2, 2025

👋 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
Copy link

openjdk bot commented Jul 2, 2025

❗ This change is not yet ready to be integrated.
See the Progress checklist in the description for automated requirements.

@openjdk openjdk bot added the rfr Pull request is ready for review label Jul 2, 2025
@openjdk
Copy link

openjdk bot commented Jul 2, 2025

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

@openjdk openjdk bot added the client client-libs-dev@openjdk.org label Jul 2, 2025
@mlbridge
Copy link

mlbridge bot commented Jul 2, 2025

Webrevs

JTabbedPane tabPane = new JTabbedPane();
tabPane.setTabLayoutPolicy(JTabbedPane.SCROLL_TAB_LAYOUT);
tabPane.setTabPlacement(JTabbedPane.TOP);
for( int i = 0; i < NUM_TABS; ++i) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
for( int i = 0; i < NUM_TABS; ++i) {
for (int i = 0; i < NUM_TABS; ++i) {

NSString *value = NSAccessibilityRoleDescription([self accessibilityRole], nil);
NSString *value = nil;

if ([[self javaRole] isEqualToString:@"pagetab"]) {
Copy link
Contributor

@savoptik savoptik Jul 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems it would be better to simply override:

- (NSString *)accessibilityRoleDescription

in src/java.desktop/macosx/native/libawt_lwawt/awt/a11y/TabButtonAccessibility.m

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought of overriding this method but the changes are very minimal.
Even if this method is overridden in TabButtonAccessibility.m and the value returned is nil then we need to either fallback to parent's class method or need to copy the entire implementation in TabButtonAccessibility.

So, I think this should be ok to cater the changes here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do it where it makes sense as part of the tab button implementation, rather than adding workarounds to the general implementation.

Check the [super accessibilityRoleDescription] and if it returns nil, return your implementation.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check the [super accessibilityRoleDescription] and if it returns nil, return your implementation.

As I mentioned earlier in the description, accessibility role description is fetched in accessibilityRoleDescription API in CommonComponentAccessiblity.m file, the sub-role passed as a parameter is nil, returned value is RadioButton, [super accessibilityRoleDescription] will not return nil.

Anyways, I don't see this method getting invoked in TabButtonAccessibility by a11y client.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Try to debug and investigate why [TabbuttonAccessibility accessibilityRoleDescription] is not being called. If you have already attempted to override it with the changes you need.

The logic of creating tabs in TabGroupAccessibility indicates that such an override should work.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The accessible class created for a java role pagetab i.e. a tab component is CommonComponentAccessibility.
The parent for pagetab is TabGroupAccessibility and the object returned from rowRolesMapForParent is null for TabGroupAccessibility in getComponentAccessibilityClass method. Since there is no entry in the rolesMap for the pagetab role, the returned class is CommonComponentAccessibility.
So, the accessibilityRoleDescription API is invoked from CommonComponentAccessibility and not from TabButtonAccessibility.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the reference! However, I would like to advise you to thoroughly examine the code of TabGroupAccessibility. This is because it has its own implementations for creating child components.

Therefore, I am once again asking you to try to investigate the situation in more detail. There is a possibility that the mechanism is broken, and TabGroupAccessibility is not being created or used at all, which is incorrect.

Additionally, all objects in the hierarchy of native objects inherit from CommonComponentAccessibility in one way or another. If the accessibilityRoleDescription selector is not defined in TabGroupAccessibility, it may not be called.

I don’t have a Mac at hand right now; otherwise, I would debug this case myself and provide more detailed assistance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client client-libs-dev@openjdk.org rfr Pull request is ready for review
Development

Successfully merging this pull request may close these issues.

3 participants