APIdia Launch Partner
Top Description Fields Constructors Methods
jfx.incubator.scene.control.richtext

public final Class SelectionSegment

extends Object
Class Inheritance
Imports
java.util.Objects

Text selection segment, comprised of the selection anchor and the caret positions. The main purpose of this class is to enable tracking of selection changes as a single entity.
Since
24

Field Summary

Modifier and TypeField and Description
private final boolean
private final TextPos
private final TextPos

Constructor Summary

AccessConstructor and Description
public
SelectionSegment(TextPos
the anchor position, must not be null
anchor
,
TextPos
the caret position, must not be null
caret
)

Constructs the selection segment.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object x)

Overrides java.lang.Object.equals.

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

public final TextPos

Returns:

the anchor position
getAnchor
()

Returns the selection anchor position.

public final TextPos

Returns:

the caret position
getCaret
()

Returns the caret position.

public TextPos

Returns:

the text position
getMax
()

Returns the position which is closer to the end of the document.

public final TextPos

Returns:

the text position
getMin
()

Returns the position which is closer to the start of the document.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean

Returns:

true if the anchor and the caret are at the same position
isCollapsed
()

Returns true if the anchor and the caret are at the same position.

private static <T extends Comparable<T>> void
isLessThanOrEqual(T min, T max, String nameMin, String nameMax)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

caretAtMinback to summary
private final boolean caretAtMin
maxback to summary
private final TextPos max
minback to summary
private final TextPos min

Constructor Detail

SelectionSegmentback to summary
public SelectionSegment(TextPos anchor, TextPos caret)

Constructs the selection segment.

Parameters
anchor:TextPos

the anchor position, must not be null

caret:TextPos

the caret position, must not be null

Method Detail

equalsback to summary
public boolean equals(Object x)

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
getAnchorback to summary
public final TextPos getAnchor()

Returns the selection anchor position.

Returns:TextPos

the anchor position

getCaretback to summary
public final TextPos getCaret()

Returns the caret position.

Returns:TextPos

the caret position

getMaxback to summary
public TextPos getMax()

Returns the position which is closer to the end of the document.

Returns:TextPos

the text position

getMinback to summary
public final TextPos getMin()

Returns the position which is closer to the start of the document.

Returns:TextPos

the text position

hashCodeback 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
isCollapsedback to summary
public boolean isCollapsed()

Returns true if the anchor and the caret are at the same position.

Returns:boolean

true if the anchor and the caret are at the same position

isLessThanOrEqualback to summary
private static <T extends Comparable<T>> void isLessThanOrEqual(T min, T max, String nameMin, String nameMax)
toStringback 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