RichTextFX 0.11.5 · org.fxmisc.richtext.model.StyledDocument

Method Summary

Modifier and Type	Method and Description
public default char	charAt(int index)
public StyledDocument<PS, SEG, S>	concat(StyledDocument<PS, SEG, S> that)
public default int	getAbsolutePosition(int The index of the paragraph from which to start. paragraphIndex, int If positive, the index going forward (the given paragraph's line or the next one(s)). If negative, the index going backward (the previous paragraph's line(s)) columnPosition) Returns the absolute position (i.e. the spot in-between characters) of the given column position in the given paragraph.
public default Paragraph<PS, SEG, S>	getParagraph(int index)
public default int	getParagraphLength(int paragraphIndex)
public List<Paragraph<PS, SEG, S>>	getParagraphs()
public default PS	getParagraphStyle(int paragraph)
public default PS	getParagraphStyleAtPosition(int position)
public default S	getStyleAtPosition(int position)
public default S	getStyleAtPosition(int paragraph, int position)
public default S	getStyleOfChar(int index)
public default S	getStyleOfChar(int paragraph, int column)
public default IndexRange	getStyleRangeAtPosition(int position)
public default IndexRange	getStyleRangeAtPosition(int paragraph, int position)
public default StyleSpans<S>	getStyleSpans(int from, int to)
public default StyleSpans<S>	getStyleSpans(int paragraph)
public default StyleSpans<S>	getStyleSpans(int paragraph, int from, int to)
public String	getText()
public default String	getText(IndexRange range)
public default String	getText(int start, int end)
public default String	getText(int paragraphIndex)
public int	length()
public default StyledDocument<PS, SEG, S>	subDocument(int paragraphIndex)
public StyledDocument<PS, SEG, S>	subSequence(int start, int end)
public default StyledDocument<PS, SEG, S>	subSequence(IndexRange range)

Inherited from org.fxmisc.richtext.model.TwoDimensional:: offsetToPosition position

Method Detail

charAt	back to summary
public default char charAt(int index)

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

getAbsolutePosition back to summary

getAbsolutePosition	back to summary
public default int getAbsolutePosition(int paragraphIndex, int columnPosition) Returns the absolute position (i.e. the spot in-between characters) of the given column position in the given paragraph. For example, given a text with only one line `"text"` and a `columnPosition` value of `1`, the value, `1`, as in "position 1" would be returned: ┌ character index 0 \| ┌ character index 1 \| \| ┌ character index 3 \| \| \| v v v \|t\|e\|x\|t\| ^ ^ ^ \| \| \| \| \| └ position 4 \| └ position 1 └ position 0 Warning: Off-By-One errors can easily occur If the column index spans outside of the given paragraph's length, the returned value will pass on to the previous/next paragraph. In other words, given a document with two paragraphs (where the first paragraph's text is "some" and the second "thing"), then the following statements are true: `getAbsolutePosition(0, "some".length()) == 4 == getAbsolutePosition(1, -1)` `getAbsolutePosition(0, "some".length() + 1) == 5 == getAbsolutePosition(1, 0)` Parameters paragraphIndex:int The index of the paragraph from which to start. columnPosition:int If positive, the index going forward (the given paragraph's line or the next one(s)). If negative, the index going backward (the previous paragraph's line(s))

public default int getAbsolutePosition(int paragraphIndex, int columnPosition)

Returns the absolute position (i.e. the spot in-between characters) of the given column position in the given paragraph.

For example, given a text with only one line "text" and a columnPosition value of 1, the value, 1, as in "position 1" would be returned:

 ┌ character index 0
 | ┌ character index 1
 | |   ┌ character index 3
 | |   |
 v v   v

|t|e|x|t|

^ ^     ^
| |     |
| |     └ position 4
| └ position 1
└ position 0

Warning: Off-By-One errors can easily occur

If the column index spans outside of the given paragraph's length, the returned value will pass on to the previous/next paragraph. In other words, given a document with two paragraphs (where the first paragraph's text is "some" and the second "thing"), then the following statements are true:

getAbsolutePosition(0, "some".length()) == 4 == getAbsolutePosition(1, -1)
getAbsolutePosition(0, "some".length() + 1) == 5 == getAbsolutePosition(1, 0)

Parameters

paragraphIndex:int: The index of the paragraph from which to start.
columnPosition:int: If positive, the index going forward (the given paragraph's line or the next one(s)). If negative, the index going backward (the previous paragraph's line(s))

getParagraph	back to summary
public default Paragraph<PS, SEG, S> getParagraph(int index)

getParagraphLength	back to summary
public default int getParagraphLength(int paragraphIndex)

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

getParagraphStyle	back to summary
public default PS getParagraphStyle(int paragraph)

getParagraphStyleAtPosition	back to summary
public default PS getParagraphStyleAtPosition(int position)

getStyleAtPosition	back to summary
public default S getStyleAtPosition(int position)

getStyleAtPosition	back to summary
public default S getStyleAtPosition(int paragraph, int position)

getStyleOfChar	back to summary
public default S getStyleOfChar(int index)

getStyleOfChar	back to summary
public default S getStyleOfChar(int paragraph, int column)

getStyleRangeAtPosition	back to summary
public default IndexRange getStyleRangeAtPosition(int position)

getStyleRangeAtPosition	back to summary
public default IndexRange getStyleRangeAtPosition(int paragraph, int position)

getStyleSpans	back to summary
public default StyleSpans<S> getStyleSpans(int from, int to)

getStyleSpans	back to summary
public default StyleSpans<S> getStyleSpans(int paragraph)

getStyleSpans	back to summary
public default StyleSpans<S> getStyleSpans(int paragraph, int from, int to)

getText	back to summary
public String getText()

getText	back to summary
public default String getText(IndexRange range)

getText	back to summary
public default String getText(int start, int end)

getText	back to summary
public default String getText(int paragraphIndex)

length	back to summary
public int length()

subDocument	back to summary
public default StyledDocument<PS, SEG, S> subDocument(int paragraphIndex)

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

subSequence	back to summary
public default StyledDocument<PS, SEG, S> subSequence(IndexRange range)

public Interface StyledDocument<PS, SEG, S>

Method Summary

Method Detail

Warning: Off-By-One errors can easily occur