RFR: 8341670: [Text, TextFlow] Public API for Text Layout Info [v30]
Michael Strauß
mstrauss at openjdk.org
Thu May 22 21:53:01 UTC 2025
On Thu, 22 May 2025 19:00:19 GMT, Andy Goryachev <angorya at openjdk.org> wrote:
>> 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
>>
>>
>>
>>
>> ## 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 59 commits:
>
> - Merge remote-tracking branch 'origin/master' into ag.text.layout.api
> - cleanup
> - removed getStrikeThroughShape
> - caret geometry
> - review comments
> - Merge remote-tracking branch 'origin/master' into ag.text.layout.api
> - review comments
> - Merge remote-tracking branch 'origin/master' into ag.text.layout.api
> - sealed
> - indent
> - ... and 49 more: https://git.openjdk.org/jfx/compare/59c2b759...ab8bd9cb
modules/javafx.graphics/src/main/java/com/sun/javafx/text/PrismLayoutInfo.java line 74:
> 72: TextLine[] lines = layout.getLines();
> 73: Insets m = insets();
> 74: double dx = m.getLeft(); // TODO rtl?
This comment looks like it's a question to the reader. Does the code not work for RTL layouts?
-------------
PR Review Comment: https://git.openjdk.org/jfx/pull/1596#discussion_r2103443199
More information about the openjfx-dev
mailing list