pdfHTML 3.0.2  Overview   Package   Class  Text Changes  Statistics  Help 
Generated by
JDiff
PREV PACKAGE    NEXT PACKAGE          FRAMES    NO FRAMES  

com.itextpdf.html2pdf Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.html2pdf as colored differences. Deletions are shown like this , and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a tag will cause all subsequent paragraphs to be displayed differently.
Class ConverterProperties, String getBaseUri()

Gets the base URI.

Base URI is used to resolve other URI. @return the base URI
Class ConverterProperties, String getCharset()

Gets the encoding charset.

Charset is used to correctly decode an HTML file. @return the charset
Class ConverterProperties, ICssApplierFactory getCssApplierFactory()

Gets the CSS applier factory.

The cssApplierFactory is used to create com.itextpdf.html2pdf.css.apply.ICssApplier, which in turn are used to convert the CSS properties to the PDF properties. @return the CSS applier factory
Class ConverterProperties, IMetaInfo getEventCountingMetaInfo()

Gets html meta info.

This meta info will be passed with to com.itextpdf.kernel.counter.EventCounter with com.itextpdf.html2pdf.events.PdfHtmlEvent and can be used to determine event origin. @return converter's IMetaInfo
Class ConverterProperties, 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. @return the font provider
Class ConverterProperties, 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. @return the media device description
Class ConverterProperties, 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. @return the outline handler
Class ConverterProperties, ITagWorkerFactory getTagWorkerFactory()

Gets the TagWorkerFactory instance.

The tagWorkerFactory is used to create com.itextpdf.html2pdf.attach.ITagWorker, which in turn are used to convert the HTML tags to the PDF elements. @return the TagWorkerFactory
Class ConverterProperties, 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. @return the createAcroForm flag
Class ConverterProperties, boolean isImmediateFlush()

Checks if immediateFlush is set.

This is used for com.itextpdf.html2pdf.HtmlConverter.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 com.itextpdf.html2pdf.HtmlConverter.convertToPdf or com.itextpdf.html2pdf.HtmlConverter.convertToElements. @return true if immediateFlush is set, false if not
Class ConverterProperties, ConverterProperties setBaseUri(String)

Sets the base URI.

Base URI is used to resolve other URI. @param baseUri the base URI @return the ConverterProperties instance
Class ConverterProperties, ConverterProperties setCharset(String)

Sets the encoding charset.

Charset is used to correctly decode an HTML file. @param charset the charset @return the ConverterProperties instance
Class ConverterProperties, ConverterProperties setCreateAcroForm(boolean)

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. @param createAcroForm true if an AcroForm needs to be created @return the ConverterProperties instance
Class ConverterProperties, ConverterProperties setCssApplierFactory(ICssApplierFactory)

Sets the CSS applier factory.

The cssApplierFactory is used to create com.itextpdf.html2pdf.css.apply.ICssApplier, which in turn are used to convert the CSS properties to the PDF properties. @param cssApplierFactory the CSS applier factory @return the ConverterProperties instance
Class ConverterProperties, ConverterProperties setEventCountingMetaInfo(IMetaInfo)

Sets html meta info.

This meta info will be passed with to com.itextpdf.kernel.counter.EventCounter with com.itextpdf.html2pdf.events.PdfHtmlEvent and can be used to determine event origin. @param metaInfo meta info to set @return the ConverterProperties instance
Class ConverterProperties, ConverterProperties setFontProvider(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. @param fontProvider the font provider @return the ConverterProperties instance
Class ConverterProperties, ConverterProperties setImmediateFlush(boolean)

Set the immediate flush property of the layout document.

This is used for com.itextpdf.html2pdf.HtmlConverter.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 com.itextpdf.html2pdf.HtmlConverter.convertToPdf or com.itextpdf.html2pdf.HtmlConverter.convertToElements. @param immediateFlush the immediate flush value @return the ConverterProperties instance
Class ConverterProperties, ConverterProperties setMediaDeviceDescription(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. @param mediaDeviceDescription the media device description @return the ConverterProperties instance
Class ConverterProperties, ConverterProperties setOutlineHandler(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. @param outlineHandler the outline handler @return the ConverterProperties instance
Class ConverterProperties, ConverterProperties setTagWorkerFactory(ITagWorkerFactory)

Sets the TagWorkerFactory.

The tagWorkerFactory is used to create com.itextpdf.html2pdf.attach.ITagWorker, which in turn are used to convert the HTML tags to the PDF elements. @param tagWorkerFactory the TagWorkerFactory @return the ConverterProperties instance