RichTextFX

RichTextFX provides a memory-efficient text area for JavaFX that allows the developer to style ranges of text, display custom objects in-line (no more HTMLEditor), and override the default behavior only where necessary without overriding any other part of the behavior.

It does not follow the MVC paradigm as this prevented access to view-specific API (e.g., getting the bounds of the caret/selection/characters, scrolling by some amount, etc.).

It is intended as a base for rich-text editors and code editors with syntax highlighting. Since it is a base, a number of suggested features (specific syntax highlighters, search-and-replace, specific support for hyperlinks, etc.) will not be implemented directly in this project. Rather, developers can implement these on top of RichTextFX and submit their work as a PR to the richtextfx-demos package.

For a greater explanation of RichTextFX, its design principles, how it works, and how to style its areas via CSS, please see the wiki

Who uses RichTextFX?
Features
Flavors
- GenericStyledArea (Base area class requiring customization)
- StyledTextArea (Areas ready out-of-box)
  - InlineCssTextArea
  - StyleClassedTextArea
    - CodeArea (Base for code editors)
Requirements
Demos
Download
API Documentation (Javadoc)
- 0.6.10
- 0.7-M5
License
Contributing

Who uses RichTextFX?

Kappa IDE
Squirrel SQL client (its JavaFX version)
mqtt-spy
Alt.Text
Xanthic
Arduino Harp
Markdown Writer FX
OmniEditor, which is then used by Chronos IDE
JuliarFuture
BlueJ

If you use RichTextFX in an interesting project, I would like to know!

Features

Assign arbitrary styles to arbitrary ranges of text. A style can be an object, a CSS string, or a style class string.
Display line numbers or, more generally, any graphic in front of each paragraph. Can be used to show breakpoint toggles on each line of code.
Support for displaying other Nodes in-line
Positioning a popup window relative to the caret or selection. Useful e.g. to position an autocompletion box.
Getting the character index under the mouse when the mouse stays still over the text for a specified period of time. Useful for displaying tooltips depending on the word under the mouse.
Overriding the default behavior only where necessary without overriding any other part.

Flavors

The following explains the different rich text area classes. The first one is the base class from which all others extend: it needs further customization before it can be used but provides all aspects of the project's features. The later ones extend this base class in various ways to provide out-of-box functionality for specific use cases. Most will use one of these subclasses.

GenericStyledArea

GenericStyledArea allows one to inline custom objects into the area alongside of text. As such, it uses generics and functional programming to accomplish this task in a completely type-safe way.

It has three parameter types:

PS, the paragraph style. This can be used for text alignment or setting the background color for the entire paragraph. A paragraph is either one line when text wrap is off or a long text displayed over multiple lines in a narrow viewport when text wrap is on,
SEG, the segment object. This specifies what immutable object to store in the model part of the area: text, hyperlinks, images, emojis, or any combination thereof.
S, the segment style. This can be used for text and object styling. Usually, this will be a CSS style or CSS style class.

Functional programming via lambdas specify how to apply styles, how to create a Node for a given segment, and how to operate on a given segment (e.g., getting its length, combining it with another segment, etc.).

GenericStyledArea is used in the Rich-text demo below.

See the wiki for a basic pattern that one must follow to implement custom objects correctly.

StyledTextArea

StyledTextArea<PS, S>, or one of its subclasses below, is the area you will most likely use if you don't need to display custom objects in your area.

It extends GenericStyledArea<PS, StyledText<S>, S>>. StyledText is simply a text (String) and a style object (S). A slightly-enhanced JavaFX Text node is used to display the StyledText<S>, so you can style it using its CSS properties and additional RichTextFX-specific CSS (see the wiki for more details).

It properly handles the aforementioned functional programming to properly display and operate on StyledText<S> objects.

The style object (S) can either be a CSS String (-fx-fill: red;), a CSS styleclass (.red { -fx-fill: red; }), or an object that handles this in a different way. Since most will use either the CSS String or CSS style class approach, there are two subclasses that already handle this correctly.

InlineCssTextArea

InlineCssTextArea uses the Node#setStyle(String cssStyle) method to style Text objects:

area.setStyle(from, to, "-fx-font-weight: bold;");

StyleClassedTextArea

StyleClassedTextArea uses the Node#setStyleClass(String styleClass) method to style Text` objects. You can define the style classes in your stylesheet.

example.css:

.red { -fx-fill: red; }

Example.java:

area.setStyleClass(from, to, "red");

This renders the text in the range [from, to) in red.

CodeArea

CodeArea is a variant of StyleClassedTextArea that uses a fixed width font by default, making it a convenient base for source code editors. CodeArea is used in the Java Keywords demo below.

Requirements

JDK8 is required, because TextFlow, introduced in JavaFX 8.0, is used to render each line. Also, there's a heavy use of lambdas, defender methods and the stream API in the code base.

JDK 8u40 is recommended, because it fixes some text rendering bugs.

Demos

Automatic highlighting of Java keywords

Run using the pre-built JAR

Download the pre-built "fat" JAR file and run

java -cp richtextfx-demos-fat-0.7-M5.jar org.fxmisc.richtext.demo.JavaKeywords

or

java -cp richtextfx-demos-fat-0.7-M5.jar org.fxmisc.richtext.demo.JavaKeywordsAsync

Run from the source repo

gradle JavaKeywords

or

gradle JavaKeywordsAsync

Source code

JavaKeywords.java

JavaKeywordsAsync.java

The former computes highlighting on the JavaFX application thread, while the latter computes highlighting on a background thread.

XML Editor

Similar to the Java Keywords demo above, this demo highlights XML syntax. Courtesy of @cemartins.

Run using the pre-built JAR

Download the pre-built "fat" JAR file and run

java -cp richtextfx-demos-fat-0.7-M5.jar org.fxmisc.richtext.demo.XMLEditor

Run from the source repo

gradle XMLEditor

Source code

XMLEditor.java

Rich-text editor

Run using the pre-built JAR

Download the pre-built "fat" JAR file and run

java -cp richtextfx-demos-fat-0.7-M5.jar org.fxmisc.richtext.demo.richtext.RichText

Run from the source repo

gradle RichText

Source code

RichText.java

Custom tooltips

When the mouse pauses over the text area, you can get index of the character under the mouse. This allows you to implement, for example, custom tooltips whose content depends on the text under the mouse.

Run using the pre-built JAR

Download the pre-built "fat" JAR file and run

java -cp richtextfx-demos-fat-0.7-M5.jar org.fxmisc.richtext.demo.TooltipDemo

Run from the source repo

gradle TooltipDemo

Source code

TooltipDemo.java

Download

Stable release

Current stable release is 0.6.10. (We encourage you to try 0.7 milestone release below.)

Maven coordinates

Group ID	Artifact ID	Version
org.fxmisc.richtext	richtextfx	0.6.10

Gradle example

dependencies {
    compile group: 'org.fxmisc.richtext', name: 'richtextfx', version: '0.6.10'
}

Sbt example

libraryDependencies += "org.fxmisc.richtext" % "richtextfx" % "0.6.10"

Manual download

Download the JAR file or the fat JAR file (including dependencies) and place it on your classpath.

Milestone release

Milestone version of the upcoming release is 0.7-M5.

Maven coordinates

Group ID	Artifact ID	Version
org.fxmisc.richtext	richtextfx	0.7-M5

Gradle example

dependencies {
    compile group: 'org.fxmisc.richtext', name: 'richtextfx', version: '0.7-M5'
}

Sbt example

libraryDependencies += "org.fxmisc.richtext" % "richtextfx" % "0.7-M5"

Manual download

Download the JAR file or the fat JAR file (including dependencies) and place it on your classpath.

Snapshot releases

Snapshot releases are deployed to Sonatype snapshot repository.

Maven coordinates

Group ID	Artifact ID	Version
org.fxmisc.richtext	richtextfx	1.0.0-SNAPSHOT

Gradle example

repositories {
    maven {
        url 'https://oss.sonatype.org/content/repositories/snapshots/'
    }
}

dependencies {
    compile group: 'org.fxmisc.richtext', name: 'richtextfx', version: '1.0.0-SNAPSHOT'
}

Sbt example

resolvers += "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots"

libraryDependencies += "org.fxmisc.richtext" % "richtextfx" % "1.0.0-SNAPSHOT"

Custom Via Jitpack

In the following examples, the version is either a commit (via its short hash) or a tag. See Jitpack's documentation for more options and further instructions.

Maven

Add the repository

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

Add the dependency

<dependency>
    <groupId>com.github.TomasMikula</groupId>
    <artifactId>RichTextFX</artifactId>
    <version>commitOrTag</version>
</dependency>

Gradle example

repositories {
    maven {
        url 'https://jitpack.io'
    }
}

dependencies {
    compile "com.github.TomasMikula:RichTextFX:commitOrTag"
}

Sbt example

resolvers += "jitpack" at "https://jitpack.io"

libraryDependencies += "com.github.TomasMikula" % "RichTextFX" % "commitOrTag"

License

Dual-licensed under BSD 2-Clause License and GPLv2 with the Classpath Exception.

Files

README.md

Latest commit

History

README.md

File metadata and controls

RichTextFX

Who uses RichTextFX?

Features

Flavors

GenericStyledArea

StyledTextArea

InlineCssTextArea

StyleClassedTextArea

CodeArea

Requirements

Demos

Automatic highlighting of Java keywords

Run using the pre-built JAR

Run from the source repo

Source code

XML Editor

Run using the pre-built JAR

Run from the source repo

Source code

Rich-text editor

Run using the pre-built JAR

Run from the source repo

Source code

Custom tooltips

Run using the pre-built JAR

Run from the source repo

Source code

Download

Stable release

Maven coordinates

Gradle example

Sbt example

Manual download

Milestone release

Maven coordinates

Gradle example

Sbt example

Manual download

Snapshot releases

Maven coordinates

Gradle example

Sbt example

Custom Via Jitpack

Maven

Gradle example

Sbt example

License