Class SimpleViewOnlyStyledModel

java.lang.Object

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

jfx.incubator.scene.control.richtext.model.StyledTextModelViewOnlyBase

jfx.incubator.scene.control.richtext.model.SimpleViewOnlyStyledModel

public class SimpleViewOnlyStyledModel
extends StyledTextModelViewOnlyBase

A simple, view-only, in-memory, styled text model.

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 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.

Constructor Summary

Constructors

Constructor	Description
SimpleViewOnlyStyledModel()	The constructor.

Method Summary

Modifier and Type	Method	Description
SimpleViewOnlyStyledModel	addImage(InputStream in)	Adds a paragraph containing an image.
SimpleViewOnlyStyledModel	addNodeSegment(Supplier<Node> generator)	Adds an inline Node to the last paragraph.
SimpleViewOnlyStyledModel	addParagraph(Supplier<Region> generator)	Adds a paragraph containing a Region.
SimpleViewOnlyStyledModel	addSegment(String text)	Appends a text segment to the last paragraph.
SimpleViewOnlyStyledModel	addSegment(String text, StyleAttributeMap a)	Appends a text segment styled with the specified style attributes.
SimpleViewOnlyStyledModel	addWavyUnderline(int start, int length, String... css)	Adds a wavy underline (typically used as a spell checker indicator) to the specified range within the last paragraph, with the specified style name(s).
SimpleViewOnlyStyledModel	addWavyUnderline(int start, int length, Color c)	Adds a wavy underline (typically used as a spell checker indicator) to the specified range within the last paragraph.
SimpleViewOnlyStyledModel	addWithInlineAndStyleNames(String text, String style, String... css)	Appends a text segment styled with both the inline style and the stylesheet style names.
SimpleViewOnlyStyledModel	addWithInlineStyle(String text, String style)	Appends a text segment styled with the inline style.
SimpleViewOnlyStyledModel	addWithStyleNames(String text, String... css)	Appends a text segment styled with the stylesheet style names.
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 r, TextPos pos, boolean forInsert)	Returns the StyleAttributeMap of the character at the specified position's charIndex.
SimpleViewOnlyStyledModel	highlight(int start, int length, String... css)	Adds a highlight of the given color to the specified range within the last paragraph, with the specified style name(s).
SimpleViewOnlyStyledModel	highlight(int start, int length, Color c)	Adds a highlight of the given color to the specified range within the last paragraph.
SimpleViewOnlyStyledModel	nl()	Adds a new paragraph (as if inserting a newline symbol into the text).
SimpleViewOnlyStyledModel	nl(int count)	Adds n new paragraphs (as if inserting a newline symbol into the text n times).
static SimpleViewOnlyStyledModel	of(String text)	Creates the model from the supplied text string by breaking it down into individual text segments, by splitting on newline characters.
SimpleViewOnlyStyledModel	setParagraphAttributes(StyleAttributeMap a)	Sets the last paragraph's attributes.
int	size()	Returns the number of paragraphs in the model.

Methods declared in class StyledTextModelViewOnlyBase

applyParagraphStyle, applyStyle, insertLineBreak, insertParagraph, insertTextSegment, isWritable, removeRange, setParagraphStyle

Modifier and Type	Method	Description
protected final void	applyParagraphStyle(int ix, StyleAttributeMap a)	Applies paragraph styles in the specified paragraph.
protected final void	applyStyle(int ix, int start, int end, StyleAttributeMap a, boolean merge)	Applies style to the specified text range within a single paragraph.
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 void	removeRange(TextPos start, TextPos end)	Removes the specified text range.
protected final void	setParagraphStyle(int ix, StyleAttributeMap a)	Replaces the paragraph styles in the specified paragraph.

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

Constructor Details

SimpleViewOnlyStyledModel

public SimpleViewOnlyStyledModel()

The constructor.

Method Details

of

public static SimpleViewOnlyStyledModel of(String text)
                                    throws IOException

Creates the model from the supplied text string by breaking it down into individual text segments, by splitting on newline characters.

Parameters:

text - the input multi-line text

Returns:

the new instance

Throws:

IOException - if an I/O error occurs

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

addSegment

public SimpleViewOnlyStyledModel addSegment(String text)

Appends a text segment to the last paragraph. The caller must ensure that the text does not contain newline symbols, as the behavior is undefined in this case.

This convenience method is equivalent to calling addSegment(text, StyleAttributeMap.EMPTY);

Parameters:

text - the text to append, must not contain newline symbols, cannot be null

Returns:

this model instance

addWithInlineAndStyleNames

public SimpleViewOnlyStyledModel addWithInlineAndStyleNames(String text,
 String style,
 String... css)

Appends a text segment styled with both the inline style and the stylesheet style names. The text cannot contain newline (\n) symbols.

Parameters:

text - the text to append, must not contain \n, cannot be null

style - the inline style (example "-fx-fill:red;")

css - the stylesheet style names

Returns:

this model instance

addWithStyleNames

public SimpleViewOnlyStyledModel addWithStyleNames(String text,
 String... css)

Appends a text segment styled with the stylesheet style names. The text cannot contain newline (\n) symbols.

Parameters:

text - the text to append, must not contain \n, cannot be null

css - the stylesheet style names

Returns:

this model instance

addWithInlineStyle

public SimpleViewOnlyStyledModel addWithInlineStyle(String text,
 String style)

Appends a text segment styled with the inline style. The text cannot contain newline (\n) symbols.

Parameters:

text - the text to append, must not contain \n, cannot be null

style - the inline style (example "-fx-fill:red;"), or null

Returns:

this model instance

addSegment

public SimpleViewOnlyStyledModel addSegment(String text,
 StyleAttributeMap a)

Appends a text segment styled with the specified style attributes.

Parameters:

text - the text to append, must not contain control symbols other than TAB.

a - the style attributes

Returns:

this model instance

highlight

public SimpleViewOnlyStyledModel highlight(int start,
 int length,
 Color c)

Adds a highlight of the given color to the specified range within the last paragraph.

Parameters:

start - the start offset

length - the length of the highlight

c - the highlight color

Returns:

this model instance

highlight

public SimpleViewOnlyStyledModel highlight(int start,
 int length,
 String... css)

Adds a highlight of the given color to the specified range within the last paragraph, with the specified style name(s).

Parameters:

start - the start offset

length - the length of the highlight

css - the highlight style name(s)

Returns:

this model instance

Since:

25

addWavyUnderline

public SimpleViewOnlyStyledModel addWavyUnderline(int start,
 int length,
 Color c)

Adds a wavy underline (typically used as a spell checker indicator) to the specified range within the last paragraph.

Parameters:

start - the start offset

length - the length of the highlight

c - the highlight color

Returns:

this model instance

addWavyUnderline

public SimpleViewOnlyStyledModel addWavyUnderline(int start,
 int length,
 String... css)

Adds a wavy underline (typically used as a spell checker indicator) to the specified range within the last paragraph, with the specified style name(s).

Parameters:

start - the start offset

length - the length of the highlight

css - the highlight style name(s)

Returns:

this model instance

Since:

25

addImage

public SimpleViewOnlyStyledModel addImage(InputStream in)

Adds a paragraph containing an image. The image will be reduced in size as necessary to fit into the available area if wrapText property is set. This method does not close the input stream.

Parameters:

in - the input stream providing the image.

Returns:

this model instance

addParagraph

public SimpleViewOnlyStyledModel addParagraph(Supplier<Region> generator)

Adds a paragraph containing a Region.

The supplied generator must not cache or keep reference to the created Region, but the created Region can keep a reference to the model or a property therein.

For example, a bidirectional binding between an inline control and some property in the model would synchronize the model with all the views that use it.

Parameters:

generator - the supplier of the paragraph content

Returns:

this model instance

addNodeSegment

public SimpleViewOnlyStyledModel addNodeSegment(Supplier<Node> generator)

Adds an inline Node to the last paragraph.

The supplied generator must not cache or keep reference to the created Node, but the created Node can keep a reference to the model or a property therein.

For example, a bidirectional binding between an inline control and some property in the model would synchronize the model with all the views that use it.

Parameters:

generator - the supplier of the embedded Node

Returns:

this model instance

nl

public SimpleViewOnlyStyledModel nl()

Adds a new paragraph (as if inserting a newline symbol into the text). This convenience method invokes nl(int) with a value of 1.

Returns:

this model instance

nl

public SimpleViewOnlyStyledModel nl(int count)

Adds n new paragraphs (as if inserting a newline symbol into the text n times).

Parameters:

count - the number of paragraphs to append

Returns:

this model instance

getStyleAttributeMap

public StyleAttributeMap getStyleAttributeMap(StyleResolver r,
 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:

r - the style resolver

pos - the text position

forInsert - whether to pick preceding style at the segment boundary

Returns:

the style attributes, non-null

setParagraphAttributes

public SimpleViewOnlyStyledModel setParagraphAttributes(StyleAttributeMap a)

Sets the last paragraph's attributes.

Parameters:

a - the paragraph attributes

Returns:

this model instance