8137323: Incorrect parsing of mnemonic in controls text

[mstr2]

This PR fixes incorrect parsing of mnemonic symbols in the following cases:

1. an escaped double underscore incorrectly shows up as a double underscore in displayed text
2. an extended mnemonic incorrectly removes a part of adjacent text

As a side effect, this PR also fixes another undocumented issue for multiline text where text metrics calculations incorrectly operate on text for which mnemonic symbols have not been processed.

This can lead to a glitch where the mnemonic underscore makes a text just long enough to wrap to a new line, but when the text is rendered, the second line shows up entirely empty. The reason for this is that for rendering, the text is laid out after mnemonic symbols have been removed.

The solution is to always use processed text ("clean text") when laying out text.

---

Progress

• Change must not contain extraneous whitespace
• Commit message must refer to an issue
• Change must be properly reviewed

Issue

• JDK-8137323: Incorrect parsing of mnemonic in controls text

Reviewers

• Ajit Ghaisas (@aghaisas - Reviewer)
• Kevin Rushforth (@kevinrushforth - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jfx pull/453/head:pull/453
$ git checkout pull/453

Update a local copy of the PR:
$ git checkout pull/453
$ git pull https://git.openjdk.java.net/jfx pull/453/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 453

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jfx/pull/453.diff

[bridgekeeper]

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

[mlbridge]

Webrevs

• 00: Full (d91d81a0)

[kevinrushforth]

/reviewers 2

[openjdk]

@kevinrushforth
The number of required reviews for this PR is now set to 2 (with at least 1 of role reviewers).

[aghaisas]

Nice to see the broken behavior being fixed.

Along with the supplied unit tests, I have verified that the fix does not break tests/manual/UI/ButtonMnemonicPositionTest.java as well.

[kevinrushforth]

This looks good to me, although I have never used extended mnemonics, so don't know how to test them. The rest is fine (and the visual display of the extended mnemonics is fine as long as elided the parenthesized char is the right thing to do). I also verified that the new tests fail without the fix and pass with the fix.

[kevinrushforth]

Since extended mnemonics don't seem to work either before or after your fix -- meaning you can't use the extended mnemonic character to select the button or action -- we can treat that as a separate issue.

So this fix looks good to me.

[openjdk]

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

8137323: Incorrect parsing of mnemonic in controls text

Reviewed-by: aghaisas, kcr

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

• e3e5116: 8265400: Update to gcc 10.3 on Linux
• ccf51e4: 8265206: Tree-/TableCell: editing state not updated on cell re-use
• 0a68613: 8264737: JavaFX media stream stops playing after reconnecting via Remote Desktop
• cc70cdf: 8258777: SkinBase: add api to un-/register invalidation-/listChange listeners
• 33bbf3f: 8263402: MemoryLeak: Node hardreferences it's previous Parent after csslayout and getting removed from the scene
• 483f171: 8264677: MemoryLeak: Progressindicator leaks, when treeShowing is false
• 6b63bf5: 8265669: AccumCell should not be visible
• ed080c8: 8262276: Debug build of WebKit fails
• db30e71: 8265513: Openjfx graphics build broken (Eclipse)
• b50ce94: 8264952: [TestBug] Controls unit tests - ControlTest and SpinnerTest fail for non US Locale
• ... and 35 more: https://git.openjdk.java.net/jfx/compare/e23a2feb8919285825993251b42acaaa13a41eb0...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 (@aghaisas, @kevinrushforth) 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).

[mstr2]

/integrate

[openjdk]

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

[kevinrushforth]

/sponsor

[openjdk]

@kevinrushforth @mstr2 Since your change was applied there have been 45 commits pushed to the master branch:

• e3e5116: 8265400: Update to gcc 10.3 on Linux
• ccf51e4: 8265206: Tree-/TableCell: editing state not updated on cell re-use
• 0a68613: 8264737: JavaFX media stream stops playing after reconnecting via Remote Desktop
• cc70cdf: 8258777: SkinBase: add api to un-/register invalidation-/listChange listeners
• 33bbf3f: 8263402: MemoryLeak: Node hardreferences it's previous Parent after csslayout and getting removed from the scene
• 483f171: 8264677: MemoryLeak: Progressindicator leaks, when treeShowing is false
• 6b63bf5: 8265669: AccumCell should not be visible
• ed080c8: 8262276: Debug build of WebKit fails
• db30e71: 8265513: Openjfx graphics build broken (Eclipse)
• b50ce94: 8264952: [TestBug] Controls unit tests - ControlTest and SpinnerTest fail for non US Locale
• ... and 35 more: https://git.openjdk.java.net/jfx/compare/e23a2feb8919285825993251b42acaaa13a41eb0...master

Your commit was automatically rebased without conflicts.

Pushed as commit affb108.

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