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

[Kevin Rushforth]

On Tue, 3 Dec 2024 16:45:45 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:
> 
>   review comments

modules/jfx.incubator.input/src/main/java/jfx/incubator/scene/control/input/KeyBinding.java line 147:

> 145:      * @return the KeyBinding
> 146:      */
> 147:     public static KeyBinding ctrl(KeyCode code) {

We should spell out `control` in the public API methods and fields, matching `KeyCode`. It's fine to use "CTRL" as an abbreviation in the docs.

modules/jfx.incubator.input/src/main/java/jfx/incubator/scene/control/input/KeyBinding.java line 158:

> 156:      * @return the KeyBinding
> 157:      */
> 158:     public static KeyBinding ctrlShift(KeyCode code) {

`ctrlShift` -> `controlShift` for the name of the method.

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

PR Review Comment: https://git.openjdk.org/jfx/pull/1524#discussion_r1868253408
PR Review Comment: https://git.openjdk.org/jfx/pull/1524#discussion_r1868254382