Modifier and Type	Class and Description
private class	ReadOnlyStyledDocument.Pos
private static class	ReadOnlyStyledDocument.Summary Private class used for calculating `TwoDimensional.Position`s within this document.

Modifier and Type	Field and Description
private static final Pattern	LINE_TERMINATOR
private static final BiFunction<ReadOnlyStyledDocument.Summary, Integer, Either<Integer, Integer>>	NAVIGATE
private List<Paragraph<PS, SEG, S>>	paragraphs
private String	text
private final FingerTree.NonEmptyFingerTree<Paragraph<PS, SEG, S>, ReadOnlyStyledDocument.Summary>	tree

Access	Constructor and Description
private	ReadOnlyStyledDocument(FingerTree.NonEmptyFingerTree<Paragraph<PS, SEG, S>, ReadOnlyStyledDocument.Summary> tree)
pack-priv	ReadOnlyStyledDocument(List<Paragraph<PS, SEG, S>> paragraphs)

Method Summary

Modifier and Type	Method and Description
public static < The type of the paragraph style. PS, The type of the segments in the paragraph (e.g. `String`). SEG, The type of the style of individual segments. S> Codec<StyledDocument<PS, SEG, S>>	codec(Codec<PS> the codec for serializing a `Paragraph` pCodec, Codec<StyledSegment<SEG, S>> the codec for serializing a `StyledSegment` segCodec, SegmentOps<SEG, S> the operations object for operating on segments segmentOps) Defines a codec for serializing a `ReadOnlyStyledDocument`.
public ReadOnlyStyledDocument<PS, SEG, S>	concat(StyledDocument<PS, SEG, S> other) Implements org.fxmisc.richtext.model.StyledDocument.concat.
private ReadOnlyStyledDocument<PS, SEG, S>	concat0(StyledDocument<PS, SEG, S> other, BinaryOperator<Paragraph<PS, SEG, S>> parConcat)
private ReadOnlyStyledDocument<PS, SEG, S>	concatR(StyledDocument<PS, SEG, S> other)
private void	ensureValidParagraphIndex(int parIdx)
private void	ensureValidParagraphRange(int par, int start, int end)
private void	ensureValidRange(int start, int end)
public final boolean	equals(Object other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static < The type of the paragraph style. PS, The type of the segments in the paragraph (e.g. `String`). SEG, The type of the style of individual segments. S> ReadOnlyStyledDocument<PS, SEG, S>	from(StyledDocument<PS, SEG, S> doc) Creates a `ReadOnlyStyledDocument` from the given `StyledDocument`.
public static < The type of the paragraph style. PS, The type of the segments in the paragraph (e.g. `String`). SEG, The type of the style of individual segments. S> ReadOnlyStyledDocument<PS, SEG, S>	fromSegment(SEG the only segment in the only paragraph in the document segment, PS the paragraph style to use for each paragraph in the returned document paragraphStyle, S the style to use for each segment in the document style, SegmentOps<SEG, S> the operations object that can create a segment froma given text segmentOps) Creates a `ReadOnlyStyledDocument` from the given segment.
public static < The type of the paragraph style. PS, The type of the segments in the paragraph (e.g. `String`). SEG, The type of the style of individual segments. S> ReadOnlyStyledDocument<PS, SEG, S>	fromString(String the text to use to create the segments str, PS the paragraph style to use for each paragraph in the returned document paragraphStyle, S the style to use for each segment in the document style, TextOps<SEG, S> the operations object that can create a segment froma given text segmentOps) Creates a `ReadOnlyStyledDocument` from the given string.
private int	fullLength(int par)
public Paragraph<PS, SEG, S>	getParagraph(int index) Overrides default org.fxmisc.richtext.model.StyledDocument.getParagraph.
public int	getParagraphCount()
public List<Paragraph<PS, SEG, S>>	getParagraphs() Implements org.fxmisc.richtext.model.StyledDocument.getParagraphs.
public String	getText() Implements org.fxmisc.richtext.model.StyledDocument.getText.
public final int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	length() Implements org.fxmisc.richtext.model.StyledDocument.length.
public ReadOnlyStyledDocument<PS, SEG, S>	mapParagraphs(UnaryOperator<Paragraph<PS, SEG, S>> mapper) Maps all of this document's paragraphs using the given mapper and returns them in a new `ReadOnlyStyledDocument`.
public TwoDimensional.Position	offsetToPosition(int offset, TwoDimensional.Bias bias) Implements org.fxmisc.richtext.model.TwoDimensional.offsetToPosition. 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.
private static <PS, SEG, S> Codec<Paragraph<PS, SEG, S>>	paragraphCodec(Codec<PS> pCodec, Codec<StyledSegment<SEG, S>> segCodec, SegmentOps<SEG, S> segmentOps)
public TwoDimensional.Position	position(int major, int minor) Implements org.fxmisc.richtext.model.TwoDimensional.position. 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.
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.
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 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.
public Tuple3<ReadOnlyStyledDocument<PS, SEG, S>, RichTextChange<PS, SEG, S>, MaterializedListModification<Paragraph<PS, SEG, S>>>	replace(int from, int to, 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.
public Tuple3<ReadOnlyStyledDocument<PS, SEG, S>, RichTextChange<PS, SEG, S>, MaterializedListModification<Paragraph<PS, SEG, S>>>	replace(int paragraphIndex, int fromCol, int toCol, UnaryOperator<ReadOnlyStyledDocument<PS, SEG, S>> f)
private Tuple3<ReadOnlyStyledDocument<PS, SEG, S>, RichTextChange<PS, SEG, S>, MaterializedListModification<Paragraph<PS, SEG, S>>>	replace(BiIndex start, BiIndex end, UnaryOperator<ReadOnlyStyledDocument<PS, SEG, S>> f)
public Tuple3<ReadOnlyStyledDocument<PS, SEG, S>, List<RichTextChange<PS, SEG, S>>, List<MaterializedListModification<Paragraph<PS, SEG, S>>>>	replaceMulti(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.
public Tuple3<ReadOnlyStyledDocument<PS, SEG, S>, RichTextChange<PS, SEG, S>, MaterializedListModification<Paragraph<PS, SEG, S>>>	replaceParagraph(int parIdx, UnaryOperator<Paragraph<PS, SEG, S>> mapper) Maps the paragraph at the given index by calling `replace(int, int, UnaryOperator)`.
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.
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.
public StyledDocument<PS, SEG, S>	subSequence(int start, int end) Implements org.fxmisc.richtext.model.StyledDocument.subSequence.
private static <PS, SEG, S> ToSemigroup<Paragraph<PS, SEG, S>, ReadOnlyStyledDocument.Summary>	summaryProvider() Private method for quickly calculating the length of a portion (subdocument) of this document.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

LINE_TERMINATOR	back to summary
private static final Pattern LINE_TERMINATOR

NAVIGATE	back to summary
private static final BiFunction<ReadOnlyStyledDocument.Summary, Integer, Either<Integer, Integer>> NAVIGATE

paragraphs	back to summary
private List<Paragraph<PS, SEG, S>> paragraphs

text	back to summary
private String text

tree	back to summary
private final FingerTree.NonEmptyFingerTree<Paragraph<PS, SEG, S>, ReadOnlyStyledDocument.Summary> tree

Constructor Detail

ReadOnlyStyledDocument	back to summary
private ReadOnlyStyledDocument(FingerTree.NonEmptyFingerTree<Paragraph<PS, SEG, S>, ReadOnlyStyledDocument.Summary> tree)

ReadOnlyStyledDocument	back to summary
pack-priv ReadOnlyStyledDocument(List<Paragraph<PS, SEG, S>> paragraphs)

Method Detail

codec back to summary

codec	back to summary
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`. 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. pCodec:Codec<PS> the codec for serializing a `Paragraph` segCodec:Codec<StyledSegment<SEG, S>> the codec for serializing a `StyledSegment` segmentOps:SegmentOps<SEG, S> the operations object for operating on segments

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.

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.
pCodec:Codec<PS>: the codec for serializing a Paragraph
segCodec:Codec<StyledSegment<SEG, S>>: the codec for serializing a StyledSegment
segmentOps:SegmentOps<SEG, S>: the operations object for operating on segments

concat	back to summary
public ReadOnlyStyledDocument<PS, SEG, S> concat(StyledDocument<PS, SEG, S> other) Implements org.fxmisc.richtext.model.StyledDocument.concat. Annotations @Override

concat

back to summary

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

Implements org.fxmisc.richtext.model.StyledDocument.concat.

Annotations

@Override

concat0	back to summary
private ReadOnlyStyledDocument<PS, SEG, S> concat0(StyledDocument<PS, SEG, S> other, BinaryOperator<Paragraph<PS, SEG, S>> parConcat)

concatR	back to summary
private ReadOnlyStyledDocument<PS, SEG, S> concatR(StyledDocument<PS, SEG, S> other)

ensureValidParagraphIndex	back to summary
private void ensureValidParagraphIndex(int parIdx)

ensureValidParagraphRange	back to summary
private void ensureValidParagraphRange(int par, int start, int end)

ensureValidRange	back to summary
private void ensureValidRange(int start, int end)

equals back to summary

equals	back to summary
public final boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public final boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

from back to summary

from	back to summary
public static <PS, SEG, S> ReadOnlyStyledDocument<PS, SEG, S> from(StyledDocument<PS, SEG, S> doc) Creates a `ReadOnlyStyledDocument` from the given `StyledDocument`. 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.

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

Creates a ReadOnlyStyledDocument from the given StyledDocument.

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.

fromSegment back to summary

fromSegment	back to summary
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. 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. segment:SEG the only segment in the only paragraph in the document paragraphStyle:PS the paragraph style to use for each paragraph in the returned document style:S the style to use for each segment in the document segmentOps:SegmentOps<SEG, S> the operations object that can create a segment froma given text

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.

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.
segment:SEG: the only segment in the only paragraph in the document
paragraphStyle:PS: the paragraph style to use for each paragraph in the returned document
style:S: the style to use for each segment in the document
segmentOps:SegmentOps<SEG, S>: the operations object that can create a segment froma given text

fromString back to summary

fromString	back to summary
public static <PS, SEG, S> ReadOnlyStyledDocument<PS, SEG, S> fromString(String str, PS paragraphStyle, S style, TextOps<SEG, S> segmentOps) Creates a `ReadOnlyStyledDocument` from the given string. 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. str:String the text to use to create the segments paragraphStyle:PS the paragraph style to use for each paragraph in the returned document style:S the style to use for each segment in the document segmentOps:TextOps<SEG, S> the operations object that can create a segment froma given text

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

Creates a ReadOnlyStyledDocument from the given string.

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.
str:String: the text to use to create the segments
paragraphStyle:PS: the paragraph style to use for each paragraph in the returned document
style:S: the style to use for each segment in the document
segmentOps:TextOps<SEG, S>: the operations object that can create a segment froma given text

fullLength	back to summary
private int fullLength(int par)

getParagraph	back to summary
public Paragraph<PS, SEG, S> getParagraph(int index) Overrides default org.fxmisc.richtext.model.StyledDocument.getParagraph.

getParagraphCount	back to summary
public int getParagraphCount()

getParagraphs	back to summary
public List<Paragraph<PS, SEG, S>> getParagraphs() Implements org.fxmisc.richtext.model.StyledDocument.getParagraphs. Annotations @Override

getParagraphs

back to summary

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

Implements org.fxmisc.richtext.model.StyledDocument.getParagraphs.

Annotations

@Override

getText	back to summary
public String getText() Implements org.fxmisc.richtext.model.StyledDocument.getText. Annotations @Override

getText

back to summary

public String getText()

Implements org.fxmisc.richtext.model.StyledDocument.getText.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public final int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public final int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

length	back to summary
public int length() Implements org.fxmisc.richtext.model.StyledDocument.length. Annotations @Override

length

back to summary

public int length()

Implements org.fxmisc.richtext.model.StyledDocument.length.

Annotations

@Override

mapParagraphs	back to summary
public ReadOnlyStyledDocument<PS, SEG, S> mapParagraphs(UnaryOperator<Paragraph<PS, SEG, S>> mapper) Maps all of this document's paragraphs using the given mapper and returns them in a new `ReadOnlyStyledDocument`.

offsetToPosition back to summary

offsetToPosition	back to summary
public TwoDimensional.Position offsetToPosition(int offset, TwoDimensional.Bias bias) Implements org.fxmisc.richtext.model.TwoDimensional.offsetToPosition. Doc from org.fxmisc.richtext.model.TwoDimensional.offsetToPosition. 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. Annotations @Override

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

Implements org.fxmisc.richtext.model.TwoDimensional.offsetToPosition.

Doc from org.fxmisc.richtext.model.TwoDimensional.offsetToPosition.

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.

Annotations

@Override

paragraphCodec	back to summary
private static <PS, SEG, S> Codec<Paragraph<PS, SEG, S>> paragraphCodec(Codec<PS> pCodec, Codec<StyledSegment<SEG, S>> segCodec, SegmentOps<SEG, S> segmentOps)

position back to summary

position	back to summary
public TwoDimensional.Position position(int major, int minor) Implements org.fxmisc.richtext.model.TwoDimensional.position. Doc from org.fxmisc.richtext.model.TwoDimensional.position. 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. Annotations @Override

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

Implements org.fxmisc.richtext.model.TwoDimensional.position.

Doc from org.fxmisc.richtext.model.TwoDimensional.position.

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.

Annotations

@Override

replace	back to summary
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 back to summary

replace	back to summary
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 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.

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

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.

replace back to summary

replace	back to summary
public Tuple3<ReadOnlyStyledDocument<PS, SEG, S>, RichTextChange<PS, SEG, S>, MaterializedListModification<Paragraph<PS, SEG, S>>> replace(int from, int to, 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 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.

public Tuple3<ReadOnlyStyledDocument<PS, SEG, S>, RichTextChange<PS, SEG, S>, MaterializedListModification<Paragraph<PS, SEG, S>>> replace(int from, int to, 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

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.

replace	back to summary
public Tuple3<ReadOnlyStyledDocument<PS, SEG, S>, RichTextChange<PS, SEG, S>, MaterializedListModification<Paragraph<PS, SEG, S>>> replace(int paragraphIndex, int fromCol, int toCol, UnaryOperator<ReadOnlyStyledDocument<PS, SEG, S>> f)

replace	back to summary
private Tuple3<ReadOnlyStyledDocument<PS, SEG, S>, RichTextChange<PS, SEG, S>, MaterializedListModification<Paragraph<PS, SEG, S>>> replace(BiIndex start, BiIndex end, UnaryOperator<ReadOnlyStyledDocument<PS, SEG, S>> f)

replaceMulti back to summary

replaceMulti	back to summary
public Tuple3<ReadOnlyStyledDocument<PS, SEG, S>, List<RichTextChange<PS, SEG, S>>, List<MaterializedListModification<Paragraph<PS, SEG, S>>>> replaceMulti(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.

public Tuple3<ReadOnlyStyledDocument<PS, SEG, S>, List<RichTextChange<PS, SEG, S>>, List<MaterializedListModification<Paragraph<PS, SEG, S>>>> replaceMulti(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.

replaceParagraph back to summary

replaceParagraph	back to summary
public Tuple3<ReadOnlyStyledDocument<PS, SEG, S>, RichTextChange<PS, SEG, S>, MaterializedListModification<Paragraph<PS, SEG, S>>> replaceParagraph(int parIdx, UnaryOperator<Paragraph<PS, SEG, S>> mapper) Maps the paragraph at the given index by calling `replace(int, int, UnaryOperator)`. 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.

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

Maps the paragraph at the given index by calling replace(int, int, UnaryOperator). 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.

split	back to summary
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	back to summary
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.

subSequence	back to summary
public StyledDocument<PS, SEG, S> subSequence(int start, int end) Implements org.fxmisc.richtext.model.StyledDocument.subSequence. Annotations @Override

subSequence

back to summary

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

Implements org.fxmisc.richtext.model.StyledDocument.subSequence.

Annotations

@Override

summaryProvider	back to summary
private static <PS, SEG, S> ToSemigroup<Paragraph<PS, SEG, S>, ReadOnlyStyledDocument.Summary> summaryProvider() Private method for quickly calculating the length of a portion (subdocument) of this document.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

org.fxmisc.richtext.model back to summary

private Class ReadOnlyStyledDocument.Pos

Class Inheritance

extends Object
implements Position

java.lang.Object
org.fxmisc.richtext.model.ReadOnlyStyledDocument.Pos

All Implemented Interfaces

org.fxmisc.richtext.model.TwoDimensional.Position

Field Summary

Modifier and Type	Field and Description
private final int	major
private final int	minor

Constructor Summary

Access	Constructor and Description
private	Pos(int major, int minor)

Method Summary

Modifier and Type	Method and Description
public TwoDimensional.Position	clamp() Implements org.fxmisc.richtext.model.TwoDimensional.Position.clamp. Returns a new position which clamps the minor position to be valid given the major position.
public int	getMajor() Implements org.fxmisc.richtext.model.TwoDimensional.Position.getMajor. The major dimension, e.g. paragraph number within a document
public int	getMinor() Implements org.fxmisc.richtext.model.TwoDimensional.Position.getMinor. The minor dimension, e.g. segment index or column offset within a paragraph.
public TwoDimensional	getTargetObject() Implements org.fxmisc.richtext.model.TwoDimensional.Position.getTargetObject. The TwoDimensional object that this position refers to.
public TwoDimensional.Position	offsetBy(int amount, TwoDimensional.Bias bias) Implements org.fxmisc.richtext.model.TwoDimensional.Position.offsetBy. Returns a new position that offsets this position by the given amount
public boolean	sameAs(TwoDimensional.Position other) Implements org.fxmisc.richtext.model.TwoDimensional.Position.sameAs. Returns `true` if the given position is equal to this position, that is they both point to the same place in the same two-dimensional object.
public int	toOffset() Implements org.fxmisc.richtext.model.TwoDimensional.Position.toOffset. Converts this position to an overall offset within the original TwoDimensional item (to which `getTargetObject` refers).
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

major	back to summary
private final int major

minor	back to summary
private final int minor

Constructor Detail

Pos	back to summary
private Pos(int major, int minor)

Method Detail

clamp

back to summary

public TwoDimensional.Position clamp()

Implements org.fxmisc.richtext.model.TwoDimensional.Position.clamp.

Doc from org.fxmisc.richtext.model.TwoDimensional.Position.clamp.

Returns a new position which clamps the minor position to be valid given the major position. (i.e. if the position is beyond the end of a given paragraph, moves the position back to the end of the paragraph).

Annotations

@Override

getMajor

back to summary

public int getMajor()

Implements org.fxmisc.richtext.model.TwoDimensional.Position.getMajor.

Doc from org.fxmisc.richtext.model.TwoDimensional.Position.getMajor.

The major dimension, e.g. paragraph number within a document

Annotations

@Override

getMinor

back to summary

public int getMinor()

Implements org.fxmisc.richtext.model.TwoDimensional.Position.getMinor.

Doc from org.fxmisc.richtext.model.TwoDimensional.Position.getMinor.

The minor dimension, e.g. segment index or column offset within a paragraph.

Annotations

@Override

getTargetObject

back to summary

public TwoDimensional getTargetObject()

Implements org.fxmisc.richtext.model.TwoDimensional.Position.getTargetObject.

Doc from org.fxmisc.richtext.model.TwoDimensional.Position.getTargetObject.

The TwoDimensional object that this position refers to.

Annotations

@Override

offsetBy

back to summary

public TwoDimensional.Position offsetBy(int amount, TwoDimensional.Bias bias)

Implements org.fxmisc.richtext.model.TwoDimensional.Position.offsetBy.

Doc from org.fxmisc.richtext.model.TwoDimensional.Position.offsetBy.

Returns a new position that offsets this position by the given amount

Annotations

@Override

sameAs back to summary

public boolean sameAs(TwoDimensional.Position other)

Implements org.fxmisc.richtext.model.TwoDimensional.Position.sameAs.

Doc from org.fxmisc.richtext.model.TwoDimensional.Position.sameAs.

Returns true if the given position is equal to this position, that is they both point to the same place in the same two-dimensional object. Otherwise returns false.

Annotations

@Override

toOffset back to summary

public int toOffset()

Implements org.fxmisc.richtext.model.TwoDimensional.Position.toOffset.

Doc from org.fxmisc.richtext.model.TwoDimensional.Position.toOffset.

Converts this position to an overall offset within the original TwoDimensional item (to which getTargetObject refers). For example, moving a caret to a relative position (paragraph 2, column 3) might result in the offset value (absolute position) of 28.

Annotations

@Override

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public final Class ReadOnlyStyledDocument<PS, SEG, S>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ReadOnlyStyledDocument.Pos

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ReadOnlyStyledDocument.Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail