Package lu.kbra.modelizer_next.ui.export

Record Class PdfViewExportOptions

java.lang.Object
java.lang.Record
lu.kbra.modelizer_next.ui.export.PdfViewExportOptions
Record Components:
pageFormat - selected page format
orientation - selected page orientation
customPageWidth - custom page width in points, used when pageFormat is CUSTOM
customPageHeight - custom page height in points, used when pageFormat is CUSTOM
margins - page margins in points
underTemplateFile - optional image template drawn below the diagram content
overTemplateFile - optional image template drawn above the diagram content
headerText - header text pattern
footerText - footer text pattern
All Implemented Interfaces:
ViewExportOptions
public record PdfViewExportOptions(PdfPageFormat pageFormat, PdfPageOrientation orientation, double customPageWidth, double customPageHeight, PdfMargins margins, File underTemplateFile, File overTemplateFile, String headerText, String footerText) extends Record implements ViewExportOptions
Options used by the PDF exporter.

  • Constructor Details

    • PdfViewExportOptions

      public PdfViewExportOptions(PdfPageFormat pageFormat, PdfPageOrientation orientation, double customPageWidth, double customPageHeight, PdfMargins margins, File underTemplateFile, File overTemplateFile, String headerText, String footerText)
      Creates an instance of a PdfViewExportOptions record class.
      Parameters:
      pageFormat - the value for the pageFormat record component
      orientation - the value for the orientation record component
      customPageWidth - the value for the customPageWidth record component
      customPageHeight - the value for the customPageHeight record component
      margins - the value for the margins record component
      underTemplateFile - the value for the underTemplateFile record component
      overTemplateFile - the value for the overTemplateFile record component
      headerText - the value for the headerText record component
      footerText - the value for the footerText record component

  • Method Details

    • defaults

      public static PdfViewExportOptions defaults()
      Returns default PDF export options.
      Returns:
      the default options

    • effectivePageHeight

      public double effectivePageHeight()
      Returns the effective page height after applying custom size and orientation.
      Returns:
      the effective page height

    • effectivePageWidth

      public double effectivePageWidth()
      Returns the effective page width after applying custom size and orientation.
      Returns:
      the effective page width

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • pageFormat

      public PdfPageFormat pageFormat()
      Returns the value of the pageFormat record component.
      Returns:
      the value of the pageFormat record component

    • orientation

      public PdfPageOrientation orientation()
      Returns the value of the orientation record component.
      Returns:
      the value of the orientation record component

    • customPageWidth

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

    • customPageHeight

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

    • margins

      public PdfMargins margins()
      Returns the value of the margins record component.
      Returns:
      the value of the margins record component

    • underTemplateFile

      public File underTemplateFile()
      Returns the value of the underTemplateFile record component.
      Returns:
      the value of the underTemplateFile record component

    • overTemplateFile

      public File overTemplateFile()
      Returns the value of the overTemplateFile record component.
      Returns:
      the value of the overTemplateFile record component

    • headerText

      public String headerText()
      Returns the value of the headerText record component.
      Returns:
      the value of the headerText record component

    • footerText

      public String footerText()
      Returns the value of the footerText record component.
      Returns:
      the value of the footerText record component