Top Description Fields Constructors Methods
com.sun.jfx.incubator.scene.control.richtext

public final Record Origin

extends Record
Class Inheritance
Record Components
index:int
the model index of a paragraph at the top of visible area
offset:double
the distance in pixels from the top of the visible area to the top of the topmost paragraph

View origin: model index of the top paragraph index + offset in pixels from the upper edge of the top cell to the upper edge of the view area.

Field Summary

Modifier and TypeField and Description
private final int
index

Record Component accessed by index().

the model index of a paragraph at the top of visible area
private final double
offset

Record Component accessed by offset().

the distance in pixels from the top of the visible area to the top of the topmost paragraph
public static final Origin
ZERO

beginning of the document

Constructor Summary

AccessConstructor and Description
public
Origin(int index, double offset)

Method Summary

Modifier and TypeMethod and Description
public final boolean
equals(Object
the reference object with which to compare.
o
)

Implements abstract java.lang.Record.equals.

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

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public int
index()

Record Component getter of index.

Record Component the model index of a paragraph at the top of visible area

public double
offset()

Record Component getter of offset.

Record Component the distance in pixels from the top of the visible area to the top of the topmost paragraph

public String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

indexback to summary
private final int index

Record Component accessed by index().

the model index of a paragraph at the top of visible area

offsetback to summary
private final double offset

Record Component accessed by offset().

the distance in pixels from the top of the visible area to the top of the topmost paragraph

ZEROback to summary
public static final Origin ZERO

beginning of the document

Constructor Detail

Originback to summary
public Origin(int index, double offset)

Method Detail

equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Returns:int

a hash code value for this record.

indexback to summary
public int index()

Record Component getter of index.

Record Component
the model index of a paragraph at the top of visible area
offsetback to summary
public double offset()

Record Component getter of offset.

Record Component
the distance in pixels from the top of the visible area to the top of the topmost paragraph
toStringback to summary
public String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Returns:String

a string representation of the object.

Annotations
@Override