RichTextFX 0.11.5 · org.fxmisc.richtext.SelectionImpl

Field Summary

Modifier and Type	Field and Description
private final GenericStyledArea<PS, SEG, S>	area
private final SuspendableNo	beingUpdated
private final SuspendableVal<Optional<Bounds>>	bounds
private final Consumer<SelectionPath>	configurePath
private final SuspendableNo	dependentBeingUpdated
private final EventStream<?>	dirty
private final Val<TwoDimensional.Position>	end2DPosition
private final Val<Integer>	endColumnPosition
private final Val<Integer>	endParagraphIndex
private final SuspendableVal<Integer>	endPosition
private final Var<IndexRange>	internalRange
private final SuspendableVal<Integer>	length
private final String	name
private final Val<Integer>	paragraphSpan
private final SuspendableVal<IndexRange>	range
private final SuspendableVal<StyledDocument<PS, SEG, S>>	selectedDocument
private final SuspendableVal<String>	selectedText
private final Var<TwoDimensional.Position>	start2DPosition
private final Val<Integer>	startColumnPosition
private final Val<Integer>	startParagraphIndex
private final SuspendableVal<Integer>	startPosition
private Subscription	subscription

Constructor Summary

Access	Constructor and Description
public	SelectionImpl(String must be unique and is also used as a StyleClass for configuration via CSS using selectors from Path, Shape, and Node. name, GenericStyledArea<PS, SEG, S> area) Creates a selection with both the start and end position at 0.
public	SelectionImpl(String name, GenericStyledArea<PS, SEG, S> area, Consumer<SelectionPath> configurePath) Creates a selection with customized configuration via `configurePath` with both the start and end position at 0.
public	SelectionImpl(String name, GenericStyledArea<PS, SEG, S> area, int startPosition, int endPosition) Creates a selection.
pack-priv	SelectionImpl(String name, GenericStyledArea<PS, SEG, S> area, int startPosition, int endPosition, SuspendableNo dependentBeingUpdated) Creates a selection that is to be used in a `CaretSelectionBind`.
pack-priv	SelectionImpl(String name, GenericStyledArea<PS, SEG, S> area, int startPosition, int endPosition, SuspendableNo dependentBeingUpdated, Consumer<SelectionPath> configurePath) Creates a selection that is to be used in a `CaretSelectionBind` with customized configuration.
pack-priv	SelectionImpl(String name, GenericStyledArea<PS, SEG, S> area, IndexRange range, SuspendableNo dependentBeingUpdated) Creates a selection that is to be used in a `CaretSelectionBind`.
pack-priv	SelectionImpl(String name, GenericStyledArea<PS, SEG, S> area, IndexRange range, SuspendableNo dependentBeingUpdated, Consumer<SelectionPath> configurePath) Creates a selection that is to be used in a `CaretSelectionBind` with customized configuration and starting at the given range.

Method Summary

Modifier and Type	Method and Description
public final ObservableValue<Boolean>	beingUpdatedProperty() Implements org.fxmisc.richtext.Selection.beingUpdatedProperty.
public int	compareTo(SelectionImpl<PS, SEG, S> o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public void	configureSelectionPath(SelectionPath path) Implements org.fxmisc.richtext.Selection.configureSelectionPath. Configures a `SelectionPath` that will be used to render a portion or all of this selection on a single paragraph.
public void	dispose() Implements org.fxmisc.richtext.Selection.dispose. Disposes the selection and prevents memory leaks
public final ObservableValue<Integer>	endColumnPositionProperty() Implements org.fxmisc.richtext.Selection.endColumnPositionProperty.
public final ObservableValue<Integer>	endParagraphIndexProperty() Implements org.fxmisc.richtext.Selection.endParagraphIndexProperty.
public final ObservableValue<Integer>	endPositionProperty() Implements org.fxmisc.richtext.Selection.endPositionProperty.
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public GenericStyledArea<PS, SEG, S>	getArea() Implements org.fxmisc.richtext.Selection.getArea. Gets the area with which this selection is associated
public final int	getEndColumnPosition() Implements org.fxmisc.richtext.Selection.getEndColumnPosition.
public final int	getEndParagraphIndex() Implements org.fxmisc.richtext.Selection.getEndParagraphIndex.
public final int	getEndPosition() Implements org.fxmisc.richtext.Selection.getEndPosition.
public final int	getLength() Implements org.fxmisc.richtext.Selection.getLength.
public final int	getParagraphSpan() Implements org.fxmisc.richtext.Selection.getParagraphSpan.
public final IndexRange	getRange() Implements org.fxmisc.richtext.Selection.getRange.
public final StyledDocument<PS, SEG, S>	getSelectedDocument() Implements org.fxmisc.richtext.Selection.getSelectedDocument.
public final String	getSelectedText() Implements org.fxmisc.richtext.Selection.getSelectedText.
public final Optional<Bounds>	getSelectionBounds() Implements org.fxmisc.richtext.Selection.getSelectionBounds.
public String	getSelectionName() Implements org.fxmisc.richtext.Selection.getSelectionName. Gets the name of this selection.
public final int	getStartColumnPosition() Implements org.fxmisc.richtext.Selection.getStartColumnPosition.
public final int	getStartParagraphIndex() Implements org.fxmisc.richtext.Selection.getStartParagraphIndex.
public final int	getStartPosition() Implements org.fxmisc.richtext.Selection.getStartPosition.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public final boolean	isBeingUpdated() Implements org.fxmisc.richtext.Selection.isBeingUpdated.
public final ObservableValue<Integer>	lengthProperty() Implements org.fxmisc.richtext.Selection.lengthProperty. The length of the selection
private <T> void	manageSubscription(EventStream<T> stream, Consumer<T> consumer)
private void	manageSubscription(Subscription s)
private void	moveBoundary(Selection.Direction direction, int amount, int oldBoundaryPosition, Function<Integer, IndexRange> updatedRange)
private void	moveBoundary(IntSupplier textPosition, Function<Integer, Boolean> boundsCheckPasses, Function<Integer, IndexRange> updatedRange)
public final ObservableValue<Integer>	paragraphSpanProperty() Implements org.fxmisc.richtext.Selection.paragraphSpanProperty. The number of paragraphs the selection spans
public final ObservableValue<IndexRange>	rangeProperty() Implements org.fxmisc.richtext.Selection.rangeProperty. The start and end positions in the area as an `IndexRange`.
public void	selectAll() Implements org.fxmisc.richtext.Selection.selectAll.
public final ObservableValue<StyledDocument<PS, SEG, S>>	selectedDocumentProperty() Implements org.fxmisc.richtext.Selection.selectedDocumentProperty.
public final ObservableValue<String>	selectedTextProperty() Implements org.fxmisc.richtext.Selection.selectedTextProperty.
public final ObservableValue<Optional<Bounds>>	selectionBoundsProperty() Implements org.fxmisc.richtext.Selection.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) Implements org.fxmisc.richtext.Selection.selectParagraph.
public void	selectRange(int startParagraphIndex, int startColPosition, int endParagraphIndex, int endColPosition) Implements org.fxmisc.richtext.Selection.selectRange. Selects the given range.
public void	selectRange(int startPosition, int endPosition) Implements org.fxmisc.richtext.Selection.selectRange. Selects the given range.
private void	selectRange(IndexRange range)
public void	selectWord(int wordPositionInArea) Implements org.fxmisc.richtext.Selection.selectWord.
public final ObservableValue<Integer>	startColumnPositionProperty() Implements org.fxmisc.richtext.Selection.startColumnPositionProperty.
public final ObservableValue<Integer>	startParagraphIndexProperty() Implements org.fxmisc.richtext.Selection.startParagraphIndexProperty.
public final ObservableValue<Integer>	startPositionProperty() Implements org.fxmisc.richtext.Selection.startPositionProperty.
private int	textPosition(int row, int col)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	updateEndBy(int amount, Selection.Direction direction) Implements org.fxmisc.richtext.Selection.updateEndBy.
private void	updateEndByBreaks(int numOfBreaks, BreakIterator breakIterator, boolean forwardsNotBackwards)
public void	updateEndByBreaksBackward(int numOfBreaks, BreakIterator breakIterator) Implements org.fxmisc.richtext.Selection.updateEndByBreaksBackward.
public void	updateEndByBreaksForward(int numOfBreaks, BreakIterator breakIterator) Implements org.fxmisc.richtext.Selection.updateEndByBreaksForward.
public void	updateEndTo(int position) Implements org.fxmisc.richtext.Selection.updateEndTo.
public void	updateEndTo(int paragraphIndex, int columnPosition) Implements org.fxmisc.richtext.Selection.updateEndTo.
private void	updateSelectionByBreaks(int numOfBreaks, BreakIterator breakIterator, boolean followingNotPreceding, boolean updateStartNotEnd)
public void	updateStartBy(int amount, Selection.Direction direction) Implements org.fxmisc.richtext.Selection.updateStartBy.
private void	updateStartByBreaks(int numOfBreaks, BreakIterator breakIterator, boolean forwardsNotBackwards)
public void	updateStartByBreaksBackward(int numOfBreaks, BreakIterator breakIterator) Implements org.fxmisc.richtext.Selection.updateStartByBreaksBackward.
public void	updateStartByBreaksForward(int numOfBreaks, BreakIterator breakIterator) Implements org.fxmisc.richtext.Selection.updateStartByBreaksForward.
public void	updateStartTo(int position) Implements org.fxmisc.richtext.Selection.updateStartTo.
public void	updateStartTo(int paragraphIndex, int columnPosition) Implements org.fxmisc.richtext.Selection.updateStartTo.

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

Field Detail

area	back to summary
private final GenericStyledArea<PS, SEG, S> area

beingUpdated	back to summary
private final SuspendableNo beingUpdated

bounds	back to summary
private final SuspendableVal<Optional<Bounds>> bounds

configurePath	back to summary
private final Consumer<SelectionPath> configurePath

dependentBeingUpdated	back to summary
private final SuspendableNo dependentBeingUpdated

dirty	back to summary
private final EventStream<?> dirty

end2DPosition	back to summary
private final Val<TwoDimensional.Position> end2DPosition

endColumnPosition	back to summary
private final Val<Integer> endColumnPosition

endParagraphIndex	back to summary
private final Val<Integer> endParagraphIndex

endPosition	back to summary
private final SuspendableVal<Integer> endPosition

internalRange	back to summary
private final Var<IndexRange> internalRange

length	back to summary
private final SuspendableVal<Integer> length

name	back to summary
private final String name

paragraphSpan	back to summary
private final Val<Integer> paragraphSpan

range	back to summary
private final SuspendableVal<IndexRange> range

selectedDocument	back to summary
private final SuspendableVal<StyledDocument<PS, SEG, S>> selectedDocument

selectedText	back to summary
private final SuspendableVal<String> selectedText

start2DPosition	back to summary
private final Var<TwoDimensional.Position> start2DPosition

startColumnPosition	back to summary
private final Val<Integer> startColumnPosition

startParagraphIndex	back to summary
private final Val<Integer> startParagraphIndex

startPosition	back to summary
private final SuspendableVal<Integer> startPosition

subscription	back to summary
private Subscription subscription

Constructor Detail

SelectionImpl	back to summary
public SelectionImpl(String name, GenericStyledArea<PS, SEG, S> area) Creates a selection with both the start and end position at 0. Parameters name:String must be unique and is also used as a StyleClass for configuration via CSS using selectors from Path, Shape, and Node.

SelectionImpl

back to summary

public SelectionImpl(String name, GenericStyledArea<PS, SEG, S> area)

Creates a selection with both the start and end position at 0.

Parameters

name:String: must be unique and is also used as a StyleClass for configuration via CSS using selectors from Path, Shape, and Node.

SelectionImpl	back to summary
public SelectionImpl(String name, GenericStyledArea<PS, SEG, S> area, Consumer<SelectionPath> configurePath) Creates a selection with customized configuration via `configurePath` with both the start and end position at 0.

SelectionImpl	back to summary
public SelectionImpl(String name, GenericStyledArea<PS, SEG, S> area, int startPosition, int endPosition) Creates a selection. Name must be unique and is also used as a StyleClass for configuration via CSS using selectors from Path, Shape, and Node.

SelectionImpl	back to summary
pack-priv SelectionImpl(String name, GenericStyledArea<PS, SEG, S> area, int startPosition, int endPosition, SuspendableNo dependentBeingUpdated) Creates a selection that is to be used in a `CaretSelectionBind`.

SelectionImpl	back to summary
pack-priv SelectionImpl(String name, GenericStyledArea<PS, SEG, S> area, int startPosition, int endPosition, SuspendableNo dependentBeingUpdated, Consumer<SelectionPath> configurePath) Creates a selection that is to be used in a `CaretSelectionBind` with customized configuration.

SelectionImpl	back to summary
pack-priv SelectionImpl(String name, GenericStyledArea<PS, SEG, S> area, IndexRange range, SuspendableNo dependentBeingUpdated) Creates a selection that is to be used in a `CaretSelectionBind`. It adds the style class `selection` to any `SelectionPath` used to render this selection.

SelectionImpl	back to summary
pack-priv SelectionImpl(String name, GenericStyledArea<PS, SEG, S> area, IndexRange range, SuspendableNo dependentBeingUpdated, Consumer<SelectionPath> configurePath) Creates a selection that is to be used in a `CaretSelectionBind` with customized configuration and starting at the given range.

Method Detail

beingUpdatedProperty	back to summary
public final ObservableValue<Boolean> beingUpdatedProperty() Implements org.fxmisc.richtext.Selection.beingUpdatedProperty. Annotations @Override

beingUpdatedProperty

back to summary

public final ObservableValue<Boolean> beingUpdatedProperty()

Implements org.fxmisc.richtext.Selection.beingUpdatedProperty.

Annotations

@Override

compareTo back to summary

compareTo	back to summary
public int compareTo(SelectionImpl<PS, SEG, S> o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Annotations @Override

public int compareTo(SelectionImpl<PS, SEG, S> o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Annotations

@Override

configureSelectionPath back to summary

configureSelectionPath	back to summary
public void configureSelectionPath(SelectionPath path) Implements org.fxmisc.richtext.Selection.configureSelectionPath. Doc from org.fxmisc.richtext.Selection.configureSelectionPath. 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. Annotations @Override

public void configureSelectionPath(SelectionPath path)

Implements org.fxmisc.richtext.Selection.configureSelectionPath.

Doc from org.fxmisc.richtext.Selection.configureSelectionPath.

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.

Annotations

@Override

dispose	back to summary
public void dispose() Implements org.fxmisc.richtext.Selection.dispose. Doc from org.fxmisc.richtext.Selection.dispose. Disposes the selection and prevents memory leaks Annotations @Override

dispose

back to summary

public void dispose()

Implements org.fxmisc.richtext.Selection.dispose.

Doc from org.fxmisc.richtext.Selection.dispose.

Disposes the selection and prevents memory leaks

Annotations

@Override

endColumnPositionProperty	back to summary
public final ObservableValue<Integer> endColumnPositionProperty() Implements org.fxmisc.richtext.Selection.endColumnPositionProperty. Annotations @Override

endColumnPositionProperty

back to summary

public final ObservableValue<Integer> endColumnPositionProperty()

Implements org.fxmisc.richtext.Selection.endColumnPositionProperty.

Annotations

@Override

endParagraphIndexProperty	back to summary
public final ObservableValue<Integer> endParagraphIndexProperty() Implements org.fxmisc.richtext.Selection.endParagraphIndexProperty. Annotations @Override

endParagraphIndexProperty

back to summary

public final ObservableValue<Integer> endParagraphIndexProperty()

Implements org.fxmisc.richtext.Selection.endParagraphIndexProperty.

Annotations

@Override

endPositionProperty	back to summary
public final ObservableValue<Integer> endPositionProperty() Implements org.fxmisc.richtext.Selection.endPositionProperty. Annotations @Override

endPositionProperty

back to summary

public final ObservableValue<Integer> endPositionProperty()

Implements org.fxmisc.richtext.Selection.endPositionProperty.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) 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 boolean equals(Object obj)

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

getArea	back to summary
public GenericStyledArea<PS, SEG, S> getArea() Implements org.fxmisc.richtext.Selection.getArea. Doc from org.fxmisc.richtext.Selection.getArea. Gets the area with which this selection is associated Annotations @Override

getArea

back to summary

public GenericStyledArea<PS, SEG, S> getArea()

Implements org.fxmisc.richtext.Selection.getArea.

Doc from org.fxmisc.richtext.Selection.getArea.

Gets the area with which this selection is associated

Annotations

@Override

getEndColumnPosition	back to summary
public final int getEndColumnPosition() Implements org.fxmisc.richtext.Selection.getEndColumnPosition. Annotations @Override

getEndColumnPosition

back to summary

public final int getEndColumnPosition()

Implements org.fxmisc.richtext.Selection.getEndColumnPosition.

Annotations

@Override

getEndParagraphIndex	back to summary
public final int getEndParagraphIndex() Implements org.fxmisc.richtext.Selection.getEndParagraphIndex. Annotations @Override

getEndParagraphIndex

back to summary

public final int getEndParagraphIndex()

Implements org.fxmisc.richtext.Selection.getEndParagraphIndex.

Annotations

@Override

getEndPosition	back to summary
public final int getEndPosition() Implements org.fxmisc.richtext.Selection.getEndPosition. Annotations @Override

getEndPosition

back to summary

public final int getEndPosition()

Implements org.fxmisc.richtext.Selection.getEndPosition.

Annotations

@Override

getLength	back to summary
public final int getLength() Implements org.fxmisc.richtext.Selection.getLength. Annotations @Override

getLength

back to summary

public final int getLength()

Implements org.fxmisc.richtext.Selection.getLength.

Annotations

@Override

getParagraphSpan	back to summary
public final int getParagraphSpan() Implements org.fxmisc.richtext.Selection.getParagraphSpan. Annotations @Override

getParagraphSpan

back to summary

public final int getParagraphSpan()

Implements org.fxmisc.richtext.Selection.getParagraphSpan.

Annotations

@Override

getRange	back to summary
public final IndexRange getRange() Implements org.fxmisc.richtext.Selection.getRange. Annotations @Override

getRange

back to summary

public final IndexRange getRange()

Implements org.fxmisc.richtext.Selection.getRange.

Annotations

@Override

getSelectedDocument	back to summary
public final StyledDocument<PS, SEG, S> getSelectedDocument() Implements org.fxmisc.richtext.Selection.getSelectedDocument. Annotations @Override

getSelectedDocument

back to summary

public final StyledDocument<PS, SEG, S> getSelectedDocument()

Implements org.fxmisc.richtext.Selection.getSelectedDocument.

Annotations

@Override

getSelectedText	back to summary
public final String getSelectedText() Implements org.fxmisc.richtext.Selection.getSelectedText. Annotations @Override

getSelectedText

back to summary

public final String getSelectedText()

Implements org.fxmisc.richtext.Selection.getSelectedText.

Annotations

@Override

getSelectionBounds	back to summary
public final Optional<Bounds> getSelectionBounds() Implements org.fxmisc.richtext.Selection.getSelectionBounds. Annotations @Override

getSelectionBounds

back to summary

public final Optional<Bounds> getSelectionBounds()

Implements org.fxmisc.richtext.Selection.getSelectionBounds.

Annotations

@Override

getSelectionName

back to summary

public String getSelectionName()

Implements org.fxmisc.richtext.Selection.getSelectionName.

Doc from org.fxmisc.richtext.Selection.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; }

Annotations

@Override

getStartColumnPosition

back to summary

public final int getStartColumnPosition()

Implements org.fxmisc.richtext.Selection.getStartColumnPosition.

Annotations

@Override

getStartParagraphIndex

back to summary

public final int getStartParagraphIndex()

Implements org.fxmisc.richtext.Selection.getStartParagraphIndex.

Annotations

@Override

getStartPosition

back to summary

public final int getStartPosition()

Implements org.fxmisc.richtext.Selection.getStartPosition.

Annotations

@Override

hashCode back to summary

public 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

isBeingUpdated

back to summary

public final boolean isBeingUpdated()

Implements org.fxmisc.richtext.Selection.isBeingUpdated.

Annotations

@Override

lengthProperty

back to summary

public final ObservableValue<Integer> lengthProperty()

Implements org.fxmisc.richtext.Selection.lengthProperty.

Doc from org.fxmisc.richtext.Selection.lengthProperty.

The length of the selection

Annotations

@Override

manageSubscription	back to summary
private <T> void manageSubscription(EventStream<T> stream, Consumer<T> consumer)

manageSubscription	back to summary
private void manageSubscription(Subscription s)

moveBoundary	back to summary
private void moveBoundary(Selection.Direction direction, int amount, int oldBoundaryPosition, Function<Integer, IndexRange> updatedRange)

moveBoundary	back to summary
private void moveBoundary(IntSupplier textPosition, Function<Integer, Boolean> boundsCheckPasses, Function<Integer, IndexRange> updatedRange)

paragraphSpanProperty

back to summary

public final ObservableValue<Integer> paragraphSpanProperty()

Implements org.fxmisc.richtext.Selection.paragraphSpanProperty.

Doc from org.fxmisc.richtext.Selection.paragraphSpanProperty.

The number of paragraphs the selection spans

Annotations

@Override

rangeProperty back to summary

public final ObservableValue<IndexRange> rangeProperty()

Implements org.fxmisc.richtext.Selection.rangeProperty.

Doc from org.fxmisc.richtext.Selection.rangeProperty.

The start and end positions in the area as an IndexRange.

Annotations

@Override

selectAll

back to summary

public void selectAll()

Implements org.fxmisc.richtext.Selection.selectAll.

Annotations

@Override

selectedDocumentProperty

back to summary

public final ObservableValue<StyledDocument<PS, SEG, S>> selectedDocumentProperty()

Implements org.fxmisc.richtext.Selection.selectedDocumentProperty.

Annotations

@Override

selectedTextProperty

back to summary

public final ObservableValue<String> selectedTextProperty()

Implements org.fxmisc.richtext.Selection.selectedTextProperty.

Annotations

@Override

selectionBoundsProperty back to summary

public final ObservableValue<Optional<Bounds>> selectionBoundsProperty()

Implements org.fxmisc.richtext.Selection.selectionBoundsProperty.

Doc from org.fxmisc.richtext.Selection.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.

Annotations