Class RichTextModel

java.lang.Object

jfx.incubator.scene.control.richtext.model.StyledTextModel

jfx.incubator.scene.control.richtext.model.RichTextModel

public class RichTextModel
extends StyledTextModel

Editable, in-memory StyledTextModel based on a collection of styled segments.

This model is suitable for relatively small documents as it has neither disk storage backing nor storage of incremental changes.

Since:

24

Nested Class Summary

Nested classes/interfaces declared in class StyledTextModel

StyledTextModel.Listener

Modifier and Type	Class	Description
static interface	StyledTextModel.Listener	Receives information about modifications of the model.

Property Summary

Properties

Type	Property	Description
final DoubleProperty	defaultTabStops	Specifies the default tab stop interval for tabs beyond the last stop provided by the paragraph's StyleAttributeMap.TAB_STOPS attribute, if any.

Properties declared in class StyledTextModel

redoable, undoable

Type	Property	Description
final ReadOnlyBooleanProperty	redoable	The property describes if it's currently possible to redo the latest change of the content that was undone.
final ReadOnlyBooleanProperty	undoable	The property describes if it's currently possible to undo the latest change of the content that was done.

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_TAB_STOPS_DISABLED	This value of the defaultTabStopsProperty() disables the default tab stops, making a tab characters appear as a single space.
static final double	DEFAULT_TAB_STOPS_FIXED	This value of the defaultTabStopsProperty() results in a legacy behavior where the tab spacing corresponds to 8 spaces.

Constructor Summary

Constructors

Constructor	Description
RichTextModel()	Constructs the empty model.

Method Summary

Modifier and Type	Method	Description
protected void	applyParagraphStyle(int index, StyleAttributeMap attrs)	Applies paragraph styles in the specified paragraph.
protected void	applyStyle(int index, int start, int end, StyleAttributeMap attrs, boolean merge)	Applies style to the specified text range within a single paragraph.
final DoubleProperty	defaultTabStopsProperty()	Specifies the default tab stop interval for tabs beyond the last stop provided by the paragraph's StyleAttributeMap.TAB_STOPS attribute, if any.
final double	getDefaultTabStops()	Gets the value of the defaultTabStops property.
RichParagraph	getParagraph(int index)	Returns a RichParagraph at the given model index.
String	getPlainText(int index)	Returns the plain text string for the specified paragraph.
StyleAttributeMap	getStyleAttributeMap(StyleResolver resolver, TextPos pos, boolean forInsert)	Returns the StyleAttributeMap of the character at the specified position's charIndex.
protected void	insertLineBreak(int index, int offset)	Inserts a line break at the specified position.
protected void	insertParagraph(int index, Supplier<Region> generator)	Inserts a paragraph that contains a single Region.
protected int	insertTextSegment(int index, int offset, String text, StyleAttributeMap attrs)	This method is called to insert a single styled text segment at the given position.
final boolean	isWritable()	Indicates whether the model supports content modifications made via applyStyle(), replace(), undo(), redo() methods.
protected RichParagraph.Builder	prepareParagraph(int index)	Prepares the paragraph by populating a builder with the paragraph content.
protected void	removeRange(TextPos start, TextPos end)	Removes the specified text range.
final void	setDefaultTabStops(double value)	Sets the value of the defaultTabStops property.
protected void	setParagraphStyle(int index, StyleAttributeMap attrs)	Replaces the paragraph styles in the specified paragraph.
int	size()	Returns the number of paragraphs in the model.

Methods declared in class StyledTextModel

addListener, applyStyle, clamp, clearUndoRedo, documentProperties, export, exportParagraph, fireChangeEvent, fireStyleChangeEvent, getDataFormatHandler, getDocumentEnd, getEndOfParagraphTextPos, getLineEnding, getMarker, getParagraphLength, getSupportedAttributes, getSupportedDataFormats, handleDocumentProperties, isRedoable, isUndoable, isUndoRedoEnabled, read, redo, redoableProperty, registerDataFormatHandler, removeDataFormatHandler, removeListener, replace, replace, setLineEnding, setUndoRedoEnabled, undo, undoableProperty, versionString, write

Modifier and Type	Method	Description
final void	addListener(StyledTextModel.Listener listener)	Adds a StyledTextModel.Listener to this model.
final void	applyStyle(TextPos start, TextPos end, StyleAttributeMap attrs, boolean mergeAttributes)	Applies the style attributes to the specified range in the document.
final TextPos	clamp(TextPos p)	Returns the text position guaranteed to be within the document and paragraph limits.
final void	clearUndoRedo()	Clears the undo-redo stack.
protected Map<String,String>	documentProperties()	This method is called by StyledTextModel.export(TextPos, TextPos, StyledOutput) to ensure that the document properties, if any, are exported.
final void	export(TextPos start, TextPos end, StyledOutput out)	Exports the stream of StyledSegments in the given range to the specified StyledOutput.
protected final void	exportParagraph(int index, int start, int end, boolean withParAttrs, StyledOutput out)	Exports part of the paragraph as a sequence of styled segments.
void	fireChangeEvent(TextPos start, TextPos end, int charsTop, int linesAdded, int charsBottom)	Fires a text modification event for the given range.
void	fireStyleChangeEvent(TextPos start, TextPos end)	Fires a style change event for the given range.
final DataFormatHandler	getDataFormatHandler(DataFormat format, boolean forExport)	Returns a DataFormatHandler instance corresponding to the given DataFormat.
final TextPos	getDocumentEnd()	Returns the text position corresponding to the end of the document.
final TextPos	getEndOfParagraphTextPos(int index)	Returns a TextPos corresponding to the end of paragraph at the given index.
final LineEnding	getLineEnding()	Specifies the line ending characters.
final Marker	getMarker(TextPos pos)	Returns the Marker at the specified position.
int	getParagraphLength(int index)	Returns the length of text in a paragraph at the specified index.
protected Set<StyleAttribute<?>>	getSupportedAttributes()	Returns the set of attributes supported attributes.
final List<DataFormat>	getSupportedDataFormats(boolean forExport)	Returns an immutable list of supported data formats for either export or import operations, in the order of priority - from high to low.
protected void	handleDocumentProperties(Map<String,String> props, boolean completeReplacement)	This method is called by any of the replace() methods when encountering a StyledSegment.Type.DOCUMENT_PROPERTIES segment.
final boolean	isRedoable()	Gets the value of the redoable property.
final boolean	isUndoable()	Gets the value of the undoable property.
final boolean	isUndoRedoEnabled()	Indicates whether undo/redo functionality is enabled.
final void	read(StyleResolver r, DataFormat f, InputStream input)	Replaces the content of the model with the data read from the input stream, using the specified DataFormat.
final TextPos[]	redo(StyleResolver resolver)	Redoes the recent change, if possible, returning an array comprising [start, end] text positions prior to the change.
final ReadOnlyBooleanProperty	redoableProperty()	The property describes if it's currently possible to redo the latest change of the content that was undone.
protected final void	registerDataFormatHandler(DataFormatHandler h, boolean forExport, boolean forImport, int priority)	Registers a format handler for export and/or import operations.
protected final void	removeDataFormatHandler(DataFormat f, boolean forExport, boolean forImport)	Removes the data format handler registered previously with StyledTextModel.registerDataFormatHandler(DataFormatHandler, boolean, boolean, int).
final void	removeListener(StyledTextModel.Listener listener)	Removes a StyledTextModel.Listener from this model.
final TextPos	replace(StyleResolver resolver, TextPos start, TextPos end, String text)	Replaces the given range with the provided plain text.
final TextPos	replace(StyleResolver resolver, TextPos start, TextPos end, StyledInput input)	Replaces the given range with the provided styled text input.
final void	setLineEnding(LineEnding value)	Sets the line ending characters.
final void	setUndoRedoEnabled(boolean on)	Controls whether undo/redo functionality is enabled.
final TextPos[]	undo(StyleResolver resolver)	Undoes the recent change, if possible, returning an array comprising [start, end] text positions prior to the change.
final ReadOnlyBooleanProperty	undoableProperty()	The property describes if it's currently possible to undo the latest change of the content that was done.
protected String	versionString()	This method is called by StyledTextModel.export(TextPos, TextPos, StyledOutput) to export the model's version string, if any.
final void	write(StyleResolver r, DataFormat f, OutputStream out)	Writes the model content to the output stream using the specified DataFormat.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Details

defaultTabStops

public final DoubleProperty defaultTabStopsProperty

Specifies the default tab stop interval for tabs beyond the last stop provided by the paragraph's StyleAttributeMap.TAB_STOPS attribute, if any. This is a fixed repeating distance (in pixels) to the next tab stop computed at regular intervals relative to the document content leading edge.

Value DEFAULT_TAB_STOPS_FIXED results in a legacy behavior where the tab spacing corresponds to 8 spaces. This may result in milasigned columns when different text segments use different fonts. The value DEFAULT_TAB_STOPS_DISABLED disables the default interval, rendering tab character as a single space.

Default value:

DEFAULT_TAB_STOPS_FIXED

Since:

27

See Also:

• getDefaultTabStops()
• setDefaultTabStops(double)
• defaultTabStopsProperty()

Field Details

DEFAULT_TAB_STOPS_FIXED

public static final double DEFAULT_TAB_STOPS_FIXED

This value of the defaultTabStopsProperty() results in a legacy behavior where the tab spacing corresponds to 8 spaces. This may result in milasigned columns when different text segments use different fonts.

Since:

27

See Also:

• Constant Field Values

DEFAULT_TAB_STOPS_DISABLED

public static final double DEFAULT_TAB_STOPS_DISABLED

This value of the defaultTabStopsProperty() disables the default tab stops, making a tab characters appear as a single space.

Since:

27

See Also:

• Constant Field Values

Constructor Details

RichTextModel

public RichTextModel()

Constructs the empty model.

Method Details

defaultTabStopsProperty

public final DoubleProperty defaultTabStopsProperty()

Specifies the default tab stop interval for tabs beyond the last stop provided by the paragraph's StyleAttributeMap.TAB_STOPS attribute, if any. This is a fixed repeating distance (in pixels) to the next tab stop computed at regular intervals relative to the document content leading edge.

Value DEFAULT_TAB_STOPS_FIXED results in a legacy behavior where the tab spacing corresponds to 8 spaces. This may result in milasigned columns when different text segments use different fonts. The value DEFAULT_TAB_STOPS_DISABLED disables the default interval, rendering tab character as a single space.

Default value:

DEFAULT_TAB_STOPS_FIXED

Returns:

the default tab stop interval property

Since:

27

See Also:

• getDefaultTabStops()
• setDefaultTabStops(double)

setDefaultTabStops

public final void setDefaultTabStops(double value)

Sets the value of the defaultTabStops property.

Property description:

Specifies the default tab stop interval for tabs beyond the last stop provided by the paragraph's StyleAttributeMap.TAB_STOPS attribute, if any. This is a fixed repeating distance (in pixels) to the next tab stop computed at regular intervals relative to the document content leading edge.

Value DEFAULT_TAB_STOPS_FIXED results in a legacy behavior where the tab spacing corresponds to 8 spaces. This may result in milasigned columns when different text segments use different fonts. The value DEFAULT_TAB_STOPS_DISABLED disables the default interval, rendering tab character as a single space.

Default value:

DEFAULT_TAB_STOPS_FIXED

Parameters:

value - the value for the defaultTabStops property

Since:

27

See Also:

• getDefaultTabStops()
• defaultTabStopsProperty()

getDefaultTabStops

public final double getDefaultTabStops()

Gets the value of the defaultTabStops property.

Property description:

Specifies the default tab stop interval for tabs beyond the last stop provided by the paragraph's StyleAttributeMap.TAB_STOPS attribute, if any. This is a fixed repeating distance (in pixels) to the next tab stop computed at regular intervals relative to the document content leading edge.

Value DEFAULT_TAB_STOPS_FIXED results in a legacy behavior where the tab spacing corresponds to 8 spaces. This may result in milasigned columns when different text segments use different fonts. The value DEFAULT_TAB_STOPS_DISABLED disables the default interval, rendering tab character as a single space.

Default value:

DEFAULT_TAB_STOPS_FIXED

Returns:

the value of the defaultTabStops property

Since:

27

See Also:

• setDefaultTabStops(double)
• defaultTabStopsProperty()

isWritable

public final boolean isWritable()

Description copied from class: StyledTextModel

Indicates whether the model supports content modifications made via applyStyle(), replace(), undo(), redo() methods.

Note that even when this method returns false, the model itself may still update its content and fire the change events as a response, for example, to changes in its backing data storage.

Specified by:

isWritable in class StyledTextModel

Returns:

true if the model supports content modifications

size

public int size()

Description copied from class: StyledTextModel

Returns the number of paragraphs in the model.

Specified by:

size in class StyledTextModel

Returns:

number of paragraphs

getPlainText

public String getPlainText(int index)

Description copied from class: StyledTextModel

Returns the plain text string for the specified paragraph. The returned text string cannot be null and must not contain any control characters other than TAB. The callers must ensure that the value of index is within the valid document range, since doing otherwise might result in an exception or undetermined behavior.

Specified by:

getPlainText in class StyledTextModel

Parameters:

index - the paragraph index in the range (0...StyledTextModel.size())

Returns:

the non-null paragraph text string

getParagraph

public RichParagraph getParagraph(int index)

Description copied from class: StyledTextModel

Returns a RichParagraph at the given model index. The callers must ensure that the value of index is within the valid document range, since doing otherwise might result in an exception or undetermined behavior.

This method makes no guarantees that the same paragraph instance will be returned for the same model index.

Specified by:

getParagraph in class StyledTextModel

Parameters:

index - the paragraph index in the range (0...StyledTextModel.size())

Returns:

the instance of RichParagraph

prepareParagraph

protected RichParagraph.Builder prepareParagraph(int index)

Prepares the paragraph by populating a builder with the paragraph content. This method allows the custom model to add highlights and decorations without affecting the base class storage model.

Parameters:

index - the paragraph index

Returns:

the builder

Since:

26

insertTextSegment

protected int insertTextSegment(int index,
 int offset,
 String text,
 StyleAttributeMap attrs)

Description copied from class: StyledTextModel

This method is called to insert a single styled text segment at the given position.

Specified by:

insertTextSegment in class StyledTextModel

Parameters:

index - the paragraph index

offset - the insertion offset within the paragraph

text - the text to insert

attrs - the style attributes

Returns:

the number of characters inserted

insertLineBreak

protected void insertLineBreak(int index,
 int offset)

Description copied from class: StyledTextModel

Inserts a line break at the specified position.

Specified by:

insertLineBreak in class StyledTextModel

Parameters:

index - the model index

offset - the text offset

removeRange

protected void removeRange(TextPos start,
 TextPos end)

Description copied from class: StyledTextModel

Removes the specified text range. This method gets called only if the model is editable. The caller guarantees that start precedes end.

Specified by:

removeRange in class StyledTextModel

Parameters:

start - the start of the range to be removed

end - the end of the range to be removed, expected to be greater than the start position

insertParagraph

protected void insertParagraph(int index,
 Supplier<Region> generator)

Description copied from class: StyledTextModel

Inserts a paragraph that contains a single Region.

The model should not cache or otherwise retain references to the created Regions, as they might be requested multiple times during the lifetime of the model, or by different views.

This method allows for embedding Controls that handle user input. In this case, the model should declare necessary properties and provide bidirectional bindings between the properties in the model and the corresponding properties in the control, as well as handle copy, paste, writing to and reading from I/O streams.

Specified by:

insertParagraph in class StyledTextModel

Parameters:

index - model index

generator - code that will be used to create a Node instance

applyParagraphStyle

protected void applyParagraphStyle(int index,
 StyleAttributeMap attrs)

Description copied from class: StyledTextModel

Applies paragraph styles in the specified paragraph.

Specified by:

applyParagraphStyle in class StyledTextModel

Parameters:

index - the paragraph index

attrs - the paragraph attributes

setParagraphStyle

protected void setParagraphStyle(int index,
 StyleAttributeMap attrs)

Description copied from class: StyledTextModel

Replaces the paragraph styles in the specified paragraph.

Specified by:

setParagraphStyle in class StyledTextModel

Parameters:

index - the paragraph index

attrs - the paragraph attributes

applyStyle

protected void applyStyle(int index,
 int start,
 int end,
 StyleAttributeMap attrs,
 boolean merge)

Description copied from class: StyledTextModel

Applies style to the specified text range within a single paragraph. The end argument may exceed the paragraph length, in which case the outcome should be the same as supplying the paragraph length value.

Specified by:

applyStyle in class StyledTextModel

Parameters:

index - the paragraph index

start - the start offset

end - the end offset

attrs - the character attributes

merge - determines whether to merge with or completely replace the existing attribute map

getStyleAttributeMap

public StyleAttributeMap getStyleAttributeMap(StyleResolver resolver,
 TextPos pos,
 boolean forInsert)

Description copied from class: StyledTextModel

Returns the StyleAttributeMap of the character at the specified position's charIndex.

When the position points to the boundary between two text segments with different attributes, the value of forInsert determines which segment will be used: when true, the preceding segment's attributes will be returned so inserted/typed text has the same style as the preceding text. When forInsert is false, the returned attributes correspond exactly to the symbol indicated by the specified position.

Specified by:

getStyleAttributeMap in class StyledTextModel

Parameters:

resolver - the style resolver

pos - the text position

forInsert - whether to pick preceding style at the segment boundary

Returns:

the style attributes, non-null