-
Notifications
You must be signed in to change notification settings - Fork 6.1k
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
base: master
Are you sure you want to change the base?
Conversation
👋 Welcome back abhiscxk! A progress list of the required criteria for merging this PR into |
❗ This change is not yet ready to be integrated. |
@kumarabhi006 The following label will be automatically applied to this pull request:
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. |
Webrevs
|
JTabbedPane tabPane = new JTabbedPane(); | ||
tabPane.setTabLayoutPolicy(JTabbedPane.SCROLL_TAB_LAYOUT); | ||
tabPane.setTabPlacement(JTabbedPane.TOP); | ||
for( int i = 0; i < NUM_TABS; ++i) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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"]) { |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
.
There was a problem hiding this comment.
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.
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
inJavaAccessibilityUtilities.m
file. Since the accessibility role description is fetched inaccessibilityRoleDescription
API ifCommonComponentAccessiblity.m
file, the sub-role passed as a parameter isnil
, 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 asTab
and is announced correctly by VO.Testing : Manual test case has been added to verify the fix.
Progress
Issue
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