Class PdfPipelineOutput

Method Details

• getName

  public String getName()

  Description copied from class: PipelineOutput

  Returns a display name for this output, such as the destination's name followed by its format.

  Overrides:

  getName in class FileSinkPipelineOutput

• getFileSink

  public FileSink getFileSink()

  Specified by:

  getFileSink in class FileSinkPipelineOutput

• setFileSink

  public PdfPipelineOutput setFileSink(FileSink fileSink)

  Specified by:

  setFileSink in class FileSinkPipelineOutput

• createDataWriter

  public DataWriter createDataWriter()

• getPageSize

  public PdfWriter.IPageSize getPageSize()

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

• setPageSize

  public PdfPipelineOutput 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 PdfPipelineOutput 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 PdfPipelineOutput 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 PdfPipelineOutput 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>
   

• generateJavaCode

  public void generateJavaCode(JavaCodeBuilder code)

  Description copied from interface: JavaCodeGenerator

  Appends Java source code representing this object to the given builder.

• fromRecord

  public PdfPipelineOutput fromRecord(Record source)

  Description copied from interface: RecordSerializable

  Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.

  Specified by:

  fromRecord in interface RecordSerializable

  Overrides:

  fromRecord in class PipelineOutput

  Parameters:

  source -

  Returns:

  this instance.

• toRecord

  public Record toRecord()

  Description copied from interface: RecordSerializable

  Converts this object's state to a record that RecordSerializable.fromRecord(Record) can load.

  Specified by:

  toRecord in interface RecordSerializable

  Overrides:

  toRecord in class Bean

• toXmlElement

  public Element toXmlElement(Document document)

  Description copied from interface: XmlSerializable

  Returns an element, created with document, describing this object; the default implementation throws a DataException.

  Specified by:

  toXmlElement in interface XmlSerializable

  Overrides:

  toXmlElement in class PipelineOutput

• fromXmlElement

  public XmlSerializable fromXmlElement(Element pipelineOutputElement)