This is an enhanced proposal to support custom objects which can be rendered by user specific nodes.

In the model layer, all occurrences of StyledTexthave been replaced by the new interface Segment. StyledTextis now just one flavor of segment types. CustomObjectis an abstract class which implements the Segmentinterface and which provides a base class for user defined objects. Out-of-the-box, RichTextFX would support images to be inserted into the document, but the user can define any other custom objects by registering a factory method for the JavaFX node and a decode method for deserializing the object through a Codec. See CustomObjectDemofor an example how to register and use custom objects.

The code already supports copy&paste (if the selection contains a custom object, it is serialized when copying). Selecting one single custom object by clicking on it is not supported yet.

Any feedback/comments are welcome - especially registering the decode method is very unclean yet, see the SegmentFactory class. Essentially, decoding must be delegated to the custom object implementation since only the custom object knows how to recreate itself from a DataInputStream, but the method in ReadOnlyStyledDocument which does the decoding is static which makes it difficult to access a delegate. I tried to make those methods non-static, but this looked like a huge bunch of refactoring is necessary then.

Hi!

I'm using this API for a project, and have added a CodeArea in a StackPane on top of a Canvas. I want to scroll the Canvas with the CodeArea. Is it possible to get the scroll position of the CodeArea to let me do this?

Thanks!

Hi Tomas, I could not find a way to assign a style at the caret location. Is there one? What is available now requires an range.

For example, user clicks, then assigns a style. Then whatever is written afterward will inherit the new style.

Since the current method requires a range, I currently get the caret position, then append a dummy white space (in case the caret is at the end), then use the position of the caret and increment by 1 (as a range) to assign style, then remove the white space.

Thanks, Maher

Tomas, I am using a CodeArea in a Dialog. When there is no vertical scrollbar the horizontal scrollbar does not work. I modified JavaKeywordsAsync to demonstrate this. See the attached txt file (it wouldn't let me add a .java file) ScrollBarTest.txt

Thanks, Mike

Coming from #417, it was proposed that we refactor the caret-related code into its own class. I've opened this issue to provide a place for discussing such a change's pros, cons, and implementation.

Is there anyway i can add code formatting support to codeArea? Similar to Alt+Shift+F format option in Netbeans And Ctrl+Shilft+F option in Eclipse. In this way i want to improve the representation of code in my code editor. :)

Below is what was originally in #583, but that thread got bloated with discussion on another topic. Thus, I'm reposting it here:

I've been talking to Tomas about this for a while. See the original thread here

Hi everyone,

since I don't work with JavaFX (or GUI applications, or that matter) anymore, it is hard for me to keep up with the maintenance of my JavaFX projects. I am therefore looking for new maintainers (and possibly new home) of my most active JavaFX project, RichTextFX ( https://github.com/TomasMikula/RichTextFX/), and its essential dependency, Flowless (https://github.com/TomasMikula/Flowless/).

I want to thank Jordan Martinez, who has been doing the bulk of fixing bugs and reviewing pull requests for the past two years.

I am hoping that either some bigger user of RichTextFX, or a UI framework for which RichTextFX would be an attractive addition to the portfolio, would step forward and take it up. Jordan and I are happy to help with the transfer.

Best regards, Tomas

I've been maintaining this (and other FXMisc projects) since Tomas stopped maintaining it (though I've contributed little in the past few months), but I've also decided to go a different route from here. Rather than continuing to use a JVM language and JavaFX to build my GUI program, I've decided to start using Purescript and Halogen instead.

Due to the influence of Tomas' FP-style of coding and further investigating and agreeing with the FP paradigm, I had hoped to use more FP constructs using Scala and Scalaz. In workings towards a (at least, what I now understand to be) React-like framework for JavaFX (see JavaFXFunctional's Design Goals) and realizing that Scala was not a good language for FP, I thought it would be easier to learn web technologies and use Halogen rather than port that framework to Scala, Scalaz and JavaFX. The idea of Progressive Web Apps replacing Native apps and The Birth and Death of Javascript have further influenced me in that regard.

As such, I will no longer be making any effort towards fixing bugs or responding to any questions regarding this project. Someone else will need to step up.

RFE implementation for #655 The methods in ViewActions related to the following have been @Deprecated:

onOutsideSelectionMousePress onInsideSelectionMousePress onNewSelectionDragEnd onSelectionDrop

They have been replaced with FXML friendly equivalent (non default) interface methods:

onOutsideSelectionMousePressed onInsideSelectionMousePressed onNewSelectionDragFinished onSelectionDropped

Which have been implemented in GenericStyledArea. The references to the deprecated methods in GenericStyledAreaBehavior have been changed to the new ones.

During this process it was found that the onNewSelectionDragEnd/Finished functionality hadn't been implemented in GenericStyledAreaBehavior and this was rectified as well.

I have tried the obvious:

styledTextArea.setPadding(new Insets(10, 10, 10, 10));

but it doesn't seem to work. What is the correct way to add padding between a StyledTextArea and the textual content that it displays?

I implemented the approach I described in #152 and for the most part it works. There are a few problems.

• If the user types in the original area quickly or if the user types even one character in the second line in the original area, the original area making the modification throws a StringIndexOutOfBoundsException.

To address #322, I reimplemented the solution in #402 by using more readable code via ChangeType, which was through lazy evaluation initially. This caused regressions, as discovered in #472, and was later evaluated immediately in #470 to help find these regressions. Besides simplifying the logic, I used ChangeType because I thought developers would be able to use it in their code to quickly determine what kind of change the change was. By doing this, I realize now that I was solving the first problem and indirectly trying to solve another problem (adding convenience methods to TextChange that allows one to quickly determine what kind of change it was).

And that is the issue: my solution to the second problem was not fully thought out because it was not the issue I was trying to solve. I didn't realize it then (but do realize it now because of the regressions, both known and yet unknown, that have appeared since 0.7-M3) that a RichTextChange can be a number of different changes (insertion, deletion, replacement, text style change, or a paragraph style change)--change tyes which ChangeType does not cover.

So I see two options for addressing this bug:

1. Refactor the code to always create a TextChange that can get exactly what kind of change type it is
2. Change the way the code knows that a TextChange is an insertion or deletion type of change and thus whether to merge it with another TextChange.

I'm against the former because it will be more invasive to the current API and using a TextChange does not always require knowing what kind of change it is. For example, sometimes one just needs to know how much to adjust the caret based on how much content was removed and inserted. I think the latter is best because it will immediately address all possible (known and currently unknown) regressions related to #458.

To still maintain code readability, I don't think we should just implement methods like TextChange#isInsertion and TextChange#isDeletion. Rather, I think ChangeType (which I think needs to be better named since it doesn't address all the changes a TextChange could be and since it pollutes the namespace that developers might want to use later in their own code) should be as follows:

// Enum needs a better name!
public class ChangeType {
    INSERTION,
    DELETION,
    NEITHER // indicates it is neither an insertion/deletion

And then the TextChange#mergeWith code would still read:

// this is either a insertion/deletion
if (this.getType() != ChangeType.NEITHER 
    // the two types match: both are insertion or both are deletion
    && this.getType() == that.getType()) { 
    // merge code
}

Unfortunately, I can't think of a better name to address the namespace pollution issue I raised above. Does anyone else have a better name?

However, #472 did show that sometimes RTFX is inefficient because it tries to make an empty replacement. I wonder if there are others areas that could be further optimized so that replace always replaces something and ignores calls that ultimately do nothing. For example, ignoring "style change" calls that don't actually restyle the content because that content already has that style.

Hello i am using for many many years this library to my big JavaFX project XR3Player

XR3Player is running on Java 19 .

Today updating from 0.10.9 to 0.11.0 i am having errors ? Do i need to add something extra to module-info.java after updating to version 0.11.0 ? I had no problem with 0.10.9 .

@Jugen :)

I just want to implement code folding just like other ide-s : intellij, eclipse, netbeans. I reviewed java keyboard sample. The folding is controlled from context menu. I want indicate fold unfold icon on the line indicator? How to do it with codearea? Can you give me some code hints? Thank you.

I listener caretPositionProperty and print CaretBounds, but i found when caret change line, the bounds minY is always -1. How can i get right bounds?

Expected Behavior

The chosen color (hsb(0, 0, 1, 0.1)) should be used.

Actual Behavior

The default color (yellow) is used.

Demo

1th line, 3 lines total.

1th line, 1 lines total.

Environment info:

• RichTextFX Version: 0.10.9
• Operating System: Linux
• Java version: 17

RichTextFX is also used for building terminal emulator applications. At the same time, currently it is not possible to style caret to look like in terminals. This problem was also discussed in https://github.com/FXMisc/RichTextFX/issues/397 , but later the issue was closed without resolving.

I suggest to support the following caret features:

1. width
2. height
3. shape
4. color
5. inverse color (for example, the color of the letter that the caret is on)
6. caret position (it is necessary to set caret over letter)

This is java code:

public class JavaFxTest2 extends Application {

    private final InlineCssTextArea textArea = new InlineCssTextArea();

    private final VirtualizedScrollPane scrollPane = new VirtualizedScrollPane(textArea);

    public static void main(String[] args) {
        launch(args);
    }

    @Override
    public void start(Stage primaryStage) {
        textArea.setWrapText(true);
        textArea.setEditable(true);
        textArea.setParagraphGraphicFactory(LineNumberFactory.get(textArea));
        textArea.setPadding(new Insets(0, 0, 0, 0));
        var ss = "Some text here";
        VBox.setVgrow(scrollPane, Priority.ALWAYS);
        VBox root = new VBox();

        root.getChildren().addAll(scrollPane, new TextField());
        textArea.setWrapText(true);
        var css = this.getClass().getResource("console.css").toExternalForm();
        var scene = new Scene(root, 450, 450);
        scene.getStylesheets().add(css);
        primaryStage.setScene(scene);
        primaryStage.show();
        textArea.appendText(ss);
    }
}

This is css:

.root {
    -fx-font-size: 20;
}

.styled-text-area .caret {
    -rtfx-blink-rate: 5000ms;
    -fx-stroke-width: 10.0;
}

Caret seems to blink with the same rate, and with one pixel width. Is this correct behavior?