RichTextFX 0.11.5 · org.fxmisc.richtext · APIdia, the JavaDoc alternative

Defines the view-related classes for rendering and editing an EditableStyledDocument.

The base area is org.fxmisc.richtext.GenericStyledArea. Those unfamiliar with this project should read through its javadoc. This class should be used for custom segments (e.g. text and images in the same area). org.fxmisc.richtext.StyledTextArea uses java.lang.String-only segments, and styling them are already supported in the two most common ways via org.fxmisc.richtext.StyleClassedTextArea and org.fxmisc.richtext.InlineCssTextArea. For those looking to use a base for a code editor, see org.fxmisc.richtext.CodeArea.

For text fields there is org.fxmisc.richtext.StyledTextField using java.lang.String-only segments, and styling them are also already supported in the two most common ways via org.fxmisc.richtext.StyleClassedTextField and org.fxmisc.richtext.InlineCssTextField.

Interface Summary

Modifier and Type	Interface and Description
public interface	Caret An object for encapsulating a caret in a given area.
public interface	CaretSelectionBind< type for `StyledDocument`'s paragraph style; only necessary when using the "selectedDocument" getter or property PS, type for `StyledDocument`'s segment type; only necessary when using the "selectedDocument" getter or property SEG, type for `StyledDocument`'s segment style; only necessary when using the "selectedDocument" getter or property S> An object for encapsulating a caret and a selection in a given area where the caret and selection are bound to one another.
public interface	ClipboardActions<PS, SEG, S> Clipboard actions for `TextEditingArea`.
public interface	EditActions<PS, SEG, S> Specifies actions for editing the content of a `TextEditingArea`.
public interface	NavigationActions<PS, SEG, S> Specifies actions for moving the caret and/or making a selection for a `TextEditingArea`.
public interface	Selection< type for `StyledDocument`'s paragraph style; only necessary when using the "selectedDocument" getter or property PS, type for `StyledDocument`'s segment type; only necessary when using the "selectedDocument" getter or property SEG, type for `StyledDocument`'s segment style; only necessary when using the "selectedDocument" getter or property S> An object for encapsulating a selection in a given area.
public interface	StyleActions< the paragraph style PS, the segment's style S> Specifies actions related to getting and setting styles throughout a `TextEditingArea`.
public interface	TextEditingArea<PS, SEG, type of style that can be applied to text. S> Interface for a text editing control.
public interface	UndoActions Undo/redo actions for `TextEditingArea`.
public interface	ViewActions< paragraph style type PS, segment type SEG, segment style type S> Specifies view-related API for a `TextEditingArea`

Class Summary

Modifier and Type	Class and Description
public class	BackgroundPath A path which describes a background shape in the Scene graph.
public class	BorderPath A path which describes a border in the Scene graph.
public class	CaretNode Default implementation for a `Caret`.
pack-priv class	CaretSelectionBindImpl<PS, SEG, S>
public class	CharacterHit Object that stores information relating to the position in an area's content that corresponds to a given position in some visible entity (e.g. the area, a paragraph in the area, a line on a paragraph).
pack-priv class	ClipboardHelper
public class	CodeArea A convenience subclass of `StyleClassedTextArea` with fixed-width font and an undo manager that observes only plain text changes (not styled changes).
public class	CustomCssMetaData<S extends Styleable, V> Reduces boilerplate when creating a custom `CssMetaData` object
public class	CustomStyleableProperty<T> Reduces the boilerplate when creating a custom CSS property (i.e. `javafx.css.StyleableProperty`).
public class	GenericStyledArea< type of style that can be applied to paragraphs (e.g. `TextFlow`. PS, type of segment used in `Paragraph`. Can be only text (plain or styled) or a type that combines text and other `Node`s. SEG, type of style that can be applied to a segment. S> Text editing control that renders and edits a `EditableStyledDocument`.
pack-priv class	GenericStyledAreaBehavior Controller for GenericStyledArea.
public class	InlineCssTextArea Text area that uses inline css to define style of text segments and paragraphs.
public class	InlineCssTextField A TextField that uses inline CSS, i.e. `setStyle(String)`, to define the styles of text segments.
public class	LineNumberFactory<PS> Graphic factory that produces labels containing line numbers and a "+" to indicate folded paragraphs.
pack-priv class	LineSelection<PS, SEG, S>
public class	MultiChangeBuilder<PS, SEG, S> Constructs a list of `Replacement`s that are used to update an `org.fxmisc.richtext.model.EditableStyledDocument` in one call via `commit()`.
pack-priv class	ParagraphBox< paragraph style type PS, segment type SEG, segment style type S> Node responsible for rendering a single paragraph in the viewport, which may include a paragraph graphic factory (an `IntFunction` that takes the paragraph's index as an argument and returns a node), and definitely includes the segments of the paragraph itself.
pack-priv class	ParagraphText< paragraph style type PS, segment type SEG, segment style type S> The class responsible for rendering the segments in an paragraph.
public class	SelectionImpl<PS, SEG, S> Default implementation for `Selection`.
public class	SelectionPath A Path used to render a portion of a mulit-paragraph selection or all of a single-paragraph selection with additional CSS styling; it does not have a style class associated with it.
public class	StyleClassedTextArea Text area that uses style classes to define style of text segments and paragraph segments.
public class	StyleClassedTextField A TextField that uses style classes, i.e. `getStyleClass().add(String)`, to define the styles of text segments.
public class	StyledTextArea< type of paragraph style PS, type of style that can be applied to text. S> A `GenericStyledArea` whose segment generic has been specified to be a `String`.
public abstract class	StyledTextField< type of paragraph style PS, type of style that can be applied to text. S> A text field whose segment generic has been specified to be a `String`.
public class	TextExt A class which adds some more RichTextFX-specific styleable properties to JavaFX's `Text` class.
pack-priv class	TextFlowExt Adds additional API to `TextFlow`.
pack-priv class	TextFlowLayout
pack-priv class	TextFlowSpan
public class	UnderlinePath A path which describes an underline in the Scene graph.

Package org.fxmisc.richtext

Interface Summary

Class Summary