Package org.fxmisc.richtext
Defines the view-related classes for rendering and editing an
EditableStyledDocument
.
The base area is 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). StyledTextArea
uses String
-only segments,
and styling them are already supported in the two most common ways via
StyleClassedTextArea
and InlineCssTextArea
.
For those looking to use a base for a code editor, see CodeArea
.
For text fields there is StyledTextField
using String
-only segments,
and styling them are also already supported in the two most common ways via
StyleClassedTextField
and InlineCssTextField
.
-
Interface Summary Interface Description Caret An object for encapsulating a caret in a given area.CaretSelectionBind<PS,SEG,S> An object for encapsulating a caret and a selection in a given area where the caret and selection are bound to one another.ClipboardActions<PS,SEG,S> Clipboard actions forTextEditingArea
.EditActions<PS,SEG,S> Specifies actions for editing the content of aTextEditingArea
.NavigationActions<PS,SEG,S> Specifies actions for moving the caret and/or making a selection for aTextEditingArea
.Selection<PS,SEG,S> An object for encapsulating a selection in a given area.StyleActions<PS,S> Specifies actions related to getting and setting styles throughout aTextEditingArea
.TextEditingArea<PS,SEG,S> Interface for a text editing control.UndoActions Undo/redo actions forTextEditingArea
.ViewActions<PS,SEG,S> Specifies view-related API for aTextEditingArea
-
Class Summary Class Description BackgroundPath A path which describes a background shape in the Scene graph.BorderPath A path which describes a border in the Scene graph.CaretNode Default implementation for aCaret
.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.CodeArea A convenience subclass ofStyleClassedTextArea
with fixed-width font and an undo manager that observes only plain text changes (not styled changes).CustomCssMetaData<S extends javafx.css.Styleable,V> Reduces boilerplate when creating a customCssMetaData
objectCustomStyleableProperty<T> Reduces the boilerplate when creating a custom CSS property (i.e.GenericStyledArea<PS,SEG,S> Text editing control that renders and edits aEditableStyledDocument
.InlineCssTextArea Text area that uses inline css to define style of text segments and paragraphs.InlineCssTextField A TextField that uses inline CSS, i.e.LineNumberFactory<PS> Graphic factory that produces labels containing line numbers and a "+" to indicate folded paragraphs.MultiChangeBuilder<PS,SEG,S> Constructs a list ofReplacement
s that are used to update anEditableStyledDocument
in one call viaMultiChangeBuilder.commit()
.SelectionImpl<PS,SEG,S> Default implementation forSelection
.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.StyleClassedTextArea Text area that uses style classes to define style of text segments and paragraph segments.StyleClassedTextField A TextField that uses style classes, i.e.StyledTextArea<PS,S> AGenericStyledArea
whose segment generic has been specified to be aString
.StyledTextField<PS,S> A text field whose segment generic has been specified to be aString
.TextExt A class which adds some more RichTextFX-specific styleable properties to JavaFX'sText
class.UnderlinePath A path which describes an underline in the Scene graph. -
Enum Summary Enum Description Caret.CaretVisibility Determines whether the caret is visible.NavigationActions.SelectionPolicy Indicates how to treat selection when caret is moved.Selection.Direction Specifies whether to update the start/end value of a selection to the left (towards 0) or right (away from 0)