com.itextpdf.html2pdf

Class ConverterProperties

java.lang.Object

com.itextpdf.html2pdf.ConverterProperties

public class ConverterProperties
extends Object

Properties that will be used by the converter.

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() Checks if is an AcroForm needs to be created.
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 This is used for convertToDocument methods and will be overwritten to false if a page-counter declaration is present in the CSS of the HTML being converted.
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.

Returns:

the media device description

setMediaDeviceDescription

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

Sets the media device description.

Parameters:

mediaDeviceDescription - the media device description

Returns:

the ConverterProperties instance

getFontProvider

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

Gets the font provider.

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.

Returns:

the TagWorkerFactory

setTagWorkerFactory

public ConverterProperties setTagWorkerFactory(ITagWorkerFactory tagWorkerFactory)

Sets the TagWorkerFactory.

Parameters:

tagWorkerFactory - the TagWorkerFactory

Returns:

the ConverterProperties instance

getCssApplierFactory

public ICssApplierFactory getCssApplierFactory()

Gets the CSS applier factory.

Returns:

the CSS applier factory

setCssApplierFactory

public ConverterProperties setCssApplierFactory(ICssApplierFactory cssApplierFactory)

Sets the CSS applier factory.

Parameters:

cssApplierFactory - the CSS applier factory

Returns:

the ConverterProperties instance

getBaseUri

public String getBaseUri()

Gets the base URI.

Returns:

the base URI

setBaseUri

public ConverterProperties setBaseUri(String baseUri)

Sets the base URI.

Parameters:

baseUri - the base URI

Returns:

the ConverterProperties instance

isCreateAcroForm

public boolean isCreateAcroForm()

Checks if is an AcroForm needs to be created.

Returns:

true, an AcroForm should be created

setCreateAcroForm

public ConverterProperties setCreateAcroForm(boolean createAcroForm)

Sets the createAcroForm value.

Parameters:

createAcroForm - true if an AcroForm needs to be created

Returns:

the ConverterProperties instance

getOutlineHandler

public OutlineHandler getOutlineHandler()

Gets the outline handler.

Returns:

the outline handler

setOutlineHandler

public ConverterProperties setOutlineHandler(OutlineHandler outlineHandler)

Sets the outline handler. 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.

Returns:

the charset

setCharset

public ConverterProperties setCharset(String charset)

Sets the encoding charset.

Parameters:

charset - the charset

Returns:

the ConverterProperties instance

isImmediateFlush

public boolean isImmediateFlush()

Checks if immediateFlush is set

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 convertToDocument 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 convertToPdf or convertToElements

Parameters:

immediateFlush - the immediate flush value

Returns:

the ConverterProperties

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:

this ConverterProperties instance