Modifier and Type	Class and Description
private static class	PdfBoxRenderer.NullUserInterface

Modifier and Type	Field and Description
private byte[]	_colorProfile
private byte	_defaultTextDirection
private Document	_doc
private final List<FSDOMMutator>	_domMutators
private final float	_dotsPerPoint
private final int	_initialPageNumber
private PDFCreationListener	_listener
private SVGDrawer	_mathmlImpl
private OutputStream	_os
private final PdfBoxOutputDevice	_outputDevice
private PageSupplier	_pageSupplier
private PdfRendererBuilder.PdfAConformance	_pdfAConformance
private PDDocument	_pdfDoc
private PDEncryption	_pdfEncryption
private boolean	_pdfUaConformance
private float	_pdfVersion
private String	_producer
private BidiReorderer	_reorderer
private BlockBox	_root
private final SharedContext	_sharedContext
private BidiSplitterFactory	_splitterFactory
private SVGDrawer	_svgImpl
private boolean	_testMode
private final boolean	_useFastMode
private static final int	DEFAULT_DOTS_PER_PIXEL
private static final float	DEFAULT_DOTS_PER_POINT
private static final int	DEFAULT_PDF_POINTS_PER_INCH
private final Closeable	diagnosticConsumer
private final Comparator<PagePosition<?>>	PAGE_POSITION_COMPARATOR Start page to end page and then top to bottom on page.

Access	Constructor and Description
pack-priv	PdfBoxRenderer(BaseDocument doc, UnicodeImplementation unicode, PageDimensions pageSize, PdfRendererBuilderState state, Closeable diagnosticConsumer) This method is constantly changing as options are added to the builder.

Method Summary

Modifier and Type	Method and Description
private void	addPdfASchema(PDDocument document, PdfRendererBuilder.PdfAConformance pdfAConformance, boolean isPdfUa)
public void	cleanup() Deprecated Use close instead.
public void	close() Implements java.io.Closeable.close. Cleanup thread resources.
private <T> PagePosition<T>	createPagePosition(String id, T element, int pageNo, float x, float y, float w, float h)
public void	createPDF() Creates a PDF with setup specified by builder.
public void	createPDF(OutputStream os) Deprecated Use builder to set output stream.
public void	createPDF(OutputStream os, boolean finish) Deprecated Use builder to set output stream.
public void	createPDF(OutputStream os, boolean finish, int initialPageNo) Deprecated Use builder to set output stream. NOTE: Caller is responsible for cleaning up the OutputStream.
private XMPSchema	createPdfaProperty(String category, String description, String name, String valueType)
private XMPSchema	createPdfaSchema(String schema, String namespace, String prefix, List<XMPSchema> properties)
private void	createPdfFast(boolean finish, int initialPageNo) Go fast!
public void	createPDFWithoutClosing() Creates a PDF with setup specified by builder.
private String	createXPacket(String metadata)
public void	exportText(Writer writer) Deprecated unused and untested.
private int	findEndPage(RenderingContext c, Layer layer, List<PageBox> pages) Returns the end page number for a layer.
public List<PagePosition<Box>>	findPagePositionsByID(Pattern pattern)
private int	findStartPage(RenderingContext c, Layer layer, List<PageBox> pages) Returns the start page for a layer.
public void	finishPDF() Deprecated
private void	fireOnClose()
private void	firePreOpen()
private void	firePreWrite(int pageCount)
public Document	getDocument()
public float	getDotsPerPoint()
private static Element	getFirstChildElement(Element element)
public PdfBoxFontResolver	getFontResolver() Get the PDF-BOX font resolver.
private Rectangle	getInitialExtents(LayoutContext c)
public float	getLastContentBottom() Returns the bottom Y postion in bottom-up PDF units on the last page of content Warning NOT transform aware.
private List<PagePosition<Layer>>	getLayerPagePositions(Layer layer, List<PageBox> pages, RenderingContext ctx)
public List<PagePosition<Layer>>	getLayerPositions(Layer layer) Returns a list of page positions for a single layer.
public List<PagePosition<Layer>>	getLayersPositions() Returns a list of page positions for all layers in the document.
public PDFCreationListener	getListener()
public PdfBoxOutputDevice	getOutputDevice()
public PDDocument	getPdfDocument() Returns the PDDocument or null if it has been closed.
public float	getPDFVersion()
public BlockBox	getRootBox()
public SharedContext	getSharedContext()
public void	layout()
private Document	loadDocument(String uri)
private LayoutContext	newLayoutContext()
private RenderingContext	newRenderingContext()
private void	paintPage(RenderingContext c, PageBox page)
private void	paintPageFast(RenderingContext c, PageBox page, DisplayListContainer.DisplayListPageContainer pageOperations, int additionalTranslateX)
public PDPage	requestPage(PDDocument `PDDocument` the page belongs to doc, float Width of page in PDF points (1/72 inch) pageWidth, float Height of page in PDF points pageHeight, int Number of the layout page - this may differ from the PDF document page if there are previous shadow pages. pageNumber, int Number of the shadow-page or -1 if on a main page. shadowPageNumber) Implements com.openhtmltopdf.pdfboxout.PageSupplier.requestPage. Called whenever a page or shadow-page is needed.
private void	setDidValues(PDDocument doc)
private void	setDocumentFromStringP(String content, String baseUrl)
private void	setDocumentP(String uri)
private void	setDocumentP(Document doc, String url)
private void	setDocumentP(File file)
private void	setDocumentP(Document doc, String url, NamespaceHandler nsh)
public void	setListener(PDFCreationListener listener)
private String	stringfyMetadata(Element element)
public void	writeNextDocument() Deprecated Doubt this still works as untested.
public void	writeNextDocument(int initialPageNo) Deprecated Doubt this still works as untested.
private void	writePDF(List<PageBox> pages, RenderingContext c, Rectangle2D firstPageSize, PDDocument doc)
private void	writePDFFast(List<PageBox> pages, RenderingContext c, Rectangle2D firstPageSize, PDDocument doc)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_colorProfile	back to summary
private byte[] _colorProfile

_defaultTextDirection	back to summary
private byte _defaultTextDirection

_doc	back to summary
private Document _doc

_domMutators	back to summary
private final List<FSDOMMutator> _domMutators

_dotsPerPoint	back to summary
private final float _dotsPerPoint

_initialPageNumber	back to summary
private final int _initialPageNumber

_listener	back to summary
private PDFCreationListener _listener

_mathmlImpl	back to summary
private SVGDrawer _mathmlImpl

_os	back to summary
private OutputStream _os

_outputDevice	back to summary
private final PdfBoxOutputDevice _outputDevice

_pageSupplier	back to summary
private PageSupplier _pageSupplier

_pdfAConformance	back to summary
private PdfRendererBuilder.PdfAConformance _pdfAConformance

_pdfDoc	back to summary
private PDDocument _pdfDoc

_pdfEncryption	back to summary
private PDEncryption _pdfEncryption

_pdfUaConformance	back to summary
private boolean _pdfUaConformance

_pdfVersion	back to summary
private float _pdfVersion

_producer	back to summary
private String _producer

_reorderer	back to summary
private BidiReorderer _reorderer

_root	back to summary
private BlockBox _root

_sharedContext	back to summary
private final SharedContext _sharedContext

_splitterFactory	back to summary
private BidiSplitterFactory _splitterFactory

_svgImpl	back to summary
private SVGDrawer _svgImpl

_testMode	back to summary
private boolean _testMode

_useFastMode	back to summary
private final boolean _useFastMode

DEFAULT_DOTS_PER_PIXEL	back to summary
private static final int DEFAULT_DOTS_PER_PIXEL

DEFAULT_DOTS_PER_POINT	back to summary
private static final float DEFAULT_DOTS_PER_POINT

DEFAULT_PDF_POINTS_PER_INCH	back to summary
private static final int DEFAULT_PDF_POINTS_PER_INCH

diagnosticConsumer	back to summary
private final Closeable diagnosticConsumer

PAGE_POSITION_COMPARATOR	back to summary
private final Comparator<PagePosition<?>> PAGE_POSITION_COMPARATOR Start page to end page and then top to bottom on page.

Constructor Detail

PdfBoxRenderer	back to summary
pack-priv PdfBoxRenderer(BaseDocument doc, UnicodeImplementation unicode, PageDimensions pageSize, PdfRendererBuilderState state, Closeable diagnosticConsumer) This method is constantly changing as options are added to the builder.

Method Detail

addPdfASchema	back to summary
private void addPdfASchema(PDDocument document, PdfRendererBuilder.PdfAConformance pdfAConformance, boolean isPdfUa)

cleanup	back to summary
public void cleanup() Deprecated Use close instead. Annotations @Deprecated

close	back to summary
public void close() Implements java.io.Closeable.close. Cleanup thread resources. MUST be called after finishing with the renderer. Annotations @Override

back to summary

public void close()

Implements java.io.Closeable.close.

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

Annotations

@Override

createPagePosition	back to summary
private <T> PagePosition<T> createPagePosition(String id, T element, int pageNo, float x, float y, float w, float h)

createPDF	back to summary
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.

createPDF	back to summary
public void createPDF(OutputStream os) throws IOException Deprecated Use builder to set output stream. Annotations @Deprecated

createPDF	back to summary
public void createPDF(OutputStream os, boolean finish) throws IOException Deprecated Use builder to set output stream. Annotations @Deprecated

createPDF	back to summary
public void createPDF(OutputStream os, boolean finish, int initialPageNo) throws IOException Deprecated Use builder to set output stream. NOTE: Caller is responsible for cleaning up the OutputStream. Annotations @Deprecated

createPdfaProperty	back to summary
private XMPSchema createPdfaProperty(String category, String description, String name, String valueType)

createPdfaSchema	back to summary
private XMPSchema createPdfaSchema(String schema, String namespace, String prefix, List<XMPSchema> properties)

createPdfFast	back to summary
private void createPdfFast(boolean finish, int initialPageNo) throws IOException Go fast!

createPDFWithoutClosing	back to summary
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().

createXPacket	back to summary
private String createXPacket(String metadata)

exportText	back to summary
public void exportText(Writer writer) throws IOException Deprecated unused and untested. Annotations @Deprecated

findEndPage	back to summary
private int findEndPage(RenderingContext c, Layer layer, List<PageBox> pages) Returns the end page number for a layer. Transform aware.

findPagePositionsByID	back to summary
public List<PagePosition<Box>> findPagePositionsByID(Pattern pattern)

findStartPage	back to summary
private int findStartPage(RenderingContext c, Layer layer, List<PageBox> pages) Returns the start page for a layer. Transform aware.

finishPDF	back to summary
public void finishPDF() throws IOException Deprecated Annotations @Deprecated

fireOnClose	back to summary
private void fireOnClose()

firePreOpen	back to summary
private void firePreOpen()

firePreWrite	back to summary
private void firePreWrite(int pageCount)

getDocument	back to summary
public Document getDocument()

getDotsPerPoint	back to summary
public float getDotsPerPoint()

getFirstChildElement	back to summary
private static Element getFirstChildElement(Element element)

getFontResolver	back to summary
public PdfBoxFontResolver getFontResolver() Get the PDF-BOX font resolver. Can be used to add fonts in code.

getInitialExtents	back to summary
private Rectangle getInitialExtents(LayoutContext c)

getLastContentBottom	back to summary
public float getLastContentBottom() Returns the bottom Y postion in bottom-up PDF units on the last page of content Warning NOT transform aware.

getLayerPagePositions	back to summary
private List<PagePosition<Layer>> getLayerPagePositions(Layer layer, List<PageBox> pages, RenderingContext ctx)

getLayerPositions back to summary

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.

getLayersPositions	back to summary
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.

getListener	back to summary
public PDFCreationListener getListener()

getOutputDevice	back to summary
public PdfBoxOutputDevice getOutputDevice()

getPdfDocument	back to summary
public PDDocument getPdfDocument() Returns the PDDocument or null if it has been closed.

getPDFVersion	back to summary
public float getPDFVersion()

getRootBox	back to summary
public BlockBox getRootBox()

getSharedContext	back to summary
public SharedContext getSharedContext()

layout

back to summary

public void layout()

loadDocument	back to summary
private Document loadDocument(String uri)

newLayoutContext	back to summary
private LayoutContext newLayoutContext()

newRenderingContext	back to summary
private RenderingContext newRenderingContext()

paintPage	back to summary
private void paintPage(RenderingContext c, PageBox page)

paintPageFast	back to summary
private void paintPageFast(RenderingContext c, PageBox page, DisplayListContainer.DisplayListPageContainer pageOperations, int additionalTranslateX)

requestPage back to summary

public PDPage requestPage(PDDocument doc, float pageWidth, float pageHeight, int pageNumber, int shadowPageNumber)

Implements com.openhtmltopdf.pdfboxout.PageSupplier.requestPage.

Doc from com.openhtmltopdf.pdfboxout.PageSupplier.requestPage.

Called whenever a page or shadow-page is needed.

Parameters

doc:PDDocument: PDDocument the page belongs to
pageWidth:float: Width of page in PDF points (1/72 inch)
pageHeight:float: Height of page in PDF points
pageNumber:int: Number of the layout page - this may differ from the PDF document page if there are previous shadow pages.
shadowPageNumber:int: Number of the shadow-page or -1 if on a main page.

Returns:PDPage

PDPage

Annotations

@Override

setDidValues	back to summary
private void setDidValues(PDDocument doc)

setDocumentFromStringP	back to summary
private void setDocumentFromStringP(String content, String baseUrl)

setDocumentP	back to summary
private void setDocumentP(String uri)

setDocumentP	back to summary
private void setDocumentP(Document doc, String url)

setDocumentP	back to summary
private void setDocumentP(File file) throws IOException

setDocumentP	back to summary
private void setDocumentP(Document doc, String url, NamespaceHandler nsh)

setListener	back to summary
public void setListener(PDFCreationListener listener)

stringfyMetadata	back to summary
private String stringfyMetadata(Element element)

writeNextDocument	back to summary
public void writeNextDocument() throws IOException Deprecated Doubt this still works as untested. Annotations @Deprecated

writeNextDocument	back to summary
public void writeNextDocument(int initialPageNo) throws IOException Deprecated Doubt this still works as untested. Annotations @Deprecated

writePDF	back to summary
private void writePDF(List<PageBox> pages, RenderingContext c, Rectangle2D firstPageSize, PDDocument doc) throws IOException

writePDFFast	back to summary
private void writePDFFast(List<PageBox> pages, RenderingContext c, Rectangle2D firstPageSize, PDDocument doc) throws IOException

com.openhtmltopdf.pdfboxout back to summary

private final Class PdfBoxRenderer.NullUserInterface

Class Inheritance

extends Object
implements UserInterface

java.lang.Object
com.openhtmltopdf.pdfboxout.PdfBoxRenderer.NullUserInterface

All Implemented Interfaces

com.openhtmltopdf.extend.UserInterface

Constructor Summary

Access	Constructor and Description
private	NullUserInterface()

Method Summary

Modifier and Type	Method and Description
public boolean	isActive(Element PARAM e) Implements com.openhtmltopdf.extend.UserInterface.isActive. Gets the active attribute of the UserInterface object
public boolean	isFocus(Element PARAM e) Implements com.openhtmltopdf.extend.UserInterface.isFocus. Gets the focus attribute of the UserInterface object
public boolean	isHover(Element PARAM e) Implements com.openhtmltopdf.extend.UserInterface.isHover. Gets the hover attribute of the UserInterface object