com.itextpdf.html2pdf

Class ConverterProperties

java.lang.Object

com.itextpdf.html2pdf.ConverterProperties

public class ConverterProperties
extends Object

Properties that will be used by the HtmlConverter.

Constructor Summary

Constructors

Constructor and Description
ConverterProperties() Instantiates a new ConverterProperties instance.
ConverterProperties(ConverterProperties other) Instantiates a new ConverterProperties instance based on another ConverterProperties instance (copy constructor).

Method Summary

Modifier and Type	Method and Description
String	getBaseUri() Gets the base URI.
String	getCharset() Gets the encoding charset.
ICssApplierFactory	getCssApplierFactory() Gets the CSS applier factory.
com.itextpdf.kernel.counter.event.IMetaInfo	getEventCountingMetaInfo() Gets html meta info.
com.itextpdf.layout.font.FontProvider	getFontProvider() Gets the font provider.
com.itextpdf.styledxmlparser.css.media.MediaDeviceDescription	getMediaDeviceDescription() Gets the media device description.
OutlineHandler	getOutlineHandler() Gets the outline handler.
ITagWorkerFactory	getTagWorkerFactory() Gets the TagWorkerFactory instance.
boolean	isCreateAcroForm() Check if the createAcroForm flag is set.
boolean	isImmediateFlush() Checks if immediateFlush is set.
ConverterProperties	setBaseUri(String baseUri) Sets the base URI.
ConverterProperties	setCharset(String charset) Sets the encoding charset.
ConverterProperties	setCreateAcroForm(boolean createAcroForm) Sets the createAcroForm value.
ConverterProperties	setCssApplierFactory(ICssApplierFactory cssApplierFactory) Sets the CSS applier factory.
ConverterProperties	setEventCountingMetaInfo(com.itextpdf.kernel.counter.event.IMetaInfo metaInfo) Sets html meta info.
ConverterProperties	setFontProvider(com.itextpdf.layout.font.FontProvider fontProvider) Sets the font provider.
ConverterProperties	setImmediateFlush(boolean immediateFlush) Set the immediate flush property of the layout document.
ConverterProperties	setMediaDeviceDescription(com.itextpdf.styledxmlparser.css.media.MediaDeviceDescription mediaDeviceDescription) Sets the media device description.
ConverterProperties	setOutlineHandler(OutlineHandler outlineHandler) Sets the outline handler.
ConverterProperties	setTagWorkerFactory(ITagWorkerFactory tagWorkerFactory) Sets the TagWorkerFactory.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConverterProperties

public ConverterProperties()

Instantiates a new ConverterProperties instance.

ConverterProperties

public ConverterProperties(ConverterProperties other)

Instantiates a new ConverterProperties instance based on another ConverterProperties instance (copy constructor).

Parameters:

other - the other ConverterProperties instance

Method Detail

getMediaDeviceDescription

public com.itextpdf.styledxmlparser.css.media.MediaDeviceDescription getMediaDeviceDescription()

Gets the media device description. The properties of the multimedia device are taken into account when creating the SVG and when processing the properties of the СSS.

Returns:

the media device description

setMediaDeviceDescription

public ConverterProperties setMediaDeviceDescription(com.itextpdf.styledxmlparser.css.media.MediaDeviceDescription mediaDeviceDescription)

Sets the media device description. The properties of the multimedia device are taken into account when creating the SVG and when processing the properties of the СSS.

Parameters:

mediaDeviceDescription - the media device description

Returns:

the ConverterProperties instance

getFontProvider

public com.itextpdf.layout.font.FontProvider getFontProvider()

Gets the font provider. Please note that FontProvider instances cannot be reused across several documents and thus as soon as you set this property, this ConverterProperties instance becomes only useful for a single HTML conversion.

Returns:

the font provider

setFontProvider

public ConverterProperties setFontProvider(com.itextpdf.layout.font.FontProvider fontProvider)

Sets the font provider. Please note that FontProvider instances cannot be reused across several documents and thus as soon as you set this property, this ConverterProperties instance becomes only useful for a single HTML conversion.

Parameters:

fontProvider - the font provider

Returns:

the ConverterProperties instance

getTagWorkerFactory

public ITagWorkerFactory getTagWorkerFactory()

Gets the TagWorkerFactory instance. The tagWorkerFactory is used to create ITagWorker, which in turn are used to convert the HTML tags to the PDF elements.

Returns:

the TagWorkerFactory

setTagWorkerFactory

public ConverterProperties setTagWorkerFactory(ITagWorkerFactory tagWorkerFactory)

Sets the TagWorkerFactory. The tagWorkerFactory is used to create ITagWorker, which in turn are used to convert the HTML tags to the PDF elements.

Parameters:

tagWorkerFactory - the TagWorkerFactory

Returns:

the ConverterProperties instance

getCssApplierFactory

public ICssApplierFactory getCssApplierFactory()

Gets the CSS applier factory. The cssApplierFactory is used to create ICssApplier, which in turn are used to convert the CSS properties to the PDF properties.

Returns:

the CSS applier factory

setCssApplierFactory

public ConverterProperties setCssApplierFactory(ICssApplierFactory cssApplierFactory)

Sets the CSS applier factory. The cssApplierFactory is used to create ICssApplier, which in turn are used to convert the CSS properties to the PDF properties.

Parameters:

cssApplierFactory - the CSS applier factory

Returns:

the ConverterProperties instance

getBaseUri

public String getBaseUri()

Gets the base URI. Base URI is used to resolve other URI.

Returns:

the base URI

setBaseUri

public ConverterProperties setBaseUri(String baseUri)

Sets the base URI. Base URI is used to resolve other URI.

Parameters:

baseUri - the base URI

Returns:

the ConverterProperties instance

isCreateAcroForm

public boolean isCreateAcroForm()

Check if the createAcroForm flag is set. If createAcroForm is set, then when the form is encountered in HTML, AcroForm will be created, otherwise a visually identical, but not functional element will be created. Please bare in mind that the created Acroform may visually differ a bit from the HTML one.

Returns:

the createAcroForm flag

setCreateAcroForm

public ConverterProperties setCreateAcroForm(boolean createAcroForm)

Sets the createAcroForm value. If createAcroForm is set, then when the form is encountered in HTML, AcroForm will be created, otherwise a visually identical, but not functional element will be created. Please bare in mind that the created Acroform may visually differ a bit from the HTML one.

Parameters:

createAcroForm - true if an AcroForm needs to be created

Returns:

the ConverterProperties instance

getOutlineHandler

public OutlineHandler getOutlineHandler()

Gets the outline handler. If outlineHandler is specified, then outlines will be created in the PDF for HTML tags specified in outlineHandler. Please note that OutlineHandler is not thread safe, thus as soon as you have set this property, this ConverterProperties instance cannot be used in converting multiple HTMLs simultaneously.

Returns:

the outline handler

setOutlineHandler

public ConverterProperties setOutlineHandler(OutlineHandler outlineHandler)

Sets the outline handler. If outlineHandler is specified, then outlines will be created in the PDF for HTML tags specified in outlineHandler. Please note that OutlineHandler is not thread safe, thus as soon as you have set this property, this ConverterProperties instance cannot be used in converting multiple HTMLs simultaneously.

Parameters:

outlineHandler - the outline handler

Returns:

the ConverterProperties instance

getCharset

public String getCharset()

Gets the encoding charset. Charset is used to correctly decode an HTML file.

Returns:

the charset

setCharset

public ConverterProperties setCharset(String charset)

Sets the encoding charset. Charset is used to correctly decode an HTML file.

Parameters:

charset - the charset

Returns:

the ConverterProperties instance

isImmediateFlush

public boolean isImmediateFlush()

Checks if immediateFlush is set. This is used for HtmlConverter.convertToDocument(java.lang.String, com.itextpdf.kernel.pdf.PdfWriter) methods and will be overwritten to false if a page-counter declaration is present in the CSS of the HTML being converted. Has no effect when used in conjunction with HtmlConverter.convertToPdf(java.lang.String, java.io.OutputStream) or HtmlConverter.convertToElements(java.lang.String).

Returns:

true if immediateFlush is set, false if not

setImmediateFlush

public ConverterProperties setImmediateFlush(boolean immediateFlush)

Set the immediate flush property of the layout document. This is used for HtmlConverter.convertToDocument(java.lang.String, com.itextpdf.kernel.pdf.PdfWriter) methods and will be overwritten to false if a page-counter declaration is present in the CSS of the HTML being converted. Has no effect when used in conjunction with HtmlConverter.convertToPdf(java.lang.String, java.io.OutputStream) or HtmlConverter.convertToElements(java.lang.String).

Parameters:

immediateFlush - the immediate flush value

Returns:

the ConverterProperties instance

getEventCountingMetaInfo

public com.itextpdf.kernel.counter.event.IMetaInfo getEventCountingMetaInfo()

Gets html meta info. This meta info will be passed with to EventCounter with PdfHtmlEvent and can be used to determine event origin.

Returns:

converter's IMetaInfo

setEventCountingMetaInfo

public ConverterProperties setEventCountingMetaInfo(com.itextpdf.kernel.counter.event.IMetaInfo metaInfo)

Sets html meta info. This meta info will be passed with to EventCounter with PdfHtmlEvent and can be used to determine event origin.

Parameters:

metaInfo - meta info to set

Returns:

the ConverterProperties instance