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
A PDFReportOutput is an implementation of
ReportOutput
that creates a PDF file.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDataList
(String id, List<String> options) default Boolean
getEnvironmentAsBoolean
(String name, Boolean dflt) default org.faceless.publisher.type.CSSColor
getEnvironmentAsColor
(String name, org.faceless.publisher.type.CSSColor dflt) default Float
getEnvironmentAsFloat
(String name, Float dflt) default Float
getEnvironmentAsFloatOrInf
(String name, Float dflt) default Integer
getEnvironmentAsInt
(String name, Integer dflt) default org.faceless.publisher.type.Length
getEnvironmentAsLength
(String name, org.faceless.publisher.type.Length dflt) default Float
getEnvironmentAsResolution
(String name, Float dflt) default Float
getEnvironmentAsResolutionOrInf
(String name, Float dflt) default String
getEnvironmentAsString
(String name, String dflt) getEnvironmentAsStringList
(String name, List<String> dflt) default Float
getEnvironmentAsTime
(String name, Float dflt) default URL2
getEnvironmentAsURL
(String name, URL2 dflt) Return the type of object that would be written byReportOutput.write(java.io.OutputStream)
, or if that method doesn't apply, the type of Media generated by this ReportOutput.PDF
getPDF()
Return the PDF generated by this PDFReportOutput.boolean
Return true if the current page is blankvoid
markPage()
Record that this page is not blankvoid
write
(OutputStream out) Write the object generated by this ReportOutput to the specified OutpuStream.
-
Constructor Details
-
PDFReportOutput
public PDFReportOutput()
-
-
Method Details
-
getPDF
public PDF getPDF()Return the PDF generated by this PDFReportOutput. Will be null until after theReport.parse()
has completed- Returns:
- the PDF
-
addDataList
-
write
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 anUnsupportedOperationException
.- Throws:
IOException
- if generated when writing.
-
getMediaType
Description copied from interface:ReportOutput
Return the type of object that would be written byReportOutput.write(java.io.OutputStream)
, or if that method doesn't apply, the type of Media generated by this ReportOutput. -
isPageBlank
public boolean isPageBlank()Description copied from interface:ReportOutput
Return true if the current page is blank- Specified by:
isPageBlank
in interfaceReportOutput
-
markPage
public void markPage()Description copied from interface:ReportOutput
Record that this page is not blank- Specified by:
markPage
in interfaceorg.faceless.publisher.output.ReportCanvasContext
- Specified by:
markPage
in interfaceReportOutput
-
getEnvironmentAsString
-
getEnvironmentAsStringList
-
getEnvironmentAsInt
-
getEnvironmentAsURL
-
getEnvironmentAsBoolean
-
getEnvironmentAsFloat
-
getEnvironmentAsFloatOrInf
-
getEnvironmentAsLength
default org.faceless.publisher.type.Length getEnvironmentAsLength(String name, org.faceless.publisher.type.Length dflt) -
getEnvironmentAsResolution
-
getEnvironmentAsResolutionOrInf
-
getEnvironmentAsTime
-
getEnvironmentAsColor
default org.faceless.publisher.type.CSSColor getEnvironmentAsColor(String name, org.faceless.publisher.type.CSSColor dflt)
-