Package com.vaadin.flow.component.ai.common

Record Class Rect

java.lang.Object
java.lang.Record
com.vaadin.flow.component.ai.common.Rect
Record Components:
x - the left edge as a fraction of the surface width
y - the top edge as a fraction of the surface height
width - the width as a fraction of the surface width
height - the height as a fraction of the surface height
All Implemented Interfaces:
Serializable
public record Rect(double x, double y, double width, double height) extends Record implements Serializable
A rectangle expressed as fractions of the surface it sits on, measured from the top-left corner. All values are in the 0..1 range, so the rectangle holds at any zoom level and rendering size: multiply by the rendered width and height to get pixel coordinates.

The fractions describe the surface as the user sees it — for a PDF page marked as rotated, they refer to the rotated page rather than the unrotated one.

Since:
25.3
Author:
Vaadin Ltd
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Rect(double x, double y, double width, double height)
    Creates a new rectangle.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    height()
    Returns the value of the height record component.
    final String
    toString()
    Returns a string representation of this record class.
    double
    width()
    Returns the value of the width record component.
    double
    x()
    Returns the value of the x record component.
    double
    y()
    Returns the value of the y record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Rect

      public Rect(double x, double y, double width, double height)
      Creates a new rectangle.
      Parameters:
      x - the left edge as a fraction of the surface width, in the 0..1 range
      y - the top edge as a fraction of the surface height, in the 0..1 range
      width - the width as a fraction of the surface width, greater than 0 and at most 1
      height - the height as a fraction of the surface height, greater than 0 and at most 1
      Throws:
      IllegalArgumentException - if a value is outside its range, or not a number

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • x

      public double x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • y

      public double y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component

    • width

      public double width()
      Returns the value of the width record component.
      Returns:
      the value of the width record component

    • height

      public double height()
      Returns the value of the height record component.
      Returns:
      the value of the height record component