Package org.fxmisc.richtext.model

Class ReadOnlyStyledDocument<PS,SEG,S>

java.lang.Object

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

Type Parameters:

PS - The type of the paragraph style.

SEG - The type of the segments in the paragraph (e.g. String).

S - The type of the style of individual segments.

All Implemented Interfaces:

StyledDocument<PS,SEG,S>, TwoDimensional

public final class ReadOnlyStyledDocument<PS,SEG,S>
extends java.lang.Object
implements StyledDocument<PS,SEG,S>

An immutable implementation of StyledDocument that does not allow editing. For a StyledDocument that can be edited, see EditableStyledDocument. To create one, use its static factory "from"-prefixed methods or ReadOnlyStyledDocumentBuilder.

Nested Class Summary

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

TwoDimensional.Bias, TwoDimensional.Position

Method Summary

Modifier and Type	Method	Description
static <PS,SEG,S> Codec<StyledDocument<PS,SEG,S>>	codec(Codec<PS> pCodec, Codec<StyledSegment<SEG,S>> segCodec, SegmentOps<SEG,S> segmentOps)	Defines a codec for serializing a ReadOnlyStyledDocument.
ReadOnlyStyledDocument<PS,SEG,S>	concat(StyledDocument<PS,SEG,S> other)
boolean	equals(java.lang.Object other)
static <PS,SEG,S> ReadOnlyStyledDocument<PS,SEG,S>	from(StyledDocument<PS,SEG,S> doc)	Creates a ReadOnlyStyledDocument from the given StyledDocument.
static <PS,SEG,S> ReadOnlyStyledDocument<PS,SEG,S>	fromSegment(SEG segment, PS paragraphStyle, S style, SegmentOps<SEG,S> segmentOps)	Creates a ReadOnlyStyledDocument from the given segment.
static <PS,SEG,S> ReadOnlyStyledDocument<PS,SEG,S>	fromString(java.lang.String str, PS paragraphStyle, S style, TextOps<SEG,S> segmentOps)	Creates a ReadOnlyStyledDocument from the given string.
Paragraph<PS,SEG,S>	getParagraph(int index)
int	getParagraphCount()
java.util.List<Paragraph<PS,SEG,S>>	getParagraphs()
java.lang.String	getText()
int	hashCode()
int	length()
ReadOnlyStyledDocument<PS,SEG,S>	mapParagraphs(java.util.function.UnaryOperator<Paragraph<PS,SEG,S>> mapper)	Maps all of this document's paragraphs using the given mapper and returns them in a new ReadOnlyStyledDocument.
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.
Tuple3<ReadOnlyStyledDocument<PS,SEG,S>,RichTextChange<PS,SEG,S>,MaterializedListModification<Paragraph<PS,SEG,S>>>	replace(int paragraphIndex, int fromCol, int toCol, java.util.function.UnaryOperator<ReadOnlyStyledDocument<PS,SEG,S>> f)
Tuple3<ReadOnlyStyledDocument<PS,SEG,S>,RichTextChange<PS,SEG,S>,MaterializedListModification<Paragraph<PS,SEG,S>>>	replace(int from, int to, java.util.function.UnaryOperator<ReadOnlyStyledDocument<PS,SEG,S>> mapper)	Replaces the given portion "from..to" in the document by getting that portion of this document, passing it into the mapping function, and using the result as the replacement.
Tuple3<ReadOnlyStyledDocument<PS,SEG,S>,RichTextChange<PS,SEG,S>,MaterializedListModification<Paragraph<PS,SEG,S>>>	replace(int from, int to, ReadOnlyStyledDocument<PS,SEG,S> replacement)	Replaces the given portion "from..to" with the given replacement and returns the updated version of this document that includes the replacement, the RichTextChange that represents the change from this document to the returned one, and the modification used to update an area's list of paragraphs.
Tuple3<ReadOnlyStyledDocument<PS,SEG,S>,RichTextChange<PS,SEG,S>,MaterializedListModification<Paragraph<PS,SEG,S>>>	replace(Replacement<PS,SEG,S> replacement)	Convenience method for calling replace(int, int, ReadOnlyStyledDocument) with a Replacement argument.
Tuple3<ReadOnlyStyledDocument<PS,SEG,S>,java.util.List<RichTextChange<PS,SEG,S>>,java.util.List<MaterializedListModification<Paragraph<PS,SEG,S>>>>	replaceMulti(java.util.List<Replacement<PS,SEG,S>> replacements)	Replaces multiple portions of this document in an efficient manner and returns the updated version of this document that includes all of the replacements, the List of RichTextChange that represent all the changes from this document to the returned one, and the List of modifications used to update an area's list of paragraphs for each change.
Tuple3<ReadOnlyStyledDocument<PS,SEG,S>,RichTextChange<PS,SEG,S>,MaterializedListModification<Paragraph<PS,SEG,S>>>	replaceParagraph(int parIdx, java.util.function.UnaryOperator<Paragraph<PS,SEG,S>> mapper)	Maps the paragraph at the given index by calling replace(int, int, UnaryOperator).
Tuple2<ReadOnlyStyledDocument<PS,SEG,S>,ReadOnlyStyledDocument<PS,SEG,S>>	split(int position)	Splits this document into two at the given position and returns both halves.
Tuple2<ReadOnlyStyledDocument<PS,SEG,S>,ReadOnlyStyledDocument<PS,SEG,S>>	split(int paragraphIndex, int columnPosition)	Splits this document into two at the given paragraph's column position and returns both halves.
StyledDocument<PS,SEG,S>	subSequence(int start, int end)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Method Detail

fromString

public static <PS,SEG,S> ReadOnlyStyledDocument<PS,SEG,S> fromString(java.lang.String str,
                                                                                             PS paragraphStyle,
                                                                                             S style,
                                                                                             TextOps<SEG,S> segmentOps)

Creates a ReadOnlyStyledDocument from the given string.

Type Parameters:

PS - The type of the paragraph style.

SEG - The type of the segments in the paragraph (e.g. String).

S - The type of the style of individual segments.

Parameters:

str - the text to use to create the segments

paragraphStyle - the paragraph style to use for each paragraph in the returned document

style - the style to use for each segment in the document

segmentOps - the operations object that can create a segment froma given text

fromSegment

public static <PS,SEG,S> ReadOnlyStyledDocument<PS,SEG,S> fromSegment(SEG segment,
                                                                                              PS paragraphStyle,
                                                                                              S style,
                                                                                              SegmentOps<SEG,S> segmentOps)

Creates a ReadOnlyStyledDocument from the given segment.

Type Parameters:

PS - The type of the paragraph style.

SEG - The type of the segments in the paragraph (e.g. String).

S - The type of the style of individual segments.

Parameters:

segment - the only segment in the only paragraph in the document

paragraphStyle - the paragraph style to use for each paragraph in the returned document

style - the style to use for each segment in the document

segmentOps - the operations object that can create a segment froma given text

from

public static <PS,SEG,S> ReadOnlyStyledDocument<PS,SEG,S> from(StyledDocument<PS,SEG,S> doc)

Creates a ReadOnlyStyledDocument from the given StyledDocument.

Type Parameters:

PS - The type of the paragraph style.

SEG - The type of the segments in the paragraph (e.g. String).

S - The type of the style of individual segments.

codec

public static <PS,SEG,S> Codec<StyledDocument<PS,SEG,S>> codec(Codec<PS> pCodec,
                                                                                       Codec<StyledSegment<SEG,S>> segCodec,
                                                                                       SegmentOps<SEG,S> segmentOps)

Defines a codec for serializing a ReadOnlyStyledDocument.

Type Parameters:

PS - The type of the paragraph style.

SEG - The type of the segments in the paragraph (e.g. String).

S - The type of the style of individual segments.

Parameters:

pCodec - the codec for serializing a Paragraph

segCodec - the codec for serializing a StyledSegment

segmentOps - the operations object for operating on segments

length

public int length()

Specified by:

length in interface StyledDocument<PS,SEG,S>

getText

public java.lang.String getText()

Specified by:

getText in interface StyledDocument<PS,SEG,S>

getParagraphCount

public int getParagraphCount()

getParagraph

public Paragraph<PS,SEG,S> getParagraph(int index)

Specified by:

getParagraph in interface StyledDocument<PS,SEG,S>

getParagraphs

public java.util.List<Paragraph<PS,SEG,S>> getParagraphs()

Specified by:

getParagraphs in interface StyledDocument<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

split

public Tuple2<ReadOnlyStyledDocument<PS,SEG,S>,ReadOnlyStyledDocument<PS,SEG,S>> split(int position)

Splits this document into two at the given position and returns both halves.

split

public Tuple2<ReadOnlyStyledDocument<PS,SEG,S>,ReadOnlyStyledDocument<PS,SEG,S>> split(int paragraphIndex,
                                                                                                                     int columnPosition)

Splits this document into two at the given paragraph's column position and returns both halves.

concat

public ReadOnlyStyledDocument<PS,SEG,S> concat(StyledDocument<PS,SEG,S> other)

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>

replaceMulti

public Tuple3<ReadOnlyStyledDocument<PS,SEG,S>,java.util.List<RichTextChange<PS,SEG,S>>,java.util.List<MaterializedListModification<Paragraph<PS,SEG,S>>>> replaceMulti(java.util.List<Replacement<PS,SEG,S>> replacements)

Replaces multiple portions of this document in an efficient manner and returns

1. the updated version of this document that includes all of the replacements,
2. the List of RichTextChange that represent all the changes from this document to the returned one, and
3. the List of modifications used to update an area's list of paragraphs for each change.

replace

public Tuple3<ReadOnlyStyledDocument<PS,SEG,S>,RichTextChange<PS,SEG,S>,MaterializedListModification<Paragraph<PS,SEG,S>>> replace(Replacement<PS,SEG,S> replacement)

Convenience method for calling replace(int, int, ReadOnlyStyledDocument) with a Replacement argument.

replace

public Tuple3<ReadOnlyStyledDocument<PS,SEG,S>,RichTextChange<PS,SEG,S>,MaterializedListModification<Paragraph<PS,SEG,S>>> replace(int from,
                                                                                                                                                                                   int to,
                                                                                                                                                                                   ReadOnlyStyledDocument<PS,SEG,S> replacement)

Replaces the given portion "from..to" with the given replacement and returns

1. the updated version of this document that includes the replacement,
2. the RichTextChange that represents the change from this document to the returned one, and
3. the modification used to update an area's list of paragraphs.

replace

public Tuple3<ReadOnlyStyledDocument<PS,SEG,S>,RichTextChange<PS,SEG,S>,MaterializedListModification<Paragraph<PS,SEG,S>>> replace(int from,
                                                                                                                                                                                   int to,
                                                                                                                                                                                   java.util.function.UnaryOperator<ReadOnlyStyledDocument<PS,SEG,S>> mapper)

Replaces the given portion "from..to" in the document by getting that portion of this document, passing it into the mapping function, and using the result as the replacement. Returns

1. the updated version of this document that includes the replacement,
2. the RichTextChange that represents the change from this document to the returned one, and
3. the modification used to update an area's list of paragraphs.

replace

public Tuple3<ReadOnlyStyledDocument<PS,SEG,S>,RichTextChange<PS,SEG,S>,MaterializedListModification<Paragraph<PS,SEG,S>>> replace(int paragraphIndex,
                                                                                                                                                                                   int fromCol,
                                                                                                                                                                                   int toCol,
                                                                                                                                                                                   java.util.function.UnaryOperator<ReadOnlyStyledDocument<PS,SEG,S>> f)

replaceParagraph

public Tuple3<ReadOnlyStyledDocument<PS,SEG,S>,RichTextChange<PS,SEG,S>,MaterializedListModification<Paragraph<PS,SEG,S>>> replaceParagraph(int parIdx,
                                                                                                                                                                                            java.util.function.UnaryOperator<Paragraph<PS,SEG,S>> mapper)

Maps the paragraph at the given index by calling replace(int, int, UnaryOperator). Returns

1. the updated version of this document that includes the replacement,
2. the RichTextChange that represents the change from this document to the returned one, and
3. the modification used to update an area's list of paragraphs.

mapParagraphs

public ReadOnlyStyledDocument<PS,SEG,S> mapParagraphs(java.util.function.UnaryOperator<Paragraph<PS,SEG,S>> mapper)

Maps all of this document's paragraphs using the given mapper and returns them in a new ReadOnlyStyledDocument.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public final boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object