Package org.xhtmlrenderer.simple
Class PDFRenderer
java.lang.Object
org.xhtmlrenderer.simple.PDFRenderer
PDFRenderer supports headless rendering of XHTML documents, outputting
to PDF format. There are two static utility methods, one for rendering
a URL
, renderToPDF(String, String)
and one
for rendering a File
, renderToPDF(File, String)
You can use this utility from the command line by passing in the URL or file location as first parameter, and PDF path as second parameter:
java -cp %classpath% org.xhtmlrenderer.simple.PDFRenderer
- Author:
- Pete Brant, Patrick Wright
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
Renders a file or URL to a PDF.static void
renderToPDF
(File file, String pdf) Renders the XML file as a PDF file at the target location.static void
renderToPDF
(File file, String pdf, Character pdfVersion) Renders the XML file as a PDF file at the target location.static void
renderToPDF
(String url, String pdf) Renders the XML file at the given URL as a PDF file at the target location.static void
renderToPDF
(String url, String pdf, Character pdfVersion) Renders the XML file at the given URL as a PDF file at the target location.
-
Constructor Details
-
PDFRenderer
public PDFRenderer()
-
-
Method Details
-
renderToPDF
public static void renderToPDF(String url, String pdf) throws IOException, com.lowagie.text.DocumentException Renders the XML file at the given URL as a PDF file at the target location.- Parameters:
url
- url for the XML file to renderpdf
- path to the PDF file to create- Throws:
IOException
- if the URL or PDF location is invalidcom.lowagie.text.DocumentException
- if an error occurred while building the Document.
-
renderToPDF
public static void renderToPDF(String url, String pdf, @Nullable Character pdfVersion) throws IOException, com.lowagie.text.DocumentException Renders the XML file at the given URL as a PDF file at the target location.- Parameters:
url
- url for the XML file to renderpdf
- path to the PDF file to createpdfVersion
- version of PDF to output; null uses default version- Throws:
IOException
- if the URL or PDF location is invalidcom.lowagie.text.DocumentException
- if an error occurred while building the Document.
-
renderToPDF
public static void renderToPDF(File file, String pdf) throws IOException, com.lowagie.text.DocumentException Renders the XML file as a PDF file at the target location.- Parameters:
file
- XML file to renderpdf
- path to the PDF file to create- Throws:
IOException
- if the file or PDF location is invalidcom.lowagie.text.DocumentException
- if an error occurred while building the Document.
-
renderToPDF
public static void renderToPDF(File file, String pdf, @Nullable Character pdfVersion) throws IOException, com.lowagie.text.DocumentException Renders the XML file as a PDF file at the target location.- Parameters:
file
- XML file to renderpdf
- path to the PDF file to createpdfVersion
- version of PDF to output; null uses default version- Throws:
IOException
- if the file or PDF location is invalidcom.lowagie.text.DocumentException
- if an error occurred while building the Document.
-
main
Renders a file or URL to a PDF. Command line use: first argument is URL or file path, second argument is path to PDF file to generate.- Parameters:
args
- see desc- Throws:
IOException
- if source could not be read, or if PDF path is invalidcom.lowagie.text.DocumentException
- if an error occurs while building the document
-