com.openhtmltopdf.pdfboxout

Class PdfBoxRenderer

java.lang.Object

com.openhtmltopdf.pdfboxout.PdfBoxRenderer

All Implemented Interfaces:

PageSupplier, Closeable, AutoCloseable

public class PdfBoxRenderer
extends Object
implements Closeable, PageSupplier

Method Summary

Modifier and Type	Method and Description
void	close() Cleanup thread resources.
void	createPDF() Creates a PDF with setup specified by builder.
org.apache.pdfbox.pdmodel.PDDocument	createPDFKeepOpen() Creates a PDF with setup specified by builder.
void	createPDFWithoutClosing() Creates a PDF with setup specified by builder.
List<PagePosition<Box>>	findPagePositionsByID(Pattern pattern)
void	finishPDF() Deprecated.
Document	getDocument()
float	getDotsPerPoint()
PdfBoxFontResolver	getFontResolver() Get the PDF-BOX font resolver.
float	getLastContentBottom() Returns the bottom Y postion in bottom-up PDF units on the last page of content.
List<PagePosition<Layer>>	getLayerPositions(Layer layer) Returns a list of page positions for a single layer.
List<PagePosition<Layer>>	getLayersPositions() Returns a list of page positions for all layers in the document.
PDFCreationListener	getListener()
PdfBoxOutputDevice	getOutputDevice()
org.apache.pdfbox.pdmodel.PDDocument	getPdfDocument() Returns the PDDocument or null if it has been closed.
float	getPDFVersion()
BlockBox	getRootBox()
SharedContext	getSharedContext()
void	layout()
org.apache.pdfbox.pdmodel.PDPage	requestPage(org.apache.pdfbox.pdmodel.PDDocument doc, float pageWidth, float pageHeight, int pageNumber, int shadowPageNumber) Called whenever a page or shadow-page is needed.
void	setListener(PDFCreationListener listener)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDocument

public Document getDocument()

getPdfDocument

public org.apache.pdfbox.pdmodel.PDDocument getPdfDocument()

Returns the PDDocument or null if it has been closed.

getFontResolver

public PdfBoxFontResolver getFontResolver()

Get the PDF-BOX font resolver. Can be used to add fonts in code.

getPDFVersion

public float getPDFVersion()

layout

public void layout()

createPDF

public void createPDF()
               throws IOException

Creates a PDF with setup specified by builder. On finsihing or failing, saves (if successful) and closes the PDF document.

Throws:

IOException

createPDFWithoutClosing

public void createPDFWithoutClosing()
                             throws IOException

Creates a PDF with setup specified by builder. On finsihing or failing, DOES NOT save or close the PDF document. Useful for post-processing the PDDocument which can be retrieved by getPdfDocument().

Prefer createPDFKeepOpen() with try-with-resources.

Throws:

IOException

createPDFKeepOpen

public org.apache.pdfbox.pdmodel.PDDocument createPDFKeepOpen()
                                                       throws IOException

Creates a PDF with setup specified by builder. On finishing or failing, DOES NOT save or close the PDF document. Useful for post-processing the PDDocument which is returned.

NOTE: It is recommended to use this method with try-with-resources to avoid leaving the PDDocument open.

Throws:

IOException

finishPDF

@Deprecated
public void finishPDF()
                           throws IOException

Deprecated.

Throws:

IOException

getOutputDevice

public PdfBoxOutputDevice getOutputDevice()

getSharedContext

public SharedContext getSharedContext()

getRootBox

public BlockBox getRootBox()

getDotsPerPoint

public float getDotsPerPoint()

findPagePositionsByID

public List<PagePosition<Box>> findPagePositionsByID(Pattern pattern)

getListener

public PDFCreationListener getListener()

setListener

public void setListener(PDFCreationListener listener)

close

public void close()

Cleanup thread resources. MUST be called after finishing with the renderer.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

requestPage

public org.apache.pdfbox.pdmodel.PDPage requestPage(org.apache.pdfbox.pdmodel.PDDocument doc,
                                                    float pageWidth,
                                                    float pageHeight,
                                                    int pageNumber,
                                                    int shadowPageNumber)

Description copied from interface: PageSupplier

Called whenever a page or shadow-page is needed.

Specified by:

requestPage in interface PageSupplier

Parameters:

doc - PDDocument the page belongs to

pageWidth - Width of page in PDF points (1/72 inch)

pageHeight - Height of page in PDF points

pageNumber - Number of the layout page - this may differ from the PDF document page if there are previous shadow pages.

shadowPageNumber - Number of the shadow-page or -1 if on a main page.

Returns:

PDPage

getLastContentBottom

public float getLastContentBottom()

Returns the bottom Y postion in bottom-up PDF units on the last page of content. WARNING: NOT transform aware.

getLayersPositions

public List<PagePosition<Layer>> getLayersPositions()

Returns a list of page positions for all layers in the document. The page positions are sorted from first page to last and then top to bottom. The page position values are in bottom-up PDF units. WARNING: NOT transform aware. Transformed layers will return page positions that are not correct.

getLayerPositions

public List<PagePosition<Layer>> getLayerPositions(Layer layer)

Returns a list of page positions for a single layer. The page positions are sorted from first page to last and then top to bottom. The page position values are in bottom-up PDF units. Compare to getLayersPositions() which will return page positions for all layers. WARNING: NOT transform aware. A transformed layer will return page positions that are not correct.