Class CodeTextModel

java.lang.Object

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

jfx.incubator.scene.control.richtext.model.BasicTextModel

jfx.incubator.scene.control.richtext.model.CodeTextModel

public class CodeTextModel
extends BasicTextModel

Editable plain text model with optional syntax highlighting for use with the CodeArea control.

This model supports custom content storage mechanism via BasicTextModel.Content. By default, the model provides an in-memory storage via its BasicTextModel.InMemoryContent implementation.

Since:

24

Nested Class Summary

Nested classes/interfaces declared in class BasicTextModel

BasicTextModel.Content, BasicTextModel.InMemoryContent

Modifier and Type	Class	Description
static interface	BasicTextModel.Content	This interface describes the underlying storage mechanism for the BasicTextModel.
static class	BasicTextModel.InMemoryContent	This content provides in-memory storage in an ArrayList of Strings.

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 ObjectProperty<SyntaxDecorator>	decorator	Syntax decorator applies styling to the plain text stored in the model.

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
CodeTextModel()	Constructs the CodeTextModel with an in-memory content.
CodeTextModel(BasicTextModel.Content c)	Constructs the CodeTextModel with the specified content.

Method Summary

Modifier and Type	Method	Description
final ObjectProperty<SyntaxDecorator>	decoratorProperty()	Syntax decorator applies styling to the plain text stored in the model.
final SyntaxDecorator	getDecorator()	Gets the value of the decorator property.
final RichParagraph	getParagraph(int index)	Returns a RichParagraph at the given model index.
final void	setDecorator(SyntaxDecorator d)	Sets the value of the decorator property.

Methods declared in class BasicTextModel

applyParagraphStyle, applyStyle, getPlainText, getStyleAttributeMap, insertLineBreak, insertParagraph, insertText, insertTextSegment, isWritable, removeRange, setParagraphStyle, size

Modifier and Type	Method	Description
protected void	applyParagraphStyle(int index, StyleAttributeMap paragraphAttrs)	Applies paragraph styles in the specified paragraph.
protected final void	applyStyle(int index, int start, int end, StyleAttributeMap a, boolean merge)	Applies style to the specified text range within a single paragraph.
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.
void	insertText(TextPos p, String text)	Inserts text at the specified position.
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()	Determines whether the model is writable.
protected void	removeRange(TextPos start, TextPos end)	Removes the specified text range.
protected final void	setParagraphStyle(int index, StyleAttributeMap a)	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

decorator

public final ObjectProperty<SyntaxDecorator> decoratorProperty

Syntax decorator applies styling to the plain text stored in the model.

See Also:

• getDecorator()
• setDecorator(SyntaxDecorator)
• decoratorProperty()

Constructor Details

CodeTextModel

public CodeTextModel()

Constructs the CodeTextModel with an in-memory content.

CodeTextModel

public CodeTextModel(BasicTextModel.Content c)

Constructs the CodeTextModel with the specified content.

Parameters:

c - the content

Method Details

getParagraph

public final 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

decoratorProperty

public final ObjectProperty<SyntaxDecorator> decoratorProperty()

Syntax decorator applies styling to the plain text stored in the model.

Returns:

the syntax decorator value (may be null)

See Also:

• getDecorator()
• setDecorator(SyntaxDecorator)

getDecorator

public final SyntaxDecorator getDecorator()

Gets the value of the decorator property.

Property description:

Syntax decorator applies styling to the plain text stored in the model.

Returns:

the value of the decorator property

See Also:

• setDecorator(SyntaxDecorator)
• decoratorProperty()

setDecorator

public final void setDecorator(SyntaxDecorator d)

Sets the value of the decorator property.

Property description:

Syntax decorator applies styling to the plain text stored in the model.

Parameters:

d - the value for the decorator property

See Also:

• getDecorator()
• decoratorProperty()