JavaFX 24 · com.sun.jfx.incubator.scene.control.richtext.CaretInfo

Modifier and Type	Field and Description
private final double	lineSpacing
private final PathElement[]	path
private final double	xmax
private final double	xmin
private final double	ymax
private final double	ymin

Access	Constructor and Description
private	CaretInfo(double xmin, double xmax, double ymin, double ymax, double lineSpacing, PathElement[] path)

Method Summary

Modifier and Type	Method and Description
public final boolean	Returns: true if the coordinate is within the caret bounding box containsY(double the Y coordinate y) Returns true if the specified y coordinate is between the smallest and largest y coordinate of the caret bounding box.
public static CaretInfo	Returns: the CaretInfo instance create(double the line spacing lineSpacing, PathElement[] the caret path path) Creates an instance of CaretInfo given the path and translation offsets required to convert path coordinates (which come in the frame of reference of its `TextFlow`) to the view port coordinates.
public final double	Returns: the line spacing getLineSpacing() Returns the line spacing at the caret position.
public final double	Returns: maximum x coordinate getMaxX() Returns the largest x coordinate of the caret shape bounding box.
public final double	Returns: maximum y coordinate getMaxY() Returns the largest y coordinate of the caret shape bounding box.
public final double	Returns: minimum x coordinate getMinX() Returns the smallest x coordinate of the caret shape bounding box.
public final double	Returns: minimum y coordinate getMinY() Returns the smallest y coordinate of the caret shape bounding box.
private static double	halfPixel(double coord)
public final PathElement[]	Returns: the non-null array of path elements path() Returns the caret path.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

lineSpacing	back to summary
private final double lineSpacing

path	back to summary
private final PathElement[] path

xmax	back to summary
private final double xmax

xmin	back to summary
private final double xmin

ymax	back to summary
private final double ymax

ymin	back to summary
private final double ymin

CaretInfo	back to summary
private CaretInfo(double xmin, double xmax, double ymin, double ymax, double lineSpacing, PathElement[] path)

Method Detail

containsY	back to summary
public final boolean containsY(double y) Returns true if the specified y coordinate is between the smallest and largest y coordinate of the caret bounding box. Parameters y:double the Y coordinate Returns:boolean true if the coordinate is within the caret bounding box

containsY

back to summary

public final boolean containsY(double y)

Returns true if the specified y coordinate is between the smallest and largest y coordinate of the caret bounding box.

Parameters

y:double: the Y coordinate

Returns:boolean

true if the coordinate is within the caret bounding box

create back to summary

create	back to summary
public static CaretInfo create(double lineSpacing, PathElement[] path) Creates an instance of CaretInfo given the path and translation offsets required to convert path coordinates (which come in the frame of reference of its `TextFlow`) to the view port coordinates. Parameters lineSpacing:double the line spacing path:PathElement[] the caret path Returns:CaretInfo the CaretInfo instance

public static CaretInfo create(double lineSpacing, PathElement[] path)

Creates an instance of CaretInfo given the path and translation offsets required to convert path coordinates (which come in the frame of reference of its TextFlow) to the view port coordinates.

Parameters

lineSpacing:double: the line spacing
path:PathElement[]: the caret path

Returns:CaretInfo

the CaretInfo instance

getLineSpacing	back to summary
public final double getLineSpacing() Returns the line spacing at the caret position. Returns:double the line spacing

getLineSpacing

back to summary

public final double getLineSpacing()

Returns the line spacing at the caret position.

Returns:double: the line spacing

getMaxX	back to summary
public final double getMaxX() Returns the largest x coordinate of the caret shape bounding box. Returns:double maximum x coordinate

getMaxX

back to summary

public final double getMaxX()

Returns the largest x coordinate of the caret shape bounding box.

Returns:double: maximum x coordinate

getMaxY	back to summary
public final double getMaxY() Returns the largest y coordinate of the caret shape bounding box. Returns:double maximum y coordinate

getMaxY

back to summary

public final double getMaxY()

Returns the largest y coordinate of the caret shape bounding box.

Returns:double: maximum y coordinate

getMinX	back to summary
public final double getMinX() Returns the smallest x coordinate of the caret shape bounding box. Returns:double minimum x coordinate

getMinX

back to summary

public final double getMinX()

Returns the smallest x coordinate of the caret shape bounding box.

Returns:double: minimum x coordinate

getMinY	back to summary
public final double getMinY() Returns the smallest y coordinate of the caret shape bounding box. Returns:double minimum y coordinate

getMinY

back to summary

public final double getMinY()

Returns the smallest y coordinate of the caret shape bounding box.

Returns:double: minimum y coordinate

halfPixel	back to summary
private static double halfPixel(double coord)

path	back to summary
public final PathElement[] path() Returns the caret path. Returns:PathElement[] the non-null array of path elements

path

back to summary

public final PathElement[] path()

Returns the caret path.

Returns:PathElement[]: the non-null array of path elements

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. Returns:String a string representation of the object 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.

Returns:String

a string representation of the object

Annotations

@Override

public final Class CaretInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail