com.openhtmltopdf.outputdevice.helper

Class BaseRendererBuilder<TFinalClass extends BaseRendererBuilder,TBaseRendererBuilderState extends BaseRendererBuilder.BaseRendererBuilderState>

java.lang.Object

com.openhtmltopdf.outputdevice.helper.BaseRendererBuilder<TFinalClass,TBaseRendererBuilderState>

public abstract class BaseRendererBuilder<TFinalClass extends BaseRendererBuilder,TBaseRendererBuilderState extends BaseRendererBuilder.BaseRendererBuilderState>
extends Object

Baseclass for all RendererBuilders (PDF and Java2D), has all common settings

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseRendererBuilder.BaseRendererBuilderState This class is an internal implementation detail
static class	BaseRendererBuilder.FontStyle
static class	BaseRendererBuilder.PageSizeUnits
static class	BaseRendererBuilder.TextDirection

Field Summary

Fields

Modifier and Type	Field and Description
static float	PAGE_SIZE_LETTER_HEIGHT
static BaseRendererBuilder.PageSizeUnits	PAGE_SIZE_LETTER_UNITS
static float	PAGE_SIZE_LETTER_WIDTH
protected TBaseRendererBuilderState	state

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseRendererBuilder(TBaseRendererBuilderState state)

Method Summary

Modifier and Type	Method and Description
TFinalClass	addDOMMutator(FSDOMMutator domMutator) Add a DOM mutator to this builder.
TFinalClass	defaultTextDirection(BaseRendererBuilder.TextDirection textDirection) The default text direction of the document.
TFinalClass	testMode(boolean mode) Whether to use test mode and output the PDF uncompressed.
TFinalClass	useCache(FSCache cache) Provides an external cache which can choose to cache items between runs, such as fonts or logo images.
TFinalClass	useDefaultPageSize(float pageWidth, float pageHeight, BaseRendererBuilder.PageSizeUnits units) Specifies the default page size to use if none is specified in CSS.
TFinalClass	useDocumentBuilderFactoryImplementationClass(String documentBuilderFactoryClass) This method should be considered advanced and is not required for most setups.
TFinalClass	useFastMode() Use the new (May 2018) fast renderer if possible (only PDF at this point).
TFinalClass	useHttpStreamImplementation(FSStreamFactory factory) Provides an HttpStreamFactory implementation if the user desires to use an external HTTP/HTTPS implementation.
TFinalClass	useMathMLDrawer(SVGDrawer mathMlImpl) Use the specified MathML implementation.
TFinalClass	useMultiThreadByteCache(FSMultiThreadCache<byte[]> byteCache) Provides a cache implementation that may be used accross threads.
TFinalClass	useMultiThreadStringCache(FSMultiThreadCache<String> textCache) Provides a cache implementation that may be used accross threads.
TFinalClass	useObjectDrawerFactory(FSObjectDrawerFactory objectDrawerFactory) Set a factory for <object> drawers
TFinalClass	useProtocolsStreamImplementation(FSStreamFactory factory, Set<String> protocols) Provides an FSStreamFactory implementation if the user desires to use an external stream provider for a particular set of protocols.
TFinalClass	useProtocolsStreamImplementation(FSStreamFactory factory, String... protocols) Provides an FSStreamFactory implementation if the user desires to use an external stream provider for a particular list of protocols.
TFinalClass	useReplacementText(String replacement) The replacement text to use if a character is cannot be renderered by any of the specified fonts.
TFinalClass	useSVGDrawer(SVGDrawer svgImpl) Uses the specified SVG drawer implementation.
TFinalClass	useTransformerFactoryImplementationClass(String transformerFactoryClass) This method should be considered advanced and is not required for most setups.
TFinalClass	useUnicodeBidiReorderer(BidiReorderer reorderer) Provides a reorderer to properly reverse RTL text.
TFinalClass	useUnicodeBidiSplitter(BidiSplitterFactory splitter) Provides a text splitter to split text into directional runs.
TFinalClass	useUnicodeCharacterBreaker(FSTextBreaker breaker) Specify the character breaker.
TFinalClass	useUnicodeLineBreaker(FSTextBreaker breaker) Specify the line breaker.
TFinalClass	useUnicodeToLowerTransformer(FSTextTransformer tr) Specify a transformer to use to lower case strings.
TFinalClass	useUnicodeToTitleTransformer(FSTextTransformer tr) Specify a transformer to title case strings.
TFinalClass	useUnicodeToUpperTransformer(FSTextTransformer tr) Specify a transformer to use to upper case strings.
TFinalClass	useUriResolver(FSUriResolver resolver) Provides a uri resolver to resolve relative uris or private uri schemes.
TFinalClass	withFile(File file) Provides a file to convert to PDF.
TFinalClass	withHtmlContent(String html, String baseUri) Provides a string containing XHTML/XML to convert to PDF.
TFinalClass	withUri(String uri) Provides a URI to convert to PDF.
TFinalClass	withW3cDocument(Document doc, String baseUri) Provides a w3c DOM Document acquired from an external source.

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_SIZE_LETTER_WIDTH

public static final float PAGE_SIZE_LETTER_WIDTH

See Also:

Constant Field Values

PAGE_SIZE_LETTER_HEIGHT

public static final float PAGE_SIZE_LETTER_HEIGHT

See Also:

Constant Field Values

PAGE_SIZE_LETTER_UNITS

public static final BaseRendererBuilder.PageSizeUnits PAGE_SIZE_LETTER_UNITS

state

protected final TBaseRendererBuilderState extends BaseRendererBuilder.BaseRendererBuilderState state

Constructor Detail

BaseRendererBuilder

protected BaseRendererBuilder(TBaseRendererBuilderState state)

Method Detail

addDOMMutator

public TFinalClass addDOMMutator(FSDOMMutator domMutator)

Add a DOM mutator to this builder. DOM mutators allow to modify the DOM before it is rendered. e.g. LaTeXDOMMutator can be used to translate latex text within a <latex> node to HTMl and MathML.

Parameters:

domMutator - the DOM Mutator

Returns:

this for method chaining

useTransformerFactoryImplementationClass

public final TFinalClass useTransformerFactoryImplementationClass(String transformerFactoryClass)

This method should be considered advanced and is not required for most setups. Set a preferred implementation class for use as javax.xml.transform.TransformerFactory. Use null to let a default implementation class be used. The default is "com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl". This seems to work with most systems but not JBoss Wildfly and related setups. In this case you can use null to let the container use whatever TransformerFactory it has available.

Parameters:

transformerFactoryClass -

Returns:

this for method chaining

useDocumentBuilderFactoryImplementationClass

public final TFinalClass useDocumentBuilderFactoryImplementationClass(String documentBuilderFactoryClass)

This method should be considered advanced and is not required for most setups. Set a preferred implementation class for use as javax.xml.parsers.DocumentBuilderFactory. Use null to let a default implementation class be used. The default is "com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl". If the default does not work you can use null to let the container use whatever DocumentBuilderFactory it has available.

Parameters:

documentBuilderFactoryClass -

Returns:

this for method chaining

defaultTextDirection

public final TFinalClass defaultTextDirection(BaseRendererBuilder.TextDirection textDirection)

The default text direction of the document. LTR by default.

Parameters:

textDirection -

Returns:

this for method chaining

testMode

public final TFinalClass testMode(boolean mode)

Whether to use test mode and output the PDF uncompressed. Turned off by default.

Parameters:

mode -

Returns:

this for method chaining

useHttpStreamImplementation

public final TFinalClass useHttpStreamImplementation(FSStreamFactory factory)

Provides an HttpStreamFactory implementation if the user desires to use an external HTTP/HTTPS implementation. Uses URL::openStream by default.

Parameters:

factory -

Returns:

this for method chaining

See Also:

{@link #useProtocolsStreamImplementation(FSStreamFactory, String[])}

useProtocolsStreamImplementation

public final TFinalClass useProtocolsStreamImplementation(FSStreamFactory factory,
                                                          Set<String> protocols)

Provides an FSStreamFactory implementation if the user desires to use an external stream provider for a particular set of protocols. Protocols should always be in lower case. NOTE: HttpStreamFactory, despite its historical name, can be used for any protocol including private made-up protocols.

Parameters:

factory -

protocols -

Returns:

this for method chaining

See Also:

#useHttpStreamImplementation(FSStreamFactory)}, #useProtocolsStreamImplementation(FSStreamFactory, String[])}

useProtocolsStreamImplementation

public final TFinalClass useProtocolsStreamImplementation(FSStreamFactory factory,
                                                          String... protocols)

Provides an FSStreamFactory implementation if the user desires to use an external stream provider for a particular list of protocols. Protocols should always be in lower case. NOTE: HttpStreamFactory, despite its historical name, can be used for any protocol including private made-up protocols.

Parameters:

factory -

protocols -

Returns:

this for method chaining

See Also:

#useHttpStreamImplementation(FSStreamFactory)}, #useProtocolsStreamImplementation(FSStreamFactory, Set)}

useUriResolver

public final TFinalClass useUriResolver(FSUriResolver resolver)

Provides a uri resolver to resolve relative uris or private uri schemes.

Parameters:

resolver -

Returns:

this for method chaining

useMultiThreadStringCache

public final TFinalClass useMultiThreadStringCache(FSMultiThreadCache<String> textCache)

Provides a cache implementation that may be used accross threads. Typically used with useMultiThreadByteCache The String cache is used in preference of the byte cache for resources that are needed as text, althrough the byte cache will also be checked before loading the resource. In this case the byte array will be interpreted as UTF-8.

See Also:

#useMultiThreadByteCache(FSMultiThreadCache)}, com.openhtmltopdf.extend.FSMultiThreadCache}

useMultiThreadByteCache

public final TFinalClass useMultiThreadByteCache(FSMultiThreadCache<byte[]> byteCache)

Provides a cache implementation that may be used accross threads. Typically used with useMultiThreadStringCache

See Also:

#useMultiThreadStringCache(FSMultiThreadCache)}, com.openhtmltopdf.extend.FSMultiThreadCache}

useCache

public final TFinalClass useCache(FSCache cache)

Provides an external cache which can choose to cache items between runs, such as fonts or logo images.

Parameters:

cache -

Returns:

this for method chaining

useUnicodeBidiSplitter

public final TFinalClass useUnicodeBidiSplitter(BidiSplitterFactory splitter)

Provides a text splitter to split text into directional runs. Does nothing by default.

Parameters:

splitter -

Returns:

this for method chaining

useUnicodeBidiReorderer

public final TFinalClass useUnicodeBidiReorderer(BidiReorderer reorderer)

Provides a reorderer to properly reverse RTL text. No-op by default.

Parameters:

reorderer -

Returns:

this for method chaining

withHtmlContent

public final TFinalClass withHtmlContent(String html,
                                         String baseUri)

Provides a string containing XHTML/XML to convert to PDF.

Parameters:

html -

baseUri -

Returns:

this for method chaining

withW3cDocument

public final TFinalClass withW3cDocument(Document doc,
                                         String baseUri)

Provides a w3c DOM Document acquired from an external source.

Parameters:

doc -

baseUri -

Returns:

this for method chaining

withUri

public final TFinalClass withUri(String uri)

Provides a URI to convert to PDF. The URI MUST point to a strict XHTML/XML document.

Parameters:

uri -

Returns:

this for method chaining

withFile

public final TFinalClass withFile(File file)

Provides a file to convert to PDF. The file MUST contain XHTML/XML in UTF-8 encoding.

Parameters:

file -

Returns:

this for method chaining

useSVGDrawer

public final TFinalClass useSVGDrawer(SVGDrawer svgImpl)

Uses the specified SVG drawer implementation.

Parameters:

svgImpl - the SVG implementation

Returns:

this for method chaining

useMathMLDrawer

public final TFinalClass useMathMLDrawer(SVGDrawer mathMlImpl)

Use the specified MathML implementation.

Parameters:

mathMlImpl - the MathML implementation

Returns:

this for method chaining

useReplacementText

public final TFinalClass useReplacementText(String replacement)

The replacement text to use if a character is cannot be renderered by any of the specified fonts. This is not broken across lines so should be one or zero characters for best results. Also, make sure it can be rendered by at least one of your specified fonts! The default is the # character.

Parameters:

replacement - the default replacement text

Returns:

this for method chaining

useUnicodeLineBreaker

public final TFinalClass useUnicodeLineBreaker(FSTextBreaker breaker)

Specify the line breaker. By default a Java default BreakIterator line instance is used with US locale. Additionally, this is wrapped with UrlAwareLineBreakIterator to also break before the forward slash (/) character so that long URIs can be broken on to multiple lines. You may want to use a BreakIterator with a different locale (wrapped by UrlAwareLineBreakIterator or not) or a more advanced BreakIterator from icu4j (see the rtl-support module for an example).

Parameters:

breaker -

Returns:

useUnicodeCharacterBreaker

public final TFinalClass useUnicodeCharacterBreaker(FSTextBreaker breaker)

Specify the character breaker. By default a break iterator character instance is used with US locale. Currently this is used when word-wrap: break-word is in effect.

Parameters:

breaker -

Returns:

useUnicodeToUpperTransformer

public final TFinalClass useUnicodeToUpperTransformer(FSTextTransformer tr)

Specify a transformer to use to upper case strings. By default String::toUpperCase(Locale.US) is used.

Parameters:

tr -

Returns:

useUnicodeToLowerTransformer

public final TFinalClass useUnicodeToLowerTransformer(FSTextTransformer tr)

Specify a transformer to use to lower case strings. By default String::toLowerCase(Locale.US) is used.

Parameters:

tr -

Returns:

useUnicodeToTitleTransformer

public final TFinalClass useUnicodeToTitleTransformer(FSTextTransformer tr)

Specify a transformer to title case strings. By default a best effort implementation (non locale aware) is used.

Parameters:

tr -

Returns:

useDefaultPageSize

public final TFinalClass useDefaultPageSize(float pageWidth,
                                            float pageHeight,
                                            BaseRendererBuilder.PageSizeUnits units)

Specifies the default page size to use if none is specified in CSS.

Parameters:

pageWidth -

pageHeight -

units - either mm or inches.

Returns:

See Also:

#PAGE_SIZE_LETTER_WIDTH}, {@link #PAGE_SIZE_LETTER_HEIGHT} and {@link #PAGE_SIZE_LETTER_UNITS}

useObjectDrawerFactory

public final TFinalClass useObjectDrawerFactory(FSObjectDrawerFactory objectDrawerFactory)

Set a factory for <object> drawers

Parameters:

objectDrawerFactory - Object Drawer Factory

Returns:

this for method chaining

useFastMode

public final TFinalClass useFastMode()

Use the new (May 2018) fast renderer if possible (only PDF at this point). This renderer can be 100s of times faster for very large documents. Please note that the fast renderer will be the only renderer at some future release so please at least test your code using the fast mode.

Returns:

this for method chaining