Home

Welcome to the RichTextFX wiki!

For a comparison of other third-party rich text areas for JavaFX, see JavaFX Controls for Code Editing.

Understanding RichTextFX at Various Levels

If you are new to RichTextFX and want to get a better understanding of how it works, use the following guidelines:

• Shallowest understanding: Getting up to speed on how to use RichTextFX for simple applications
  • Read through these pages in the wiki.
    • Text Styles: Inline, Style Class, and Custom Style Objects
    • RichTextFX CSS Reference Guide
    • How to Override the Default Behavior
    • Known Issues
• Somewhat deeper understanding: Understanding some of the ins and outs of RichTextFX for more advanced applications.
  • Read through these pages in the wiki:
    • General guidelines
    • Core classes (somewhat out of date but gives big picture before reading javadoc below)
    • PS, S, and SEG: Explaining the main generics in RichTextFX
    • Implementing custom objects
    • Adding Support for Emojis
  • Read each package's javadoc and their See also tags, which link to the important/foundational classes upon which others are built or to which they refer, in the following order: org.fxmisc.richtext.model (the model), org.fxmisc.richtext (the view), org.fxmisc.richtext.events/util (miscellaneous things).
• Intermediate understanding: Understanding ReactFX and some of RichTextFX's dependencies
  • Read through a tutorial Jordan wrote for ReactFX that explains what EventStream and Val/Var are.
  • Check out all of RichTextFX's dependencies as that will help you understand how it works. Besides ReactFX, Flowless is the next important. UndoFX and WellBehavedFX can be studied only when necessary.
• Advanced understanding: Contributing to RichTextFX
  • Read the Test Automation page
  • Look through the tests in the integrationTest package to get an idea for the API and how to use TestFX well