Package org.faceless.publisher.output.pdf

Class PDFReportOutput

java.lang.Object
org.faceless.publisher.output.pdf.PDFReportOutput
All Implemented Interfaces:
org.faceless.publisher.output.ReportCanvasContext, ReportOutput, org.faceless.publisher.type.EnvSource
public class PDFReportOutput extends Object
A PDFReportOutput is an implementation of ReportOutput that creates a PDF file.

  • Constructor Details

    • PDFReportOutput

      public PDFReportOutput()

  • Method Details

    • getPDF

      public PDF getPDF()
      Return the PDF generated by this PDFReportOutput. Will be null until after the Report.parse() has completed
      Returns:
      the PDF

    • eviscerate

      public void eviscerate()
      Inform the output that it is 100% complete. Must be called AFTER close

    • addDataList

      public void addDataList(String id, List<String> options)

    • write

      public void write(OutputStream out) throws IOException
      Description copied from interface: ReportOutput
      Write the object generated by this ReportOutput to the specified OutpuStream. The exact object written is instance dependent, and if no single file is appropriate this method may throw an UnsupportedOperationException. This method will fire a "write.start" and "write.end" LifeCycleEvent on the before and after writing.
      Throws:
      IOException - if generated when writing.

    • getMediaType

      public MediaType getMediaType()
      Description copied from interface: ReportOutput
      Return the type of object that would be written by ReportOutput.write(java.io.OutputStream), or if that method doesn't apply, the type of Media generated by this ReportOutput.

    • free

      public void free(org.faceless.publisher.type.AbstractNode node)
      Inform the output that the specified node has been freed
      Specified by:
      free in interface ReportOutput

    • isPageBlank

      public boolean isPageBlank()
      Return true if the current page is blank
      Specified by:
      isPageBlank in interface ReportOutput

    • markPage

      public void markPage()
      Record that this page is not blank
      Specified by:
      markPage in interface org.faceless.publisher.output.ReportCanvasContext
      Specified by:
      markPage in interface ReportOutput