RFR: 8341670: [Text, TextFlow] Public API for Text Layout Info [v22]
Andy Goryachev
angorya at openjdk.org
Wed Mar 26 14:33:37 UTC 2025
> Please refer to
>
> https://github.com/andy-goryachev-oracle/Test/blob/main/doc/Text/LayoutInfo.md
>
> The RichTextArea control ([JDK-8301121](https://bugs.openjdk.org/browse/JDK-8301121)), or any custom control that needs non-trivial navigation within complex or wrapped text needs a public API to get information about text layout.
>
> This change fixes the missing functionality by adding a new public method to the `Text` and `TextFlow` classes.:
>
>
> /**
> * Obtains the snapshot of the current text layout information.
> * @return the layout information
> * @since 25
> */
> public final LayoutInfo getLayoutInfo()
>
>
> The `LayoutInfo` provides a view into the text layout within `Text`/`TextFlow` nodes such as:
>
> - caret information
> - text lines: offsets and bounds
> - overall layout bounds
> - text selection geometry
> - strike-through geometry
> - underline geometry
>
>
> This PR also adds the missing `strikeThroughShape()` method to complement the existing `underlineShape()` and `rangeShape()` for consistency sake:
>
>
> /**
> * Returns the shape for the strike-through in local coordinates.
> *
> * @param start the beginning character index for the range
> * @param end the end character index (non-inclusive) for the range
> * @return an array of {@code PathElement} which can be used to create a {@code Shape}
> * @since 25
> */
> public final PathElement[] strikeThroughShape(int start, int end)
>
>
>
>
> ## WARNING
>
> Presently, information obtained via certain Text/TextField methods is incorrect with non-zero padding and borders, see [JDK-8341438](https://bugs.openjdk.org/browse/JDK-8341438).
>
> This PR provides correct answers in the new API, leaving the behavior of the existing methods unchanged (there is a compatibility risk associated with trying to fix [JDK-8341438](https://bugs.openjdk.org/browse/JDK-8341438) ).
>
>
>
> ## Testing
>
> The new APIs can be visually tested using the Monkey Tester on this branch:
> https://github.com/andy-goryachev-oracle/MonkeyTest/tree/text.layout.api
>
> in the Text and TextFlow pages:
> 
>
> Two very basic headful tests have been added.
>
>
> ## See Also
>
> https://github.com/FXMisc/RichTextFX/pull/1246
Andy Goryachev has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains 47 commits:
- Merge remote-tracking branch 'origin/master' into ag.text.layout.api
- twice
- tests
- review comments
- Merge remote-tracking branch 'origin/master' into ag.text.layout.api
- Merge remote-tracking branch 'origin/master' into ag.text.layout.api
- review comments
- Merge remote-tracking branch 'origin/master' into ag.text.layout.api
- 25 25
- Merge branch 'master' into ag.text.layout.api
- ... and 37 more: https://git.openjdk.org/jfx/compare/91433775...9cee2dc7
-------------
Changes: https://git.openjdk.org/jfx/pull/1596/files
Webrev: https://webrevs.openjdk.org/?repo=jfx&pr=1596&range=21
Stats: 1538 lines in 13 files changed: 1476 ins; 18 del; 44 mod
Patch: https://git.openjdk.org/jfx/pull/1596.diff
Fetch: git fetch https://git.openjdk.org/jfx.git pull/1596/head:pull/1596
PR: https://git.openjdk.org/jfx/pull/1596
More information about the openjfx-dev
mailing list