Skip to content
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

8313138: Scrollbar Keyboard enhancement #1393

Conversation

andy-goryachev-oracle
Copy link
Contributor

@andy-goryachev-oracle andy-goryachev-oracle commented Mar 6, 2024

Adding alt-ctrl-LEFT/RIGHT/UP/DOWN (option-command-LEFT/RIGHT/UP/DOWN) key bindings to

  • ListView
  • TreeView
  • TableView
  • TreeTableView

to support keyboard-only horizontal and vertical scrolling. The main reason for the change is to improve accessibility.

NOTE: For controls in right-to-left orientation, the direction of horizontal scrolling is reversed.

As far as I can tell, these key combinations do not interfere with editing.

The proposed solution can be further optimized by adding a public method to the VirtualFlow class, something like

public void horizontalUnitScroll(boolean right);
public void verticalUnitScroll(boolean down);

Q: Does this change require a CSR to explain the change in the controls' behavior? We don't yet have the key bindings documented in /doc-files/behavior

Note:
Jenkins headful test passed on all mac configurations, failed on all linux configurations (master branch failed also, so it is test issue), while windows configuration is not yet available.


Progress

  • Change must not contain extraneous whitespace
  • Change requires CSR request JDK-8329336 to be approved
  • Commit message must refer to an issue
  • Change must be properly reviewed (2 reviews required, with at least 1 Reviewer, 1 Author)

Issues

  • JDK-8313138: Scrollbar Keyboard enhancement (Enhancement - P3)
  • JDK-8329336: Scrollbar Keyboard enhancement (CSR)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 1393

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jfx/pull/1393.diff

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Mar 6, 2024

👋 Welcome back angorya! 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.

@andy-goryachev-oracle andy-goryachev-oracle marked this pull request as ready for review March 6, 2024 19:57
@andy-goryachev-oracle andy-goryachev-oracle marked this pull request as draft March 6, 2024 19:57
@openjdk
Copy link

openjdk bot commented Mar 13, 2024

@andy-goryachev-oracle 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:

8313138: Scrollbar Keyboard enhancement

Reviewed-by: arapte, kcr, 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 no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential 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.

@andy-goryachev-oracle andy-goryachev-oracle marked this pull request as ready for review March 26, 2024 17:29
@openjdk openjdk bot added the rfr Ready for review label Mar 26, 2024
@mlbridge
Copy link

mlbridge bot commented Mar 26, 2024

@kevinrushforth
Copy link
Member

Since this is a noticeable (end-user-visible) behavioral change, I think a CSR would be in order (it need not be very detailed).

We don't currently document keyboard shortcuts -- either for individual controls or for focus traversal -- although that would be a good doc enhancement (for a later time).

Reviewers: @arapte @azuev-java

/reviewers 2
/csr needed

@openjdk
Copy link

openjdk bot commented Mar 26, 2024

@kevinrushforth
The total number of required reviews for this PR (including the jcheck configuration and the last /reviewers command) is now set to 2 (with at least 1 Reviewer, 1 Author).

@openjdk openjdk bot added the csr Need approved CSR to integrate pull request label Mar 26, 2024
@openjdk
Copy link

openjdk bot commented Mar 26, 2024

@kevinrushforth has indicated that a compatibility and specification (CSR) request is needed for this pull request.

@andy-goryachev-oracle please create a CSR request for issue JDK-8313138 with the correct fix version. This pull request cannot be integrated until the CSR request is approved.

@andy-goryachev-oracle andy-goryachev-oracle marked this pull request as draft April 1, 2024 14:58
@openjdk openjdk bot removed the rfr Ready for review label Apr 1, 2024
@andy-goryachev-oracle andy-goryachev-oracle marked this pull request as ready for review April 1, 2024 19:23
@openjdk openjdk bot added the rfr Ready for review label Apr 1, 2024
@andy-goryachev-oracle
Copy link
Contributor Author

... but nothing should prevent the maintainers of ControlsFx from adding this functionality to the GridView.

@andy-goryachev-oracle
Copy link
Contributor Author

As @eduardsdv mentioned in
#1326 (comment)

and @kevinrushforth asked about earlier, perhaps we should add similar capability for vertical scrolling using alt-ctrl-Up/DOWN (option-command-UP/DOWN) in the same PR rather than separately.

@andy-goryachev-oracle andy-goryachev-oracle changed the title 8313138: Horizontal Scrollbar Keyboard enhancement 8313138: Scrollbar Keyboard enhancement May 6, 2024
@arapte
Copy link
Member

arapte commented May 13, 2024

Tested a few samples. It looks good.
I need sometime (a day or two) to complete code review.

Copy link
Member

@arapte arapte left a comment

Choose a reason for hiding this comment

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

LGTM...

@kevinrushforth
Copy link
Member

As a follow-up enhancement, we might consider extending this to TextArea and/or ScrollPane.

@kevinrushforth kevinrushforth requested review from kevinrushforth and removed request for azuev-java May 20, 2024 20:56
@openjdk openjdk bot removed the csr Need approved CSR to integrate pull request label May 20, 2024
Copy link
Member

@kevinrushforth kevinrushforth left a comment

Choose a reason for hiding this comment

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

Looks good. I left one comment (on a comment line) that applies to all 4 controls. I'll reapprove if you make the suggested change.

@openjdk openjdk bot added the ready Ready to be integrated label May 20, 2024
@openjdk openjdk bot removed the ready Ready to be integrated label May 20, 2024
@openjdk openjdk bot added the ready Ready to be integrated label May 21, 2024
@andy-goryachev-oracle
Copy link
Contributor Author

/integrate

@openjdk
Copy link

openjdk bot commented May 22, 2024

Going to push as commit b685db2.

@openjdk openjdk bot added the integrated Pull request has been integrated label May 22, 2024
@openjdk openjdk bot closed this May 22, 2024
@openjdk openjdk bot removed ready Ready to be integrated rfr Ready for review labels May 22, 2024
@openjdk
Copy link

openjdk bot commented May 22, 2024

@andy-goryachev-oracle Pushed as commit b685db2.

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

@andy-goryachev-oracle andy-goryachev-oracle deleted the 8313138.horizontal branch May 22, 2024 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrated Pull request has been integrated
6 participants