Package com.nsdev.lettergenerator.model.layout

Record Class Margins

java.lang.Object
java.lang.Record
com.nsdev.lettergenerator.model.layout.Margins
Record Components:
top - inset from the physical page's top edge, in millimeters
right - inset from the physical page's right edge, in millimeters
bottom - inset from the physical page's bottom edge, in millimeters
left - inset from the physical page's left edge, in millimeters
public record Margins(double top, double right, double bottom, double left) extends Record
Physical-page insets in millimeters, outside both the body and reserved zones. Construction stores values unchanged; generation requires finite nonnegative margins and usable page width and height after margins and zones are removed.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Margins(double top, double right, double bottom, double left)
    Creates an instance of a Margins record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    bottom()
    Returns the value of the bottom record component.
    static Margins
    defaults()
    Creates the default margins of 20 millimeters on each side.
    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
    left()
    Returns the value of the left record component.
    double
    right()
    Returns the value of the right record component.
    double
    top()
    Returns the value of the top record component.
    final String
    toString()
    Returns a string representation of this record class.
    static Margins
    uniform(double millimeters)
    Creates equal margins without validating their value.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Margins

      public Margins(double top, double right, double bottom, double left)
      Creates an instance of a Margins record class.
      Parameters:
      top - the value for the top record component
      right - the value for the right record component
      bottom - the value for the bottom record component
      left - the value for the left record component

  • Method Details

    • defaults

      public static Margins defaults()
      Creates the default margins of 20 millimeters on each side.
      Returns:
      equal 20 mm margins

    • uniform

      public static Margins uniform(double millimeters)
      Creates equal margins without validating their value.
      Parameters:
      millimeters - inset to use on all four sides
      Returns:
      margins carrying the supplied value on each side

    • 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.

    • top

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

    • right

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

    • bottom

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

    • left

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