An object for encapsulating a selection in a given area.

"Position" refers to the place in-between characters. In other words, every "|" in "|t|e|x|t|" is a valid position. There are two kinds of positions used here:

getStartPosition()/getEndPosition(), which refers to a position somewhere in the entire area's content. It's bounds are 0 <= x <= area.getLength().
getStartColumnPosition()/getEndColumnPosition(), which refers to a position somewhere in the current paragraph. It's bounds are 0 <= x <= area.getParagraphLength(index).

Note: when parameter names are "position" without the "column" prefix, they refer to the position in the entire area.

For type safety, getSelectedDocument() requires the same generic types from StyledDocument. This means that one must write a lot of boilerplate for the generics: Selection<Collection<String>, StyledText<Collection<String>>, Collection<String>> selection. However, this is only necessary if one is using getSelectedDocument() or selectedDocumentProperty(). If you are not going to use the "selectedDocument" getter or property, then just write the much simpler Selection<?, ?, ?> selection.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	Selection.Direction Specifies whether to update the start/end value of a selection to the left (towards 0) or right (away from 0)

Method Summary

Modifier and Type	Method and Description
public ObservableValue<Boolean>	beingUpdatedProperty()
public void	configureSelectionPath(SelectionPath path) Configures a `SelectionPath` that will be used to render a portion or all of this selection on a single paragraph.
public default void	deselect() Clears the selection via `selectRange(getStartPosition(), getStartPosition())`.
public void	dispose() Disposes the selection and prevents memory leaks
public ObservableValue<Integer>	endColumnPositionProperty()
public ObservableValue<Integer>	endParagraphIndexProperty()
public ObservableValue<Integer>	endPositionProperty()
public GenericStyledArea<PS, SEG, S>	getArea() Gets the area with which this selection is associated
public int	getEndColumnPosition()
public int	getEndParagraphIndex()
public int	getEndPosition()
public int	getLength()
public int	getParagraphSpan()
public IndexRange	getRange()
public StyledDocument<PS, SEG, S>	getSelectedDocument()
public String	getSelectedText()
public Optional<Bounds>	getSelectionBounds()
public String	getSelectionName() Gets the name of this selection.
public int	getStartColumnPosition()
public int	getStartParagraphIndex()
public int	getStartPosition()
public boolean	isBeingUpdated()
public ObservableValue<Integer>	lengthProperty() The length of the selection
public ObservableValue<Integer>	paragraphSpanProperty() The number of paragraphs the selection spans
public ObservableValue<IndexRange>	rangeProperty() The start and end positions in the area as an `IndexRange`.
public void	selectAll()
public ObservableValue<StyledDocument<PS, SEG, S>>	selectedDocumentProperty()
public ObservableValue<String>	selectedTextProperty()
public ObservableValue<Optional<Bounds>>	selectionBoundsProperty() The selectionBoundsProperty of the selection in the Screen's coordinate system if something is selected and visible in the viewport, or `Optional#empty()` if selection is not visible in the viewport.
public void	selectParagraph(int paragraphIndex)
public void	selectRange(int startParagraphIndex, int startColPosition, int endParagraphIndex, int endColPosition) Selects the given range.
public void	selectRange(int startPosition, int endPosition) Selects the given range.
public void	selectWord(int wordPositionInArea)
public ObservableValue<Integer>	startColumnPositionProperty()
public ObservableValue<Integer>	startParagraphIndexProperty()
public ObservableValue<Integer>	startPositionProperty()
public void	updateEndBy(int amount, Selection.Direction direction)
public void	updateEndByBreaksBackward(int numOfBreaks, BreakIterator breakIterator)
public void	updateEndByBreaksForward(int numOfBreaks, BreakIterator breakIterator)
public void	updateEndTo(int position)
public void	updateEndTo(int paragraphIndex, int columnPosition)
public void	updateStartBy(int amount, Selection.Direction direction)
public void	updateStartByBreaksBackward(int numOfBreaks, BreakIterator breakIterator)
public void	updateStartByBreaksForward(int numOfBreaks, BreakIterator breakIterator)
public void	updateStartTo(int position)
public void	updateStartTo(int paragraphIndex, int columnPosition)

Method Detail

beingUpdatedProperty	back to summary
public ObservableValue<Boolean> beingUpdatedProperty()

configureSelectionPath	back to summary
public void configureSelectionPath(SelectionPath path) Configures a `SelectionPath` that will be used to render a portion or all of this selection on a single paragraph. When the selection is a multi-paragraph selection, one path will be used to render that portion of the selection on a paragraph.

deselect	back to summary
public default void deselect() Clears the selection via `selectRange(getStartPosition(), getStartPosition())`.

dispose	back to summary
public void dispose() Disposes the selection and prevents memory leaks

endColumnPositionProperty	back to summary
public ObservableValue<Integer> endColumnPositionProperty()

endParagraphIndexProperty	back to summary
public ObservableValue<Integer> endParagraphIndexProperty()

endPositionProperty	back to summary
public ObservableValue<Integer> endPositionProperty()

getArea	back to summary
public GenericStyledArea<PS, SEG, S> getArea() Gets the area with which this selection is associated

getEndColumnPosition	back to summary
public int getEndColumnPosition()

getEndParagraphIndex	back to summary
public int getEndParagraphIndex()

getEndPosition	back to summary
public int getEndPosition()

getLength	back to summary
public int getLength()

getParagraphSpan	back to summary
public int getParagraphSpan()

getRange	back to summary
public IndexRange getRange()

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

getSelectedText	back to summary
public String getSelectedText()

getSelectionBounds	back to summary
public Optional<Bounds> getSelectionBounds()

getSelectionName	back to summary
public String getSelectionName() Gets the name of this selection. Each selection in an area must have a unique name. The name is also used as a StyleClass, so the Selection can be styled using CSS selectors from Path, Shape, and Node eg: .styled-text-area .my-selection { -fx-fill: lime; }

getStartColumnPosition	back to summary
public int getStartColumnPosition()

getStartParagraphIndex	back to summary
public int getStartParagraphIndex()

getStartPosition	back to summary
public int getStartPosition()

isBeingUpdated	back to summary
public boolean isBeingUpdated()

lengthProperty	back to summary
public ObservableValue<Integer> lengthProperty() The length of the selection

paragraphSpanProperty	back to summary
public ObservableValue<Integer> paragraphSpanProperty() The number of paragraphs the selection spans

rangeProperty	back to summary
public ObservableValue<IndexRange> rangeProperty() The start and end positions in the area as an `IndexRange`.

selectAll	back to summary
public void selectAll()

selectedDocumentProperty	back to summary
public ObservableValue<StyledDocument<PS, SEG, S>> selectedDocumentProperty()

selectedTextProperty	back to summary
public ObservableValue<String> selectedTextProperty()

selectionBoundsProperty	back to summary
public ObservableValue<Optional<Bounds>> selectionBoundsProperty() The selectionBoundsProperty of the selection in the Screen's coordinate system if something is selected and visible in the viewport, or `Optional#empty()` if selection is not visible in the viewport.

selectParagraph	back to summary
public void selectParagraph(int paragraphIndex)

selectRange	back to summary
public void selectRange(int startParagraphIndex, int startColPosition, int endParagraphIndex, int endColPosition) Selects the given range. Caution see `TextEditingArea#getAbsolutePosition(int, int)` to know how the column index argument can affect the returned position.

selectRange	back to summary
public void selectRange(int startPosition, int endPosition) Selects the given range.

selectWord	back to summary
public void selectWord(int wordPositionInArea)

startColumnPositionProperty	back to summary
public ObservableValue<Integer> startColumnPositionProperty()

startParagraphIndexProperty	back to summary
public ObservableValue<Integer> startParagraphIndexProperty()

startPositionProperty	back to summary
public ObservableValue<Integer> startPositionProperty()

updateEndBy	back to summary
public void updateEndBy(int amount, Selection.Direction direction)

updateEndByBreaksBackward	back to summary
public void updateEndByBreaksBackward(int numOfBreaks, BreakIterator breakIterator)

updateEndByBreaksForward	back to summary
public void updateEndByBreaksForward(int numOfBreaks, BreakIterator breakIterator)

updateEndTo	back to summary
public void updateEndTo(int position)

updateEndTo	back to summary
public void updateEndTo(int paragraphIndex, int columnPosition)

updateStartBy	back to summary
public void updateStartBy(int amount, Selection.Direction direction)

updateStartByBreaksBackward	back to summary
public void updateStartByBreaksBackward(int numOfBreaks, BreakIterator breakIterator)

updateStartByBreaksForward	back to summary
public void updateStartByBreaksForward(int numOfBreaks, BreakIterator breakIterator)

updateStartTo	back to summary
public void updateStartTo(int position)

updateStartTo	back to summary
public void updateStartTo(int paragraphIndex, int columnPosition)

org.fxmisc.richtext back to summary

public final Enum Selection.Direction

Class Inheritance

extends Enum<Selection.Direction>

java.lang.Object
java.lang.Enum
org.fxmisc.richtext.Selection.Direction

Specifies whether to update the start/end value of a selection to the left (towards 0) or right (away from 0)

Field Summary

Modifier and Type	Field and Description
public static final Selection.Direction	LEFT
public static final Selection.Direction	RIGHT

Constructor Summary

Access	Constructor and Description
private	Direction()

Method Summary

Modifier and Type	Method and Description
public static Selection.Direction	valueOf(String name)
public static Selection.Direction[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

LEFT	back to summary
public static final Selection.Direction LEFT

RIGHT	back to summary
public static final Selection.Direction RIGHT

Constructor Detail

Direction	back to summary
private Direction()

Method Detail

valueOf	back to summary
public static Selection.Direction valueOf(String name)

values	back to summary
public static Selection.Direction[] values()

public Interface Selection<PS, SEG, S>

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum Selection.Direction

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail