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

[Ambarish Rapte]

On Fri, 22 Nov 2024 18:07:14 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:
> 
>   whitespace

Providing a few more comments, I still have to take a look at rtf charset and util files. Shall review those in a day or 2.

modules/jfx.incubator.input/src/main/java/jfx/incubator/scene/control/input/InputMap.java line 48:

> 46: /**
> 47:  * InputMap is a property of the {@link Control} class which enables customization
> 48:  * by allowing for custom key mappings and event handlers.

suggestion: minor rephrase: `by allowing for custom` -> `by allowing creation of custom`

modules/jfx.incubator.input/src/main/java/jfx/incubator/scene/control/input/InputMap.java line 50:

> 48:  * by allowing for custom key mappings and event handlers.
> 49:  * <p>
> 50:  * The {@code InputMap} serves as an integration point between the Control and its Skin.

suggestion: `an integration point` -> `a bridge`

modules/jfx.incubator.input/src/main/java/jfx/incubator/scene/control/input/InputMap.java line 51:

> 49:  * <p>
> 50:  * The {@code InputMap} serves as an integration point between the Control and its Skin.
> 51:  * The {@code InputMap} The InputMap provides an ordered repository of event handlers,

Minor typo: `The {@code InputMap} The InputMap` -> `The InputMap` or `The {@code InputMap}`

modules/jfx.incubator.input/src/main/java/jfx/incubator/scene/control/input/InputMap.java line 53:

> 51:  * The {@code InputMap} The InputMap provides an ordered repository of event handlers,
> 52:  * working together with the input map managed by the skin, which
> 53:  * guarantees the order in which handers are invoked.

minor typo: handers -> handlers

modules/jfx.incubator.input/src/main/java/jfx/incubator/scene/control/input/InputMap.java line 64:

> 62:  * <li>map a new function to an existing key binding
> 63:  * <li>obtain the default function
> 64:  * <li>ensure that the application key mappings take priority over mappings created by the skin

Minor rewording, Uppercase letter at first word

 * <li>Mapping a key binding to a function
 * <li>Removing a key binding
 * <li>Mapping a new function to an existing key binding
 * <li>Retrieving the default function
 * <li>Ensuring that the application key mappings take priority over mappings created by the skin

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

PR Review: https://git.openjdk.org/jfx/pull/1524#pullrequestreview-2465004534
PR Review Comment: https://git.openjdk.org/jfx/pull/1524#discussion_r1860701305
PR Review Comment: https://git.openjdk.org/jfx/pull/1524#discussion_r1860704123
PR Review Comment: https://git.openjdk.org/jfx/pull/1524#discussion_r1860648588
PR Review Comment: https://git.openjdk.org/jfx/pull/1524#discussion_r1860651768
PR Review Comment: https://git.openjdk.org/jfx/pull/1524#discussion_r1860716036