JavaFX 27 · jfx.incubator.scene.control.richtext.TextPos

Modifier and Type	Field and Description
private final int	charIndex
private final int	index
private final boolean	leading
private final int	offset
public static final TextPos	ZERO A text position at the start of the document.

Access	Constructor and Description
public	TextPos(int the paragraph index index, int the offset in the text which corresponds to the insertion position offset, int the character index charIndex, boolean indicates whether the position is at the leading edge of the character at `charIndex` leading) Creates a new text position.

Method Summary

Modifier and Type	Method and Description
public int	Returns: the character index charIndex() Returns the character index.
public int	compareTo(TextPos p) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public boolean	equals(Object x) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	Returns: the paragraph index index() Returns the paragraph index.
public boolean	Returns: true if leading text position isLeading() Determines whether the text position is leading or trailing.
public boolean	Returns: true if same insertion index isSameInsertionIndex(TextPos text position p) Returns true if the specified insertion point is the same.
public int	Returns: the offset offset() Returns the offset into the plain text string (insertion index).
public static TextPos	Returns: the instance of `TextPos` ofLeading(int the paragraph index index, int the text offset offset) Creates a new text position at the leading edge of the character at the specified text offset.
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

charIndex	back to summary
private final int charIndex

index	back to summary
private final int index

leading	back to summary
private final boolean leading

offset	back to summary
private final int offset

ZERO	back to summary
public static final TextPos ZERO A text position at the start of the document.

TextPos	back to summary
public TextPos(int index, int offset, int charIndex, boolean leading) Creates a new text position. Parameters index:int the paragraph index offset:int the offset in the text which corresponds to the insertion position charIndex:int the character index leading:boolean indicates whether the position is at the leading edge of the character at `charIndex`

Method Detail

charIndex	back to summary
public int charIndex() Returns the character index. Returns:int the character index

charIndex

back to summary

public int charIndex()

Returns the character index.

Returns:int: the character index

compareTo back to summary

compareTo	back to summary
public int compareTo(TextPos p) 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(TextPos p)

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

equals back to summary

equals	back 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

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

hashCode back to summary

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

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

index	back to summary
public int index() Returns the paragraph index. Returns:int the paragraph index

index

back to summary

public int index()

Returns the paragraph index.

Returns:int: the paragraph index

isLeading	back to summary
public boolean isLeading() Determines whether the text position is leading or trailing. Returns:boolean true if leading text position

isLeading

back to summary

public boolean isLeading()

Determines whether the text position is leading or trailing.

Returns:boolean: true if leading text position

isSameInsertionIndex	back to summary
public boolean isSameInsertionIndex(TextPos p) Returns true if the specified insertion point is the same. Parameters p:TextPos text position Returns:boolean true if same insertion index

isSameInsertionIndex

back to summary

public boolean isSameInsertionIndex(TextPos p)

Returns true if the specified insertion point is the same.

Parameters

p:TextPos: text position

Returns:boolean

true if same insertion index

offset	back to summary
public int offset() Returns the offset into the plain text string (insertion index). Returns:int the offset

offset

back to summary

public int offset()

Returns the offset into the plain text string (insertion index).

Returns:int: the offset

ofLeading back to summary

ofLeading	back to summary
public static TextPos ofLeading(int index, int offset) Creates a new text position at the leading edge of the character at the specified text offset. Parameters index:int the paragraph index offset:int the text offset Returns:TextPos the instance of `TextPos`

public static TextPos ofLeading(int index, int offset)

Creates a new text position at the leading edge of the character at the specified text offset.

Parameters

index:int: the paragraph index
offset:int: the text offset

Returns:TextPos

the instance of TextPos

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

public final Class TextPos

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail