Package com.nsdev.lettergenerator.model.layout

Record Class Bounds

java.lang.Object
java.lang.Record
com.nsdev.lettergenerator.model.layout.Bounds
Record Components:
x - horizontal offset from the zone's left edge, in millimeters
y - vertical offset from the zone's top edge, in millimeters
width - rectangle width in millimeters
height - rectangle height in millimeters
public record Bounds(double x, double y, double width, double height) extends Record
Rectangle measured from a containing zone's upper-left corner, in millimeters. The x axis runs right and the y axis runs down. For a fixed element the containing zone is TOP or BOTTOM; a BOTTOM_LAST signature uses the last-page signature zone.

Construction performs no validation. Generation requires finite, nonnegative x/y, positive width/height, and a rectangle fitting inside its containing zone.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Bounds(double x, double y, double width, double height)
    Creates an instance of a Bounds record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    bottom()
    Returns the vertical coordinate of the bottom edge in the same zone.
    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.
    boolean
    intersects(Bounds other)
    Tests whether rectangles overlap with positive area.
    double
    right()
    Returns the horizontal coordinate of the right edge in the same zone.
    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

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Bounds

      public Bounds(double x, double y, double width, double height)
      Creates an instance of a Bounds record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component
      width - the value for the width record component
      height - the value for the height record component

  • Method Details

    • right

      public double right()
      Returns the horizontal coordinate of the right edge in the same zone.
      Returns:
      x plus width, in millimeters

    • bottom

      public double bottom()
      Returns the vertical coordinate of the bottom edge in the same zone.
      Returns:
      y plus height, in millimeters

    • intersects

      public boolean intersects(Bounds other)
      Tests whether rectangles overlap with positive area. Merely touching an edge or corner is not an intersection. Both rectangles must use the same coordinate system.
      Parameters:
      other - rectangle to compare
      Returns:
      true if their interiors overlap
      Throws:
      NullPointerException - if other is null

    • 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