pdfOCR 4.1.0  Overview   Package   Class  Text Changes  Statistics  Help 
Generated by
JDiff
PREV PACKAGE    NEXT PACKAGE          FRAMES    NO FRAMES  

com.itextpdf.pdfocr Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.pdfocr 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 OcrPdfCreator

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

OcrPdfCreator provides possibilities to set list of input images to be used for OCR, to set scaling mode for images, to set color of text in output PDF document, to set fixed size of the PDF document's page and to perform OCR using given images and to return com.itextpdf.kernel.pdf.PdfDocument as result. OCR is based on the provided IOcrEngine (e.g. tesseract reader). This parameter is obligatory and it should be provided in constructor or using setter.

Class OcrPdfCreator, PdfDocument createPdfA(List, PdfWriter, DocumentProperties, PdfOutputIntent, IOcrProcessProperties)

Performs OCR with set parameters using provided IOcrEngine and creates PDF using provided com.itextpdf.kernel.pdf.PdfWriter, } DocumentProperties and {@link com.itextpdf.kernel.pdf.PdfOutputIntent. PDF/A-3u document will be created if provided com.itextpdf.kernel.pdf.PdfOutputIntent is not null.

NOTE that after executing this method you will have a product event from the both itextcore and pdfOcr. Therefore, use this method only if you need to work with the generated PdfDocument. If you don't need this, use the OcrPdfCreator.createPdfAFile method. In this case, only the pdfOcr event will be dispatched. @param inputImages java.util.List of images to be OCRed @param pdfWriter the com.itextpdf.kernel.pdf.PdfWriter object to write final PDF document to @param documentProperties document properties @param pdfOutputIntent com.itextpdf.kernel.pdf.PdfOutputIntent for PDF/A-3u document @param ocrProcessProperties extra OCR process properties passed to OcrProcessContext @return result PDF/A-3u com.itextpdf.kernel.pdf.PdfDocument object @throws PdfOcrException if it was not possible to read provided or or default font

Class OcrPdfCreator, IOcrEngine getOcrEngine()

Gets used IOcrEngine . Returns IOcrEngine reader object to perform OCR. @return selected IOcrEngine instance
Class OcrPdfCreator, void setOcrEngine(IOcrEngine)

Sets IOcrEngine reader object to perform OCR. @param reader selected IOcrEngine instance
Class OcrPdfCreatorProperties, Rectangle getPageSize()

Gets required size for output PDF document. Real size of the page will be calculated according to the selected ScaleMode. @return required page size as com.itextpdf.kernel.geom.Rectangle
Class OcrPdfCreatorProperties, OcrPdfCreatorProperties setImageLayerName(String)

Sets name for the image layer . , {@code null} by default.

If {@code null} then image is placed directly in canvas instead of layer. If image layer name is equal to text layer name then text and image placed in one layer. This property has no effect when pdf file is being OCRed (OcrPdfCreator.makePdfSearchable). @param layerName name of the image layer as java.lang.String @return the OcrPdfCreatorProperties instance
Class OcrPdfCreatorProperties, OcrPdfCreatorProperties setPageSize(Rectangle)

Sets required size for output PDF document.

This property has no effect when pdf file is being OCRed (OcrPdfCreator.makePdfSearchable). @param pageSize requested page size as com.itextpdf.kernel.geom.Rectangle @return the OcrPdfCreatorProperties instance

Class OcrPdfCreatorProperties, OcrPdfCreatorProperties setScaleMode(ScaleMode)

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

This property has no effect when pdf file is being OCRed (OcrPdfCreator.makePdfSearchable). @param scaleMode selected ScaleMode @return the OcrPdfCreatorProperties instance