8302687 Implement interfaces and shared code for announcement feature #13001

savoptik · 2023-03-13T16:46:10Z

This enhancement covers basic API and shared code that should be implemented for the Accessibility Announcement feature.

CSR JDK-8304499

@mrserb @prrace @azuev-java please review

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-8302687: Implement interfaces and shared code for announcement feature (Enhancement - P4)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 13001

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

Using diff file

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

Webrev

Link to Webrev Comment

bridgekeeper · 2023-03-13T16:48:06Z

👋 Welcome back asemenov! 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 · 2023-03-13T16:51:01Z

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

avu · 2023-03-13T16:58:39Z

src/java.desktop/share/classes/sun/swing/AccessibleAnnounceProvider.java

+    /**
+     * messages do not interrupt the current speech, they are spoken after the screen reader has spoken the current phrase
+     */
+    @Native private static final int ANNOUNCE_WITHOUT_INTERRUPTING_CURRENT_OUTPUT = AccessibleAnnouncer.ANNOUNCE_WITHOUT_INTERRUPTING_CURRENT_OUTPUT;


I suppose that adding @Native to AccessibleAnnouncer constants would simplify the code

mlbridge · 2023-03-13T17:21:53Z

Webrevs

…simplify the code

turbanoff · 2023-03-17T08:51:50Z

test/jdk/java/awt/a11y/AccessibleAnnouncerTest.java

+        super.createUI(frame, "Accessible Anouncer test");
+    }
+
+    public static void main(String[] args)  throws Exception {


Suggested change

public static void main(String[] args) throws Exception {

public static void main(String[] args) throws Exception {

bridgekeeper · 2023-04-15T00:09:47Z

@savoptik 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!

savoptik · 2023-04-16T14:39:57Z

Do not close this pull request.
@mrserb @prrace @azuev-java please review

azuev-java · 2023-04-17T00:45:54Z

src/java.desktop/share/classes/javax/accessibility/AccessibleAnnouncer.java

+     */
+    void announce(Accessible a, final String str, final int priority);
+
+}


Minor: no newline at the last line of the file. Not an error just a cosmetic.

azuev-java

Since there is a new interface and a default implementation for it the CSR process should be invoked. See https://wiki.openjdk.org/display/csr/CSR+FAQs

Q: What sort of changes require CSR review?
A: Any change to a JDK interface meant to be used outside of the JDK itself requires CSR review. In this context "interface" isn't limited to the Java programing language definition of an interface, but encompasses the broader concept of a protocol between the JDK and users of the JDK. Examples of interfaces by this definition include:

Changes to public and exported APIs in java.* and javax.* packages.

And that falls well within that clause.

…osmetic.

bridgekeeper · 2023-06-13T18:02:31Z

@savoptik 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!

savoptik · 2023-06-14T13:16:29Z

You don't need to close this pull request.

bridgekeeper · 2023-07-12T15:26:45Z

@savoptik 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!

savoptik · 2023-07-13T13:36:59Z

You don't have to close anything.

bridgekeeper · 2023-08-10T14:32:16Z

@savoptik 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!

savoptik · 2023-08-11T14:50:16Z

You don't need to close this pull request.

prrace · 2023-08-17T18:49:11Z

There's a really tree of JBS issues related to this topic and I see a process problem.

The bug for this PR is https://bugs.openjdk.org/browse/JDK-8302687

But the CSR in this PR is listed as https://bugs.openjdk.org/browse/JDK-8304499
but that is actually the CSR for https://bugs.openjdk.org/browse/JDK-8302352
which is an umbrella bug.

So this is wrong.
The CSR must be the CSR for the bug in the PR, ie for something you will actually push!
Else skara and everyone else will get confused.

Then there's the overall question as to how important, or appropriate is this API ?
Seems like its not really an A11Y API, its an arbitrary text-to-speech API.
I think of the A11Y APIs as being tied to the UI and making it accessible, not
providing some other way of communicating something which isn't even in the UI.
Put it this way, if I am NOT using an AT to provide speech, how are you communicating
whatever it is to the user - something changes in the UI, right ?
So then the A11Y API will be able to report that already so why do you need this ?
Show me some equivalent cases and uses in platform ATs APIs

savoptik · 2023-08-22T06:29:02Z

@prrace
"There's a really tree of JBS issues related to this topic and I see a process problem.
The bug for this PR is https://bugs.openjdk.org/browse/JDK-8302687
But the CSR in this PR is listed as https://bugs.openjdk.org/browse/JDK-8304499
but that is actually the CSR for https://bugs.openjdk.org/browse/JDK-8302352
which is an umbrella bug.
So this is wrong.
The CSR must be the CSR for the bug in the PR, ie for something you will actually push!
Else skara and everyone else will get confused."

Thank you for your comment. I can close this PR and open a new one with a different number.

"Then there's the overall question as to how important, or appropriate is this API ?
Seems like its not really an A11Y API, its an arbitrary text-to-speech API.
I think of the A11Y APIs as being tied to the UI and making it accessible, not
providing some other way of communicating something which isn't even in the UI.
Put it this way, if I am NOT using an AT to provide speech, how are you communicating
whatever it is to the user - something changes in the UI, right ?
So then the A11Y API will be able to report that already so why do you need this ?
Show me some equivalent cases and uses in platform ATs APIs"

This functionality is part of the a11y API, for announcing we use the capabilities of the screen reader.
For example, NSAccessibility API capabilities for Mac: https://developer.apple.com/documentation/appkit/nsaccessibilitynotificationname?language=objc
Or NVDA controller client for Windows: https://github.com/nvaccess/nvda/tree/master/extras/controllerClient
Using the usual TTS annunciation tools is not a good idea, as the default TTS settings on the user's system can differ from those in the screen reader down to the voice, which is very confusing, and there may also be a difference in speed, volume and pace of speech.
Also, the built-in system TTS can sound simultaneously with the screen reader, it will sound like two voices speaking at the same time. Therefore, it will not be possible to implement interruption of the current output.

bridgekeeper · 2023-09-19T08:27:57Z

@savoptik 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!

bridgekeeper · 2023-10-17T12:36:49Z

@savoptik This pull request has been inactive for more than 8 weeks and will now be automatically closed. If you would like to continue working on this pull request in the future, feel free to reopen it! This can be done using the /open pull request command.

8302687 Implement interfaces and shared code for announcement feature

9723b28

openjdk bot added the client client-libs-dev@openjdk.org label Mar 13, 2023

update

ea5eb6a

avu reviewed Mar 13, 2023

View reviewed changes

update

b4e9290

openjdk bot added the rfr Pull request is ready for review label Mar 13, 2023

I suppose that adding @Native to AccessibleAnnouncer constants would …

4d08009

…simplify the code

turbanoff reviewed Mar 17, 2023

View reviewed changes

update

1e8fe76

azuev-java reviewed Apr 17, 2023

View reviewed changes

savoptik added 3 commits April 17, 2023 22:59

Minor: no newline at the last line of the file. Not an error just a c…

9d770eb

…osmetic.

update constans name

a51d8a5

update

e904618

bridgekeeper bot closed this Oct 17, 2023

	public static void main(String[] args) throws Exception {
	public static void main(String[] args) throws Exception {

8302687 Implement interfaces and shared code for announcement feature #13001

8302687 Implement interfaces and shared code for announcement feature #13001

Uh oh!

Conversation

savoptik commented Mar 13, 2023 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewing

Webrev

Uh oh!

bridgekeeper bot commented Mar 13, 2023

Uh oh!

openjdk bot commented Mar 13, 2023

Uh oh!

avu Mar 13, 2023

Choose a reason for hiding this comment

Uh oh!

savoptik Mar 13, 2023

Choose a reason for hiding this comment

Uh oh!

mlbridge bot commented Mar 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

turbanoff Mar 17, 2023

Choose a reason for hiding this comment

Uh oh!

savoptik Mar 17, 2023

Choose a reason for hiding this comment

Uh oh!

bridgekeeper bot commented Apr 15, 2023

Uh oh!

savoptik commented Apr 16, 2023

Uh oh!

azuev-java Apr 17, 2023

Choose a reason for hiding this comment

Uh oh!

savoptik Apr 17, 2023

Choose a reason for hiding this comment

Uh oh!

azuev-java left a comment

Choose a reason for hiding this comment

Uh oh!

bridgekeeper bot commented Jun 13, 2023

Uh oh!

savoptik commented Jun 14, 2023

Uh oh!

bridgekeeper bot commented Jul 12, 2023

Uh oh!

savoptik commented Jul 13, 2023

Uh oh!

bridgekeeper bot commented Aug 10, 2023

Uh oh!

savoptik commented Aug 11, 2023

Uh oh!

prrace commented Aug 17, 2023

Uh oh!

savoptik commented Aug 22, 2023

Uh oh!

bridgekeeper bot commented Sep 19, 2023

Uh oh!

bridgekeeper bot commented Oct 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

5 participants

savoptik commented Mar 13, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Mar 13, 2023 •

edited

Loading