RFR: 8301121: RichTextArea Control (Incubator) [v28]

[Ajit Ghaisas]

On Mon, 21 Oct 2024 18:53:20 GMT, Andy Goryachev <angorya at openjdk.org> wrote:

>> Incubating a new feature - rich text control, **RichTextArea**, intended to bridge the functional gap with Swing and its StyledEditorKit/JEditorPane. The main design goal is to provide a control that is complete enough to be useful out-of-the box, as well as open to extension by the application developers.
>> 
>> This is a complex feature with a large API surface that would be nearly impossible to get right the first time, even after an extensive review. We are, therefore, introducing this in an incubating module, **jfx.incubator.richtext**. This will allow us to evolve the API in future releases without the strict compatibility constraints that other JavaFX modules have.
>> 
>> Please check out two manual test applications - one for RichTextArea (**RichTextAreaDemoApp**) and one for the CodeArea (**CodeAreaDemoApp**). Also, a small example provides a standalone rich text editor, see **RichEditorDemoApp**.
>> 
>> Because it's an incubating module, please focus on the public APIs rather than implementation.  There **will be** changes to the implementation once/if the module is promoted to the core by popular demand.  The goal of the incubator is to let the app developers try the new feature out. 
>> 
>> **References**
>> 
>> - Proposal: https://github.com/andy-goryachev-oracle/Test/blob/main/doc/RichTextArea/RichTextArea.md
>> - Discussion points: https://github.com/andy-goryachev-oracle/Test/blob/main/doc/RichTextArea/RichTextAreaDiscussion.md
>> - API specification (javadoc): https://cr.openjdk.org/~angorya/RichTextArea/javadoc
>> - RichTextArea RFE: https://bugs.openjdk.org/browse/JDK-8301121
>> - Behavior doc: https://github.com/andy-goryachev-oracle/jfx/blob/8301121.RichTextArea/doc-files/behavior/RichTextAreaBehavior.md
>> - CSS Reference: https://cr.openjdk.org/~angorya/RichTextArea/javadoc/javafx.graphics/javafx/scene/doc-files/cssref.html
>> - InputMap (v3): https://github.com/andy-goryachev-oracle/Test/blob/main/doc/InputMap/InputMapV3.md
>> - Previous Draft PR: https://github.com/openjdk/jfx/pull/1374
>
> Andy Goryachev has updated the pull request incrementally with one additional commit since the last revision:
> 
>   break iterator

modules/jfx.incubator.richtext/src/main/java/com/sun/jfx/incubator/scene/control/richtext/CachingStyleResolver.java line 35:

> 33: 
> 34: /**
> 35:  * Caching StyleResolver caches conversion results to avoid re-querying for the same information.

`caches conversion results` looks like incomplete info.
Can add `caches CSSStyle to StyleAttribute conversion results`

modules/jfx.incubator.richtext/src/main/java/com/sun/jfx/incubator/scene/control/richtext/CellArrangement.java line 262:

> 260:         int sz = cells.size();
> 261:         if (sz == 0) {
> 262:             return 20;

Does this 20 need to scale on different uiScales?
Also - can we have this constant declared somewhere?

modules/jfx.incubator.richtext/src/main/java/com/sun/jfx/incubator/scene/control/richtext/HighlightShape.java line 53:

> 51:         HIGHLIGHT,
> 52:         SQUIGGLY,
> 53:     }

Is UNDERLINE missed? List in the documentation has underline as a type of highlight.

modules/jfx.incubator.richtext/src/main/java/com/sun/jfx/incubator/scene/control/richtext/HighlightShape.java line 72:

> 70:             PathElement[] pe = f.underlineShape(start, end);
> 71:             return generateSquiggly(pe);
> 72:         default:

case UNDERLINE also should be added to default:?

modules/jfx.incubator.richtext/src/main/java/com/sun/jfx/incubator/scene/control/richtext/RTAccessibilityHelper.java line 51:

> 49:     }
> 50: 
> 51:     // FIX remove

To be removed?

-------------

PR Review Comment: https://git.openjdk.org/jfx/pull/1524#discussion_r1812559932
PR Review Comment: https://git.openjdk.org/jfx/pull/1524#discussion_r1812563874
PR Review Comment: https://git.openjdk.org/jfx/pull/1524#discussion_r1812344317
PR Review Comment: https://git.openjdk.org/jfx/pull/1524#discussion_r1812345472
PR Review Comment: https://git.openjdk.org/jfx/pull/1524#discussion_r1812400967