A C D G I L N O P R S T V

A

AbstractPdfOcrEventHelper - Class in com.itextpdf.pdfocr

Helper class for working with events.

AbstractPdfOcrEventHelper() - Constructor for class com.itextpdf.pdfocr.AbstractPdfOcrEventHelper

addCell(TableCellTreeItem) - Method in class com.itextpdf.pdfocr.structuretree.TableRowTreeItem

Add a new table cell structure tree item to the table row.

addChild(LogicalStructureTreeItem) - Method in class com.itextpdf.pdfocr.structuretree.LogicalStructureTreeItem

Add child structure tree item.

addRow(TableRowTreeItem) - Method in class com.itextpdf.pdfocr.structuretree.TableTreeItem

Add a new row structure tree item to the table.

applyRotation(ImageData) - Method in interface com.itextpdf.pdfocr.IImageRotationHandler

Apply rotation to image data.

ArtifactItem - Class in com.itextpdf.pdfocr.structuretree

This class represents artifact structure tree item.

C

CANNOT_ADD_DATA_TO_PDF_DOCUMENT - Static variable in class com.itextpdf.pdfocr.logs.PdfOcrLogMessageConstant

The constant CANNOT_ADD_DATA_TO_PDF_DOCUMENT.

CANNOT_CREATE_PDF_DOCUMENT - Static variable in class com.itextpdf.pdfocr.exceptions.PdfOcrExceptionMessageConstant

CANNOT_READ_DEFAULT_FONT - Static variable in class com.itextpdf.pdfocr.logs.PdfOcrLogMessageConstant

The constant CANNOT_READ_DEFAULT_FONT.

CANNOT_READ_INPUT_IMAGE - Static variable in class com.itextpdf.pdfocr.exceptions.PdfOcrExceptionMessageConstant

CANNOT_READ_INPUT_IMAGE - Static variable in class com.itextpdf.pdfocr.logs.PdfOcrLogMessageConstant

The constant CANNOT_READ_INPUT_IMAGE.

CANNOT_RESOLVE_PROVIDED_FONTS - Static variable in class com.itextpdf.pdfocr.exceptions.PdfOcrExceptionMessageConstant

com.itextpdf.pdfocr - package com.itextpdf.pdfocr

com.itextpdf.pdfocr.exceptions - package com.itextpdf.pdfocr.exceptions

com.itextpdf.pdfocr.logs - package com.itextpdf.pdfocr.logs

com.itextpdf.pdfocr.statistics - package com.itextpdf.pdfocr.statistics

com.itextpdf.pdfocr.structuretree - package com.itextpdf.pdfocr.structuretree

COULD_NOT_FIND_CORRESPONDING_GLYPH_TO_UNICODE_CHARACTER - Static variable in class com.itextpdf.pdfocr.logs.PdfOcrLogMessageConstant

The constant COULD_NOT_FIND_CORRESPONDING_GLYPH_TO_UNICODE_CHARACTER.

createPdf(List<File>, PdfWriter, DocumentProperties, IOcrProcessProperties) - Method in class com.itextpdf.pdfocr.OcrPdfCreator

Performs OCR with set parameters using provided IOcrEngine and creates PDF using provided PdfWriter.

createPdf(List<File>, PdfWriter, DocumentProperties) - Method in class com.itextpdf.pdfocr.OcrPdfCreator

Performs OCR with set parameters using provided IOcrEngine and creates PDF using provided PdfWriter.

createPdf(List<File>, PdfWriter) - Method in class com.itextpdf.pdfocr.OcrPdfCreator

Performs OCR with set parameters using provided IOcrEngine and creates PDF using provided PdfWriter.

createPdfA(List<File>, PdfWriter, DocumentProperties, PdfOutputIntent, IOcrProcessProperties) - Method in class com.itextpdf.pdfocr.OcrPdfCreator

Performs OCR with set parameters using provided IOcrEngine and creates PDF using provided PdfWriter, DocumentProperties and PdfOutputIntent.

createPdfA(List<File>, PdfWriter, PdfOutputIntent) - Method in class com.itextpdf.pdfocr.OcrPdfCreator

Performs OCR with set parameters using provided IOcrEngine and creates PDF using provided PdfWriter and PdfOutputIntent.

createPdfA(List<File>, PdfWriter, DocumentProperties, PdfOutputIntent) - Method in class com.itextpdf.pdfocr.OcrPdfCreator

Performs OCR with set parameters using provided IOcrEngine and creates PDF using provided PdfWriter, DocumentProperties and PdfOutputIntent.

createPdfAFile(List<File>, File, PdfOutputIntent) - Method in class com.itextpdf.pdfocr.OcrPdfCreator

Performs OCR with set parameters using provided IOcrEngine and creates PDF using provided File and PdfOutputIntent.

createPdfFile(List<File>, File) - Method in class com.itextpdf.pdfocr.OcrPdfCreator

Performs OCR with set parameters using provided IOcrEngine and creates PDF using provided File.

createStatisticsAggregatorFromName(String) - Method in class com.itextpdf.pdfocr.statistics.PdfOcrOutputTypeStatisticsEvent

createTxtFile(List<File>, File) - Method in interface com.itextpdf.pdfocr.IOcrEngine

Performs OCR using provided IOcrEngine for the given list of input images and saves output to a text file using provided path.

createTxtFile(List<File>, File, OcrProcessContext) - Method in interface com.itextpdf.pdfocr.IOcrEngine

Performs OCR using provided IOcrEngine for the given list of input images and saves output to a text file using provided path.

D

doImageOcr(File) - Method in interface com.itextpdf.pdfocr.IOcrEngine

Reads data from the provided input image file and returns retrieved data in the format described below.

doImageOcr(File, OcrProcessContext) - Method in interface com.itextpdf.pdfocr.IOcrEngine

Reads data from the provided input image file and returns retrieved data in the format described below.

G

getAccessibilityProperties() - Method in class com.itextpdf.pdfocr.structuretree.LogicalStructureTreeItem

Retrieve structure tree element's properties.

getBboxRect() - Method in class com.itextpdf.pdfocr.TextInfo

Gets bbox coordinates.

getChildren() - Method in class com.itextpdf.pdfocr.structuretree.LogicalStructureTreeItem

Retrieve all child structure tree items.

getConfirmationType() - Method in class com.itextpdf.pdfocr.AbstractPdfOcrEventHelper

Returns the confirmation type of event.

getDefaultFontFamily() - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Gets preferred font family to be used when selecting font from FontProvider.

getDefaultFontFamily() - Method in class com.itextpdf.pdfocr.PdfOcrFontProvider

Gets default font family.

getFontProvider() - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Returns FontProvider that was set previously or if it is null a new instance of PdfOcrFontProvider is returned.

getImageLayerName() - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Gets name of image layer.

getImageRotationHandler() - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Gets image rotation handler instance.

getInstance() - Static method in class com.itextpdf.pdfocr.structuretree.ArtifactItem

Retrieve an instance of ArtifactItem.

getLanguages() - Method in class com.itextpdf.pdfocr.OcrEngineProperties

Gets list of languages required for provided images.

getLogicalStructureTreeItem() - Method in class com.itextpdf.pdfocr.TextInfo

Retrieves structure tree item for the text item.

getMessage() - Method in exception com.itextpdf.pdfocr.exceptions.PdfOcrException

getMessageParams() - Method in exception com.itextpdf.pdfocr.exceptions.PdfOcrException

Gets additional params for Exception message.

getMetaInfoContainer() - Method in interface com.itextpdf.pdfocr.IProductAware

Gets the container with meta info.

getOcrEngine() - Method in class com.itextpdf.pdfocr.OcrPdfCreator

Gets used IOcrEngine.

getOcrEventHelper() - Method in class com.itextpdf.pdfocr.OcrProcessContext

Returns helper for working with events.

getOcrPdfCreatorProperties() - Method in class com.itextpdf.pdfocr.OcrPdfCreator

Gets properties for OcrPdfCreator.

getOcrProcessProperties() - Method in class com.itextpdf.pdfocr.OcrProcessContext

Get extra OCR process properties.

getPageSize() - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Gets required size for output PDF document.

getParent() - Method in class com.itextpdf.pdfocr.structuretree.LogicalStructureTreeItem

Retrieve parent structure tree item.

getPdfLang() - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Gets PDF language.

getPdfOcrStatisticsEventType() - Method in class com.itextpdf.pdfocr.statistics.PdfOcrOutputTypeStatisticsEvent

Gets the type of statistic event.

getProductData() - Method in interface com.itextpdf.pdfocr.IProductAware

Gets object containing information about the product.

getScaleMode() - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Gets scale mode for input images using available options from ScaleMode enumeration.

getSequenceId() - Method in class com.itextpdf.pdfocr.AbstractPdfOcrEventHelper

Returns the sequence id

getStatisticsNames() - Method in class com.itextpdf.pdfocr.statistics.PdfOcrOutputTypeStatisticsEvent

getText() - Method in class com.itextpdf.pdfocr.TextInfo

Gets text element.

getTextColor() - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Gets text color in output PDF document.

getTextLayerName() - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Gets name of text layer.

getTitle() - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Gets PDF document title.

I

IImageRotationHandler - Interface in com.itextpdf.pdfocr

Rotation information may be stored in image metadata.

IOcrEngine - Interface in com.itextpdf.pdfocr

IOcrEngine interface is used for instantiating new OcrReader objects.

IOcrProcessProperties - Interface in com.itextpdf.pdfocr

OCR properties passed to the OCR engine as part of OcrProcessContext.

IProductAware - Interface in com.itextpdf.pdfocr

The interface that holds information about product data and meta info.

isTagged() - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Retrieve information on whether pdf document should be tagged or not.

L

LogicalStructureTreeItem - Class in com.itextpdf.pdfocr.structuretree

This class represents structure tree item of the text item put into the pdf document.

LogicalStructureTreeItem() - Constructor for class com.itextpdf.pdfocr.structuretree.LogicalStructureTreeItem

Instantiate a new LogicalStructureTreeItem instance.

LogicalStructureTreeItem(AccessibilityProperties) - Constructor for class com.itextpdf.pdfocr.structuretree.LogicalStructureTreeItem

Instantiate a new LogicalStructureTreeItem instance.

N

NUMBER_OF_PAGES_IN_IMAGE - Static variable in class com.itextpdf.pdfocr.logs.PdfOcrLogMessageConstant

The constant NUMBER_OF_PAGES_IN_IMAGE.

O

OcrEngineProperties - Class in com.itextpdf.pdfocr

This class contains additional properties for ocr engine.

OcrEngineProperties() - Constructor for class com.itextpdf.pdfocr.OcrEngineProperties

Creates a new OcrEngineProperties instance.

OcrEngineProperties(OcrEngineProperties) - Constructor for class com.itextpdf.pdfocr.OcrEngineProperties

Creates a new OcrEngineProperties instance based on another OcrEngineProperties instance (copy constructor).

OcrPdfCreator - Class in com.itextpdf.pdfocr

OcrPdfCreator is the class that creates PDF documents containing input images and text that was recognized using provided IOcrEngine.

OcrPdfCreator(IOcrEngine) - Constructor for class com.itextpdf.pdfocr.OcrPdfCreator

Creates a new OcrPdfCreator instance.

OcrPdfCreator(IOcrEngine, OcrPdfCreatorProperties) - Constructor for class com.itextpdf.pdfocr.OcrPdfCreator

Creates a new OcrPdfCreator instance.

OcrPdfCreatorProperties - Class in com.itextpdf.pdfocr

Properties that will be used by the OcrPdfCreator.

OcrPdfCreatorProperties() - Constructor for class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Creates a new OcrPdfCreatorProperties instance.

OcrPdfCreatorProperties(OcrPdfCreatorProperties) - Constructor for class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Creates a new OcrPdfCreatorProperties instance based on another OcrPdfCreatorProperties instance (copy constructor).

OcrProcessContext - Class in com.itextpdf.pdfocr

Class for storing ocr processing context.

OcrProcessContext(AbstractPdfOcrEventHelper) - Constructor for class com.itextpdf.pdfocr.OcrProcessContext

Creates an instance of ocr process context

onEvent(AbstractProductITextEvent) - Method in class com.itextpdf.pdfocr.AbstractPdfOcrEventHelper

Handles the event.

P

ParagraphTreeItem - Class in com.itextpdf.pdfocr.structuretree

A convenience class to associate certain text items with the paragraph structure item.

ParagraphTreeItem() - Constructor for class com.itextpdf.pdfocr.structuretree.ParagraphTreeItem

Instantiate a new ParagraphTreeItem instance.

PDF_LANGUAGE_PROPERTY_IS_NOT_SET - Static variable in class com.itextpdf.pdfocr.logs.PdfOcrLogMessageConstant

The constant PDF_LANGUAGE_PROPERTY_IS_NOT_SET.

PdfOcrException - Exception in com.itextpdf.pdfocr.exceptions

Exception class for custom exceptions.

PdfOcrException(String, Throwable) - Constructor for exception com.itextpdf.pdfocr.exceptions.PdfOcrException

Creates a new PdfOcrException.

PdfOcrException(String) - Constructor for exception com.itextpdf.pdfocr.exceptions.PdfOcrException

Creates a new PdfOcrException.

PdfOcrException(Throwable) - Constructor for exception com.itextpdf.pdfocr.exceptions.PdfOcrException

Creates a new PdfOcrException.

PdfOcrExceptionMessageConstant - Class in com.itextpdf.pdfocr.exceptions

Class that bundles all the exception message templates as constants.

PdfOcrFontProvider - Class in com.itextpdf.pdfocr

FontProvider extension for ocr engine.

PdfOcrFontProvider() - Constructor for class com.itextpdf.pdfocr.PdfOcrFontProvider

Creates a new PdfOcrFontProvider instance with the default font and the default font family.

PdfOcrFontProvider(FontSet, String) - Constructor for class com.itextpdf.pdfocr.PdfOcrFontProvider

Creates a new PdfOcrFontProvider instance based on provided FontSet instance and font family.

PdfOcrInputException - Exception in com.itextpdf.pdfocr.exceptions

Exception class for input related exceptions.

PdfOcrInputException(String, Throwable) - Constructor for exception com.itextpdf.pdfocr.exceptions.PdfOcrInputException

Creates a new PdfOcrInputException.

PdfOcrInputException(String) - Constructor for exception com.itextpdf.pdfocr.exceptions.PdfOcrInputException

Creates a new PdfOcrInputException.

PdfOcrInputException(Throwable) - Constructor for exception com.itextpdf.pdfocr.exceptions.PdfOcrInputException

Creates a new PdfOcrInputException.

PdfOcrLogMessageConstant - Class in com.itextpdf.pdfocr.logs

Class that bundles all the log message templates as constants.

PdfOcrMetaInfoContainer - Class in com.itextpdf.pdfocr

Container to keep meta info.

PdfOcrMetaInfoContainer(IMetaInfo) - Constructor for class com.itextpdf.pdfocr.PdfOcrMetaInfoContainer

Creates instance of container to keep passed meta info.

PdfOcrOutputType - Enum in com.itextpdf.pdfocr.statistics

pdfOcr output types for statistics.

PdfOcrOutputTypeStatisticsEvent - Class in com.itextpdf.pdfocr.statistics

Class which represents an event for specifying type of an ocr processing.

PdfOcrOutputTypeStatisticsEvent(PdfOcrOutputType, ProductData) - Constructor for class com.itextpdf.pdfocr.statistics.PdfOcrOutputTypeStatisticsEvent

Creates instance of pdfOcr statistics event.

PROVIDED_FONT_PROVIDER_IS_INVALID - Static variable in class com.itextpdf.pdfocr.logs.PdfOcrLogMessageConstant

The constant PROVIDED_FONT_PROVIDER_IS_INVALID.

R

removeChild(LogicalStructureTreeItem) - Method in class com.itextpdf.pdfocr.structuretree.LogicalStructureTreeItem

Remove child structure tree item.

S

ScaleMode - Enum in com.itextpdf.pdfocr

Enumeration of the possible scale modes for input images.

setAccessibilityProperties(AccessibilityProperties) - Method in class com.itextpdf.pdfocr.structuretree.LogicalStructureTreeItem

Set structure tree element's properties.

setBboxRect(Rectangle) - Method in class com.itextpdf.pdfocr.TextInfo

Sets text bbox.

setFontProvider(FontProvider) - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Sets font provider.

setFontProvider(FontProvider, String) - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Sets font provider and default font family.

setImageLayerName(String) - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Sets name for the image layer.

setImageRotationHandler(IImageRotationHandler) - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Sets image rotation handler instance.

setLanguages(List<String>) - Method in class com.itextpdf.pdfocr.OcrEngineProperties

Sets list of languages to be recognized in provided images.

setLogicalStructureTreeItem(LogicalStructureTreeItem) - Method in class com.itextpdf.pdfocr.TextInfo

Sets logical structure tree parent item for the text info.

setMessageParams(String...) - Method in exception com.itextpdf.pdfocr.exceptions.PdfOcrException

Sets additional params for Exception message.

setMetaInfo(IMetaInfo) - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Set meta info for this OcrPdfCreatorProperties.

setOcrEngine(IOcrEngine) - Method in class com.itextpdf.pdfocr.OcrPdfCreator

Sets IOcrEngine reader object to perform OCR.

setOcrEventHelper(AbstractPdfOcrEventHelper) - Method in class com.itextpdf.pdfocr.OcrProcessContext

Sets ocr event helper.

setOcrPdfCreatorProperties(OcrPdfCreatorProperties) - Method in class com.itextpdf.pdfocr.OcrPdfCreator

Sets properties for OcrPdfCreator.

setPageSize(Rectangle) - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Sets required size for output PDF document.

setPdfLang(String) - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Specify PDF natural language, and optionally locale.

setScaleMode(ScaleMode) - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Sets scale mode for input images using available options from ScaleMode enumeration.

setTagged(boolean) - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Defines whether pdf document should be tagged or not.

setText(String) - Method in class com.itextpdf.pdfocr.TextInfo

Sets text element.

setTextColor(Color) - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Sets text color in output PDF document.

setTextLayerName(String) - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Sets name for the text layer.

setTitle(String) - Method in class com.itextpdf.pdfocr.OcrPdfCreatorProperties

Sets PDF document title.

SpanTreeItem - Class in com.itextpdf.pdfocr.structuretree

A convenience class to associate certain text items with the span structure item.

SpanTreeItem() - Constructor for class com.itextpdf.pdfocr.structuretree.SpanTreeItem

Instantiate a new SpanTreeItem instance.

START_OCR_FOR_IMAGES - Static variable in class com.itextpdf.pdfocr.logs.PdfOcrLogMessageConstant

The constant START_OCR_FOR_IMAGES.

STATISTICS_EVENT_TYPE_CANT_BE_NULL - Static variable in class com.itextpdf.pdfocr.exceptions.PdfOcrExceptionMessageConstant

STATISTICS_EVENT_TYPE_IS_NOT_DETECTED - Static variable in class com.itextpdf.pdfocr.exceptions.PdfOcrExceptionMessageConstant

T

TableCellTreeItem - Class in com.itextpdf.pdfocr.structuretree

A convenience class to associate certain text items with the table cell structure item.

TableCellTreeItem() - Constructor for class com.itextpdf.pdfocr.structuretree.TableCellTreeItem

Instantiate a new TableCellTreeItem instance.

TableRowTreeItem - Class in com.itextpdf.pdfocr.structuretree

A convenience class to associate certain text items with the table row structure item.

TableRowTreeItem() - Constructor for class com.itextpdf.pdfocr.structuretree.TableRowTreeItem

Instantiate a new TableRowTreeItem instance.

TableTreeItem - Class in com.itextpdf.pdfocr.structuretree

A convenience class to associate certain text items with the table structure item.

TableTreeItem() - Constructor for class com.itextpdf.pdfocr.structuretree.TableTreeItem

Instantiate a new TableTreeItem instance.

TAGGING_IS_NOT_SUPPORTED - Static variable in class com.itextpdf.pdfocr.exceptions.PdfOcrExceptionMessageConstant

TextInfo - Class in com.itextpdf.pdfocr

This class describes how recognized text is positioned on the image providing bbox for each text item (could be a line or a word).

TextInfo() - Constructor for class com.itextpdf.pdfocr.TextInfo

Creates a new TextInfo instance.

TextInfo(TextInfo) - Constructor for class com.itextpdf.pdfocr.TextInfo

Creates a new TextInfo instance from existing one.

TextInfo(String, Rectangle) - Constructor for class com.itextpdf.pdfocr.TextInfo

Creates a new TextInfo instance.

V

valueOf(String) - Static method in enum com.itextpdf.pdfocr.ScaleMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.itextpdf.pdfocr.statistics.PdfOcrOutputType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.itextpdf.pdfocr.ScaleMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.itextpdf.pdfocr.statistics.PdfOcrOutputType

Returns an array containing the constants of this enum type, in the order they are declared.

A C D G I L N O P R S T V