Package lu.kbra.modelizer_next.ui.export

Record Class ViewExportRequest

java.lang.Object
java.lang.Record
lu.kbra.modelizer_next.ui.export.ViewExportRequest
Record Components:
format - export format to use
scope - export scope to use
panelTypes - values for panel types
outputDirectory - output directory value used by the operation
fileNamePattern - text value for file name pattern
multiple - whether multiple input files are allowed
wildcard - whether wildcard path matching is enabled
backgroundColor - background color used when transparent export pixels must be flattened
options - format-specific export options
public record ViewExportRequest(ViewExportFormat format, ViewExportScope scope, List<PanelType> panelTypes, File outputDirectory, String fileNamePattern, boolean multiple, boolean wildcard, Color backgroundColor, ViewExportOptions options) extends Record
Immutable request object passed to the exporter.

  • Constructor Details

    • ViewExportRequest

      public ViewExportRequest(ViewExportFormat format, ViewExportScope scope, List<PanelType> panelTypes, File outputDirectory, String fileNamePattern, boolean multiple, boolean wildcard)
      Creates a request with default background and format-specific options.
      Parameters:
      format - export format to use
      scope - export scope to use
      panelTypes - values for panel types
      outputDirectory - output directory value used by the operation
      fileNamePattern - text value for file name pattern
      multiple - whether multiple input files are allowed
      wildcard - whether wildcard path matching is enabled

    • ViewExportRequest

      public ViewExportRequest(ViewExportFormat format, ViewExportScope scope, List<PanelType> panelTypes, File outputDirectory, String fileNamePattern, boolean multiple, boolean wildcard, Color backgroundColor, ViewExportOptions options)
      Normalizes null values to safe defaults.

  • Method Details

    • imageOptions

      public ImageViewExportOptions imageOptions()
      Returns the effective image options.
      Returns:
      image options or image defaults when another option type is stored

    • pdfOptions

      public PdfViewExportOptions pdfOptions()
      Returns the effective PDF options.
      Returns:
      PDF options or PDF defaults when another option type is stored

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

    • format

      public ViewExportFormat format()
      Returns the value of the format record component.
      Returns:
      the value of the format record component

    • scope

      public ViewExportScope scope()
      Returns the value of the scope record component.
      Returns:
      the value of the scope record component

    • panelTypes

      public List<PanelType> panelTypes()
      Returns the value of the panelTypes record component.
      Returns:
      the value of the panelTypes record component

    • outputDirectory

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

    • fileNamePattern

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

    • multiple

      public boolean multiple()
      Returns the value of the multiple record component.
      Returns:
      the value of the multiple record component

    • wildcard

      public boolean wildcard()
      Returns the value of the wildcard record component.
      Returns:
      the value of the wildcard record component

    • backgroundColor

      public Color backgroundColor()
      Returns the value of the backgroundColor record component.
      Returns:
      the value of the backgroundColor record component

    • options

      public ViewExportOptions options()
      Returns the value of the options record component.
      Returns:
      the value of the options record component