com.openhtmltopdf.pdfboxout

Class PdfRendererBuilder

java.lang.Object

com.openhtmltopdf.outputdevice.helper.BaseRendererBuilder<PdfRendererBuilder>

com.openhtmltopdf.pdfboxout.PdfRendererBuilder

public class PdfRendererBuilder
extends BaseRendererBuilder<PdfRendererBuilder>

Nested Class Summary

Nested classes/interfaces inherited from class com.openhtmltopdf.outputdevice.helper.BaseRendererBuilder

BaseRendererBuilder.FontStyle, BaseRendererBuilder.PageSizeUnits, BaseRendererBuilder.TextDirection

Field Summary

Fields inherited from class com.openhtmltopdf.outputdevice.helper.BaseRendererBuilder

_baseUri, _cache, _charBreaker, _document, _domMutators, _file, _html, _httpStreamFactory, _initialPageNumber, _isPageSizeInches, _lineBreaker, _mathmlImpl, _objectDrawerFactory, _pageHeight, _pageWidth, _pagingMode, _preferredDocumentBuilderFactoryImplementationClass, _preferredTransformerFactoryImplementationClass, _reorderer, _replacementText, _resolver, _splitter, _svgImpl, _testMode, _textDirection, _unicodeToLowerTransformer, _unicodeToTitleTransformer, _unicodeToUpperTransformer, _uri, PAGE_SIZE_LETTER_HEIGHT, PAGE_SIZE_LETTER_UNITS, PAGE_SIZE_LETTER_WIDTH

Constructor Summary

Constructors

Constructor and Description
PdfRendererBuilder()

Method Summary

Modifier and Type	Method and Description
PdfBoxRenderer	buildPdfRenderer() Build a PdfBoxRenderer for further customization.
void	run() Run the XHTML/XML to PDF conversion and output to an output stream set by toStream.
PdfRendererBuilder	toStream(OutputStream out) An output stream to output the resulting PDF.
PdfRendererBuilder	useFont(File fontFile, String fontFamily) Simpler overload for #useFont(File, String, Integer, FontStyle, boolean)
PdfRendererBuilder	useFont(File fontFile, String fontFamily, Integer fontWeight, BaseRendererBuilder.FontStyle fontStyle, boolean subset) Like #useFont(FSSupplier, String, Integer, FontStyle, boolean), but allows to supply a font file.
PdfRendererBuilder	useFont(FSSupplier<InputStream> supplier, String fontFamily) Simpler overload for #useFont(FSSupplier, String, Integer, FontStyle, boolean)
PdfRendererBuilder	useFont(FSSupplier<InputStream> supplier, String fontFamily, Integer fontWeight, BaseRendererBuilder.FontStyle fontStyle, boolean subset) Add a font programmatically.
PdfRendererBuilder	usePDDocument(org.apache.pdfbox.pdmodel.PDDocument doc) By default, this project creates an entirely in-memory PDDocument.
PdfRendererBuilder	usePdfVersion(float version) Set the PDF version, typically we use 1.7.
PdfRendererBuilder	withProducer(String producer) Set a producer on the output document

Methods inherited from class com.openhtmltopdf.outputdevice.helper.BaseRendererBuilder

addDOMMutator, defaultTextDirection, testMode, useCache, useDefaultPageSize, useDocumentBuilderFactoryImplementationClass, useHttpStreamImplementation, useMathMLDrawer, useObjectDrawerFactory, useReplacementText, useSVGDrawer, useTransformerFactoryImplementationClass, useUnicodeBidiReorderer, useUnicodeBidiSplitter, useUnicodeCharacterBreaker, useUnicodeLineBreaker, useUnicodeToLowerTransformer, useUnicodeToTitleTransformer, useUnicodeToUpperTransformer, useUriResolver, withFile, withHtmlContent, withUri, withW3cDocument

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfRendererBuilder

public PdfRendererBuilder()

Method Detail

run

public void run()
         throws Exception

Run the XHTML/XML to PDF conversion and output to an output stream set by toStream.

Throws:

Exception

buildPdfRenderer

public PdfBoxRenderer buildPdfRenderer()

Build a PdfBoxRenderer for further customization. Remember to call PdfBoxRenderer.cleanup() after use.

Returns:

toStream

public PdfRendererBuilder toStream(OutputStream out)

An output stream to output the resulting PDF. The caller is required to close the output stream after calling run.

Parameters:

out -

Returns:

usePdfVersion

public PdfRendererBuilder usePdfVersion(float version)

Set the PDF version, typically we use 1.7. If you set a lower version, it is your responsibility to make sure no more recent PDF features are used.

Parameters:

version -

Returns:

usePDDocument

public PdfRendererBuilder usePDDocument(org.apache.pdfbox.pdmodel.PDDocument doc)

By default, this project creates an entirely in-memory PDDocument. The user can use this method to create a document either entirely on-disk or a mix of in-memory and on-disk using the PDDocument constructor that takes a MemoryUsageSetting.

Parameters:

doc - a (usually empty) PDDocument

Returns:

this for method chaining

useFont

public PdfRendererBuilder useFont(FSSupplier<InputStream> supplier,
                                  String fontFamily,
                                  Integer fontWeight,
                                  BaseRendererBuilder.FontStyle fontStyle,
                                  boolean subset)

Add a font programmatically. If the font is NOT subset, it will be downloaded when the renderer is run, otherwise the font will only be downloaded if needed. Therefore, the user could add many fonts, confidant that only those that are used will be downloaded and processed. The InputStream returned by the supplier will be closed by the caller. Fonts should generally be subset, except when used in form controls. FSSupplier is a lambda compatible interface. Fonts can also be added using a font-face at-rule in the CSS.

Parameters:

supplier -

fontFamily -

fontWeight -

fontStyle -

subset -

Returns:

useFont

public PdfRendererBuilder useFont(FSSupplier<InputStream> supplier,
                                  String fontFamily)

Simpler overload for #useFont(FSSupplier, String, Integer, FontStyle, boolean)

Parameters:

supplier -

fontFamily -

Returns:

useFont

public PdfRendererBuilder useFont(File fontFile,
                                  String fontFamily,
                                  Integer fontWeight,
                                  BaseRendererBuilder.FontStyle fontStyle,
                                  boolean subset)

Like #useFont(FSSupplier, String, Integer, FontStyle, boolean), but allows to supply a font file. If the font file is a .ttc file it is handled as TrueTypeCollection. If you have the font in file form you should use this API.

useFont

public PdfRendererBuilder useFont(File fontFile,
                                  String fontFamily)

Simpler overload for #useFont(File, String, Integer, FontStyle, boolean)

Parameters:

fontFile -

fontFamily -

Returns:

withProducer

public PdfRendererBuilder withProducer(String producer)

Set a producer on the output document

Parameters:

producer - the name of the producer to set defaults to openhtmltopdf.com

Returns:

this for method chaining