Class PdfWriter

Method Details

• open

  public void open()

  Description copied from class: DataEndpoint

  Makes this endpoint ready for reading or writing.

  Overrides:

  open in class ProxyWriter

• close

  public void close()

  Description copied from class: DataEndpoint

  Indicates that this endpoint has finished reading or writing.

  Overrides:

  close in class ProxyWriter

• writeImpl

  protected void writeImpl(Record record) throws Throwable

  Description copied from class: DataWriter

  Overridden by subclasses to write the specified record to this DataWriter.

  Contract for subclasses (see also docs/authoring/DataWriter.md):

  • Do not call this method directly — DataWriter.write(Record) is the template method that wraps exceptions, increments the record count, and attaches the offending record to thrown DataExceptions.
  • Do not call DataEndpoint.incrementRecordCount() here; DataWriter.write(Record) already does.
  • Throw raw exceptions; DataWriter.write(Record) wraps them via exception(throwable).setRecord(record).

  Overrides:

  writeImpl in class ProxyWriter

  Throws:

  Throwable

• getPageSize

  public PdfWriter.IPageSize getPageSize()

  Returns the page size for the PDF document (default PdfWriter.PageSize.LETTER).

• setPageSize

  public PdfWriter setPageSize(PdfWriter.IPageSize pageSize)

  Specifies the page size for the PDF document.

  You can provide a predefined size using the PdfWriter.PageSize enum (e.g., PdfWriter.PageSize.A4, PdfWriter.PageSize.LETTER), or you can create a custom PdfWriter.IPageSize implementation for any valid CSS page/size value, such as 10in 15in.

  The default page size is PdfWriter.PageSize.LETTER.

  See Also:

  • MDN Web Docs: @page/size

• setPageSize

  public PdfWriter setPageSize(String pageSize)

  Specifies the page size for the PDF document using a CSS page/size string value.

  This method allows you to define a custom page size using any valid CSS page/size string, such as 10in 15in.

  The default page size is letter.

  See Also:

  • MDN Web Docs: @page/size

• getPageOrientation

  public PdfWriter.PageOrientation getPageOrientation()

  Returns the page orientation for the PDF document (default PdfWriter.PageOrientation.PORTRAIT).

• setPageOrientation

  public PdfWriter setPageOrientation(PdfWriter.PageOrientation pageOrientation)

  Specifies the page orientation for the PDF document (default PdfWriter.PageOrientation.PORTRAIT).

• getCustomStyle

  public String getCustomStyle()

  Returns the custom CSS style applied to the PDF document (default null).

• setCustomStyle

  public PdfWriter setCustomStyle(String customStyle)

  Specifies a custom CSS style to be applied to the PDF document (default null).

  This style will be included in the generated PDF and can be used to customize the appearance of the content, such as table styles, fonts, colors, etc.
  
  You can provide a styling for the following HTML table structure:

   <!DOCTYPE html>
   <html lang='en-US' dir='ltr'>
   <head>
   </head>
   <body>
   <table>
       <thead>
         <tr>
           <th class='col-0'>Field1</th>
           <th class='col-1'>Field2</th>
         </tr>
       </thead>
       <tbody>
         <tr>
           <td class='col-0'>Value1</td>
           <td class='col-1'>Value2</td>
         </tr>
       </tbody>
   </table>
   </body>
   </html>
   

• addExceptionProperties

  public DataException addExceptionProperties(DataException exception)

  Description copied from class: Endpoint

  Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.

  Overrides:

  addExceptionProperties in class ProxyWriter