JavaFX 27 · jfx.incubator.scene.control.richtext.model

Provides common models for RichTextArea and CodeArea controls.

The RichTextArea control separates data model from the view by providing the model property. The base class for any data model is StyledTextModel. This abstract class provides no data storage, focusing instead on providing common functionality to the actual models, such as dealing with styled segments, keeping track of markers, sending events, etc.

This package provides a number of standard models are provided, each designed for a specific use case.

The RichTextModel stores the data in memory, in the form of text segments styled with attributes defined in StyleAttributeMap class. This is a default model for RichTextArea.
The BasicTextModel could be used as a base class for in-memory or virtualized text models based on plain text. This class provides foundation for the CodeTextModel, which supports styling using a pluggable SyntaxDecorator.
The abstract StyledTextModelViewOnlyBase is a base class for immutable models. This class is used by SimpleViewOnlyStyledModel which simplifies building of in-memory view-only styled documents.

Incubating Feature. Will be removed in a future release.

Modifier and Type	Interface and Description
public interface	StyledInput This interface represents a source of styled text segments for the purposes of pasting, importing, or loading from an input stream.
public interface	StyledOutput Class represents a consumer of styled text segments for the purposes of exporting, copying, or saving to an output stream.

Class Summary

Modifier and Type	Class and Description
public class	BasicTextModel A StyledTextModel based on plain text paragraphs.
public class	CodeTextModel Editable plain text model with optional syntax highlighting for use with the `CodeArea` control.
public abstract class	ContentChange Contains information about `StyledTextModel` content change.
public abstract class	DataFormatHandler Facilitates import/export of styled text into/from a StyledTextModel.
public class	EmbeddedImage An attribute which allows an image to be embedded into the `RichTextModel`.
public class	FileListFormatHandler Facilitates importing of file lists into the RichTextModel.
public class	HtmlExportFormatHandler This partial `DataFormatHandler` supports export of styled text in a simple HTML format.
public class	PlainTextFormatHandler `DataFormatHandler` which operates with plain text.
public abstract class	RichParagraph Represents a single immutable paragraph within the `StyledModel`.
public class	RichTextFormatHandler A DataFormatHandler for use with attribute-based rich text models.
public class	RichTextModel Editable, in-memory `StyledTextModel` based on a collection of styled segments.
public class	RtfFormatHandler This `DataFormatHandler` provides export/import support for RTF format.
public class	SimpleViewOnlyStyledModel A simple, view-only, in-memory, styled text model.
public abstract class	StyleAttribute< the attribute value type T> Style Attribute provides a way to specify style in the RichTextArea.
public class	StyleAttributeMap This immutable object contains a map of `StyleAttribute`s.
public abstract class	StyledSegment Data structure used to modify the styled text model.
public abstract class	StyledTextModel The base class for styled text models used by the `RichTextArea`.
public abstract class	StyledTextModelViewOnlyBase The base class for view-only `StyledTextModel`s.
public class	TabStops Encapsulates the tab stop positions within a paragraph, in the form of an unmodifiable `List`.

Package jfx.incubator.scene.control.richtext.model

Interface Summary

Class Summary

Enum Summary