Package org.fxmisc.richtext.model

Class GenericEditableStyledDocument<PS,SEG,S>

java.lang.Object

org.fxmisc.richtext.model.GenericEditableStyledDocument<PS,SEG,S>

Type Parameters:

PS - type of style that can be applied to paragraphs (e.g. TextFlow.

SEG - type of segment used in Paragraph. Can be only text (plain or styled) or a type that combines text and other Nodes via Either<String, Node>.

S - type of style that can be applied to a segment.

All Implemented Interfaces:

EditableStyledDocument<PS,SEG,S>, StyledDocument<PS,SEG,S>, TwoDimensional

public final class GenericEditableStyledDocument<PS,SEG,S>
extends java.lang.Object
implements EditableStyledDocument<PS,SEG,S>

Provides a basic implementation of EditableStyledDocument while still allowing a developer to specify its generics. See SimpleEditableStyledDocument for a version that specifies its segment style to String.

Property Summary

Properties

Type	Property	Description
SuspendableNo	beingUpdated
Val<java.lang.Integer>	length
Val<java.lang.String>	text

Properties inherited from interface org.fxmisc.richtext.model.EditableStyledDocument

beingUpdated, length, text

Nested Class Summary

Nested classes/interfaces inherited from interface org.fxmisc.richtext.model.TwoDimensional

TwoDimensional.Bias, TwoDimensional.Position

Constructor Summary

Constructors

Constructor	Description
GenericEditableStyledDocument(Paragraph<PS,SEG,S> initialParagraph)	Creates an EditableStyledDocument with given paragraph as its initial content
GenericEditableStyledDocument(ReadOnlyStyledDocument<PS,SEG,S> initialContent)	Creates an EditableStyledDocument with the given document as its initial content
GenericEditableStyledDocument(PS initialParagraphStyle, S initialStyle, SegmentOps<SEG,S> segmentOps)	Creates an empty EditableStyledDocument

Method Summary

Modifier and Type	Method	Description
SuspendableNo	beingUpdatedProperty()
StyledDocument<PS,SEG,S>	concat(StyledDocument<PS,SEG,S> that)
int	getLength()	Gets the value of the property length.
LiveList<Paragraph<PS,SEG,S>>	getParagraphs()
java.lang.String	getText()
boolean	isBeingUpdated()
int	length()
Val<java.lang.Integer>	lengthProperty()
EventStream<java.util.List<RichTextChange<PS,SEG,S>>>	multiRichChanges()	Returns an EventStream that emits a List of RichTextChanges every time a change is made to this document, even when such a change does not modify the underlying document in any way.
TwoDimensional.Position	offsetToPosition(int offset, TwoDimensional.Bias bias)	Creates a two dimensional position in some entity (e.g.
TwoDimensional.Position	position(int major, int minor)	Creates a two dimensional position in some entity (e.g.
void	replace(int start, int end, StyledDocument<PS,SEG,S> replacement)	Replaces the portion of this document "from..to" with the given replacement.
void	replaceMulti(java.util.List<Replacement<PS,SEG,S>> replacements)	Replaces multiple portions of this document in one update.
void	setParagraphStyle(int paragraphIndex, PS style)	Sets the given paragraph to the given paragraph style
void	setStyle(int paragraphIndex, int fromCol, int toCol, S style)	Sets the given range "fromCol..toCol" in the given paragraph to the given style
void	setStyle(int from, int to, S style)	Sets the style of all segments in the given "from..to" range to the given style.
void	setStyle(int paragraphIndex, S style)	Sets all segments in the given paragraph to the given style
void	setStyleSpans(int paragraphIndex, int from, StyleSpans<? extends S> styleSpans)	Replaces the style spans for the given range "from..(from + styleSpans.length())" in the given paragraph with the given style spans
void	setStyleSpans(int from, StyleSpans<? extends S> styleSpans)	Replaces the style spans for the given range "from..(from + styleSpans.length())" with the given style spans
ReadOnlyStyledDocument<PS,SEG,S>	snapshot()	Read-only snapshot of the current state of this document.
StyledDocument<PS,SEG,S>	subSequence(int start, int end)
Val<java.lang.String>	textProperty()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fxmisc.richtext.model.EditableStyledDocument

beingUpdatedProperty, getLength, getParagraphs, isBeingUpdated, lengthProperty, multiPlainChanges, multiRichChanges, plainChanges, replace, replace, replaceMulti, richChanges, setParagraphStyle, setStyle, setStyle, setStyle, setStyleSpans, setStyleSpans, snapshot, textProperty

Methods inherited from interface org.fxmisc.richtext.model.StyledDocument

charAt, concat, getAbsolutePosition, getParagraph, getParagraphLength, getParagraphStyle, getParagraphStyleAtPosition, getStyleAtPosition, getStyleAtPosition, getStyleOfChar, getStyleOfChar, getStyleRangeAtPosition, getStyleRangeAtPosition, getStyleSpans, getStyleSpans, getStyleSpans, getText, getText, getText, getText, length, subDocument, subSequence, subSequence

Methods inherited from interface org.fxmisc.richtext.model.TwoDimensional

offsetToPosition, position

Property Detail

text

public Val<java.lang.String> textProperty

Specified by:

textProperty in interface EditableStyledDocument<PS,SEG,S>

length

public Val<java.lang.Integer> lengthProperty

Specified by:

lengthProperty in interface EditableStyledDocument<PS,SEG,S>

See Also:

EditableStyledDocument.getLength()

beingUpdated

public final SuspendableNo beingUpdatedProperty

Specified by:

beingUpdatedProperty in interface EditableStyledDocument<PS,SEG,S>

Constructor Detail

GenericEditableStyledDocument

public GenericEditableStyledDocument(ReadOnlyStyledDocument<PS,SEG,S> initialContent)

Creates an EditableStyledDocument with the given document as its initial content

GenericEditableStyledDocument

public GenericEditableStyledDocument(Paragraph<PS,SEG,S> initialParagraph)

Creates an EditableStyledDocument with given paragraph as its initial content

GenericEditableStyledDocument

public GenericEditableStyledDocument(PS initialParagraphStyle,
                                     S initialStyle,
                                     SegmentOps<SEG,S> segmentOps)

Creates an empty EditableStyledDocument

Method Detail

multiRichChanges

public EventStream<java.util.List<RichTextChange<PS,SEG,S>>> multiRichChanges()

Description copied from interface: EditableStyledDocument

Returns an EventStream that emits a List of RichTextChanges every time a change is made to this document, even when such a change does not modify the underlying document in any way. The emitted list will only have one item in it unless one used EditableStyledDocument.replaceMulti(List).

Specified by:

multiRichChanges in interface EditableStyledDocument<PS,SEG,S>

getText

public java.lang.String getText()

Specified by:

getText in interface StyledDocument<PS,SEG,S>

textProperty

public Val<java.lang.String> textProperty()

Specified by:

textProperty in interface EditableStyledDocument<PS,SEG,S>

getLength

public int getLength()

Description copied from interface: EditableStyledDocument

Gets the value of the property length.

Specified by:

getLength in interface EditableStyledDocument<PS,SEG,S>

lengthProperty

public Val<java.lang.Integer> lengthProperty()

Specified by:

lengthProperty in interface EditableStyledDocument<PS,SEG,S>

See Also:

EditableStyledDocument.getLength()

length

public int length()

Specified by:

length in interface StyledDocument<PS,SEG,S>

getParagraphs

public LiveList<Paragraph<PS,SEG,S>> getParagraphs()

Specified by:

getParagraphs in interface EditableStyledDocument<PS,SEG,S>

Specified by:

getParagraphs in interface StyledDocument<PS,SEG,S>

snapshot

public ReadOnlyStyledDocument<PS,SEG,S> snapshot()

Description copied from interface: EditableStyledDocument

Read-only snapshot of the current state of this document.

Specified by:

snapshot in interface EditableStyledDocument<PS,SEG,S>

beingUpdatedProperty

public final SuspendableNo beingUpdatedProperty()

Specified by:

beingUpdatedProperty in interface EditableStyledDocument<PS,SEG,S>

isBeingUpdated

public final boolean isBeingUpdated()

Specified by:

isBeingUpdated in interface EditableStyledDocument<PS,SEG,S>

position

public TwoDimensional.Position position(int major,
                                        int minor)

Description copied from interface: TwoDimensional

Creates a two dimensional position in some entity (e.g. area, list of lists, list of some object with length) where the major value is the index within the outer list) and the minor value is either the index within the inner list or some amount of length in a list of objects that have length.

Specified by:

position in interface TwoDimensional

offsetToPosition

public TwoDimensional.Position offsetToPosition(int offset,
                                                TwoDimensional.Bias bias)

Description copied from interface: TwoDimensional

Creates a two dimensional position in some entity (e.g. area, list of lists, list of some object with length) where the offset value is an absolute position in that entity.

Specified by:

offsetToPosition in interface TwoDimensional

replaceMulti

public void replaceMulti(java.util.List<Replacement<PS,SEG,S>> replacements)

Description copied from interface: EditableStyledDocument

Replaces multiple portions of this document in one update.

Specified by:

replaceMulti in interface EditableStyledDocument<PS,SEG,S>

replace

public void replace(int start,
                    int end,
                    StyledDocument<PS,SEG,S> replacement)

Description copied from interface: EditableStyledDocument

Replaces the portion of this document "from..to" with the given replacement.

Specified by:

replace in interface EditableStyledDocument<PS,SEG,S>

Parameters:

start - the absolute position in the document that starts the portion to replace

end - the absolute position in the document that ends the portion to replace

replacement - the document that replaces the removed portion of this document

setStyle

public void setStyle(int from,
                     int to,
                     S style)

Description copied from interface: EditableStyledDocument

Sets the style of all segments in the given "from..to" range to the given style.

Specified by:

setStyle in interface EditableStyledDocument<PS,SEG,S>

Parameters:

from - the absolute position in the document that starts the range to re-style

to - the absolute position in the document that ends the range to re-style

setStyle

public void setStyle(int paragraphIndex,
                     S style)

Description copied from interface: EditableStyledDocument

Sets all segments in the given paragraph to the given style

Specified by:

setStyle in interface EditableStyledDocument<PS,SEG,S>

setStyle

public void setStyle(int paragraphIndex,
                     int fromCol,
                     int toCol,
                     S style)

Description copied from interface: EditableStyledDocument

Sets the given range "fromCol..toCol" in the given paragraph to the given style

Specified by:

setStyle in interface EditableStyledDocument<PS,SEG,S>

setStyleSpans

public void setStyleSpans(int from,
                          StyleSpans<? extends S> styleSpans)

Description copied from interface: EditableStyledDocument

Replaces the style spans for the given range "from..(from + styleSpans.length())" with the given style spans

Specified by:

setStyleSpans in interface EditableStyledDocument<PS,SEG,S>

setStyleSpans

public void setStyleSpans(int paragraphIndex,
                          int from,
                          StyleSpans<? extends S> styleSpans)

Description copied from interface: EditableStyledDocument

Replaces the style spans for the given range "from..(from + styleSpans.length())" in the given paragraph with the given style spans

Specified by:

setStyleSpans in interface EditableStyledDocument<PS,SEG,S>

setParagraphStyle

public void setParagraphStyle(int paragraphIndex,
                              PS style)

Description copied from interface: EditableStyledDocument

Sets the given paragraph to the given paragraph style

Specified by:

setParagraphStyle in interface EditableStyledDocument<PS,SEG,S>

concat

public StyledDocument<PS,SEG,S> concat(StyledDocument<PS,SEG,S> that)

Specified by:

concat in interface StyledDocument<PS,SEG,S>

subSequence

public StyledDocument<PS,SEG,S> subSequence(int start,
                                                        int end)

Specified by:

subSequence in interface StyledDocument<PS,SEG,S>