com.itextpdf.pdfocr

Class OcrPdfCreatorProperties

java.lang.Object

com.itextpdf.pdfocr.OcrPdfCreatorProperties

public class OcrPdfCreatorProperties
extends Object

Properties that will be used by the OcrPdfCreator.

Constructor Summary

Constructors

Constructor and Description
OcrPdfCreatorProperties() Creates a new OcrPdfCreatorProperties instance.
OcrPdfCreatorProperties(OcrPdfCreatorProperties other) Creates a new OcrPdfCreatorProperties instance based on another OcrPdfCreatorProperties instance (copy constructor).

Method Summary

Modifier and Type	Method and Description
String	getDefaultFontFamily() Gets preferred font family to be used when selecting font from FontProvider.
com.itextpdf.layout.font.FontProvider	getFontProvider() Returns FontProvider that was set previously or if it is null a new instance of PdfOcrFontProvider is returned.
String	getImageLayerName() Gets name of image layer.
com.itextpdf.kernel.geom.Rectangle	getPageSize() Gets required size for output PDF document.
String	getPdfLang() Gets PDF language.
ScaleMode	getScaleMode() Gets scale mode for input images using available options from ScaleMode enumeration.
com.itextpdf.kernel.colors.Color	getTextColor() Gets text color in output PDF document.
String	getTextLayerName() Gets name of text layer.
String	getTitle() Gets PDF document title.
OcrPdfCreatorProperties	setFontProvider(com.itextpdf.layout.font.FontProvider fontProvider) Sets font provider.
OcrPdfCreatorProperties	setFontProvider(com.itextpdf.layout.font.FontProvider fontProvider, String defaultFontFamily) Sets font provider and default font family.
OcrPdfCreatorProperties	setImageLayerName(String layerName) Sets name for the image layer.
OcrPdfCreatorProperties	setPageSize(com.itextpdf.kernel.geom.Rectangle pageSize) Sets required size for output PDF document.
OcrPdfCreatorProperties	setPdfLang(String language) Specify PDF natural language, and optionally locale.
OcrPdfCreatorProperties	setScaleMode(ScaleMode scaleMode) Sets scale mode for input images using available options from ScaleMode enumeration.
OcrPdfCreatorProperties	setTextColor(com.itextpdf.kernel.colors.Color textColor) Sets text color in output PDF document.
OcrPdfCreatorProperties	setTextLayerName(String layerName) Sets name for the text layer.
OcrPdfCreatorProperties	setTitle(String title) Sets PDF document title.

Methods inherited from class java.lang.Object

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

Constructor Detail

OcrPdfCreatorProperties

public OcrPdfCreatorProperties()

Creates a new OcrPdfCreatorProperties instance.

OcrPdfCreatorProperties

public OcrPdfCreatorProperties(OcrPdfCreatorProperties other)

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

Parameters:

other - the other OcrPdfCreatorProperties instance

Method Detail

getTextColor

public final com.itextpdf.kernel.colors.Color getTextColor()

Gets text color in output PDF document.

Returns:

set text Color

setTextColor

public final OcrPdfCreatorProperties setTextColor(com.itextpdf.kernel.colors.Color textColor)

Sets text color in output PDF document. Text will be transparent by default.

Parameters:

textColor - required text Color

Returns:

the OcrPdfCreatorProperties instance

getScaleMode

public final ScaleMode getScaleMode()

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

Returns:

selected ScaleMode

setScaleMode

public final OcrPdfCreatorProperties setScaleMode(ScaleMode scaleMode)

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

Parameters:

scaleMode - selected ScaleMode

Returns:

the OcrPdfCreatorProperties instance

getPageSize

public final com.itextpdf.kernel.geom.Rectangle getPageSize()

Gets required size for output PDF document. Real size of the page will be calculated according to the selected ScaleMode

Returns:

required page size as Rectangle

setPageSize

public final OcrPdfCreatorProperties setPageSize(com.itextpdf.kernel.geom.Rectangle pageSize)

Sets required size for output PDF document.

Parameters:

pageSize - requested page size as Rectangle

Returns:

the OcrPdfCreatorProperties instance

getImageLayerName

public final String getImageLayerName()

Gets name of image layer.

Returns:

image layer's name as String if it was manually set, otherwise - null

setImageLayerName

public final OcrPdfCreatorProperties setImageLayerName(String layerName)

Sets name for the image layer. null by default. If 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.

Parameters:

layerName - name of the image layer as String

Returns:

the OcrPdfCreatorProperties instance

getTextLayerName

public final String getTextLayerName()

Gets name of text layer.

Returns:

text layer's name as String if it was manually set, otherwise - null

setTextLayerName

public final OcrPdfCreatorProperties setTextLayerName(String layerName)

Sets name for the text layer. null by default. If null then text is placed directly in canvas instead of layer. If text layer name is equal to image layer name then text and image placed in one layer.

Parameters:

layerName - of the text layer as String

Returns:

the OcrPdfCreatorProperties instance

getPdfLang

public final String getPdfLang()

Gets PDF language.

Returns:

PDF document language as String

setPdfLang

public final OcrPdfCreatorProperties setPdfLang(String language)

Specify PDF natural language, and optionally locale. Language identifier shall either be the empty text string, to indicate that the language is unknown, or a Language-Tag as defined in BCP 47 (2009), Tags for the Identification of Languages.

Parameters:

language - PDF document language as String, e.g. "en-US", etc.

Returns:

the OcrPdfCreatorProperties instance

getTitle

public final String getTitle()

Gets PDF document title.

Returns:

PDF title as String

setTitle

public final OcrPdfCreatorProperties setTitle(String title)

Sets PDF document title.

Parameters:

title - PDF title as String

Returns:

the OcrPdfCreatorProperties instance

getFontProvider

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

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

Returns:

FontProvider object

setFontProvider

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

Sets font provider. Please note that passed FontProvider is not to be used in multithreaded environments or for any parallel processing. There will be set the following default font family: PdfOcrFontProvider.getDefaultFontFamily()

Parameters:

fontProvider - selected FontProvider instance

Returns:

the OcrPdfCreatorProperties instance

setFontProvider

public OcrPdfCreatorProperties setFontProvider(com.itextpdf.layout.font.FontProvider fontProvider,
                                               String defaultFontFamily)

Sets font provider and default font family. Please note that passed FontProvider is not to be used in multithreaded environments or for any parallel processing.

Parameters:

fontProvider - selected FontProvider instance

defaultFontFamily - preferred font family to be used when selecting font from FontProvider.

Returns:

the OcrPdfCreatorProperties instance

getDefaultFontFamily

public String getDefaultFontFamily()

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

Returns:

if default font family is not set or it is null or empty PdfOcrFontProvider.getDefaultFontFamily() is returned