com.groupdocs.parser.options

Class OcrOptions

java.lang.Object

com.groupdocs.parser.options.OcrOptions

public class OcrOptions
extends Object

Provides the options which are used for OCR Connector.

Constructor Summary

Constructors

Constructor and Description
OcrOptions() Initializes a new instance of the OcrOptions class with default values.
OcrOptions(OcrEventHandler handler) Initializes a new instance of the OcrOptions class with OcrEventHandler object.
OcrOptions(PagePreviewOptions pagePreviewOptions) Initializes a new instance of the OcrOptions class with page preview options.
OcrOptions(Rectangle rectangle) Initializes a new instance of the OcrOptions class with rectangular area.
OcrOptions(Rectangle rectangle, OcrEventHandler handler) Initializes a new instance of the OcrOptions class with rectangular area and OcrEventHandler object.
OcrOptions(Rectangle rectangle, OcrEventHandler handler, boolean useSpellCheker) Initializes a new instance of the OcrOptions class.

Method Summary

Modifier and Type	Method and Description
OcrEventHandler	getHandler() Gets the event handler to catch OCR events.
Language	getLanguage() Gets the language used for optical character recognition.
PagePreviewOptions	getPagePreviewOptions() Gets the page preview options used to render the page that is fed to the OCR engine.
Rectangle	getRectangle() Gets the rectangular area that constraints the page area which is used for text recognizing.
boolean	getUseSpellChecker() Gets the value that indicates whether the spell checker is used.
void	setHandler(OcrEventHandler handler) Sets the event handler to catch OCR events.
void	setLanguage(Language language) Sets the language used for optical character recognition.
void	setPagePreviewOptions(PagePreviewOptions pagePreviewOptions) Sets the page preview options used to render the page that is fed to the OCR engine.
void	setRectangle(Rectangle rectangle) Sets the rectangular area that constraints the page area which is used for text recognizing.
void	setUseSpellChecker(boolean useSpellChecker) Sets the value that indicates whether the spell checker is used.

Methods inherited from class java.lang.Object

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

Constructor Detail

OcrOptions

public OcrOptions()

Initializes a new instance of the OcrOptions class with default values.

OcrOptions

public OcrOptions(Rectangle rectangle)

Initializes a new instance of the OcrOptions class with rectangular area.

Parameters:

rectangle - The rectangular area that constraints the page area which is used for text recognizing.

OcrOptions

public OcrOptions(PagePreviewOptions pagePreviewOptions)

Initializes a new instance of the OcrOptions class with page preview options.

Parameters:

pagePreviewOptions - The options used to render the page preview which is fed to the OCR engine.

OcrOptions

public OcrOptions(OcrEventHandler handler)

Initializes a new instance of the OcrOptions class with OcrEventHandler object.

Parameters:

handler - An instance of OcrEventHandler to catch OCR events.

OcrOptions

public OcrOptions(Rectangle rectangle,
                  OcrEventHandler handler)

Initializes a new instance of the OcrOptions class with rectangular area and OcrEventHandler object.

Parameters:

rectangle - The rectangular area that constraints the page area which is used for text recognizing.

handler - An instance of OcrEventHandler to catch OCR events.

OcrOptions

public OcrOptions(Rectangle rectangle,
                  OcrEventHandler handler,
                  boolean useSpellCheker)

Initializes a new instance of the OcrOptions class.

Parameters:

rectangle - The rectangular area that constraints the page area which is used for text recognizing.

handler - An instance of OcrEventHandler to catch OCR events.

useSpellCheker - The value that indicates whether the spell checker is used.

Method Detail

getRectangle

public Rectangle getRectangle()

Gets the rectangular area that constraints the page area which is used for text recognizing.

Returns:

An instance of Rectangle class that represents the rectangular area that constraints the page area which is used for text recognizing; null if it isn't set.

getHandler

public OcrEventHandler getHandler()

Gets the event handler to catch OCR events.

Returns:

An instance of OcrEventHandler class which is used to catch OCR events.

getUseSpellChecker

public boolean getUseSpellChecker()

Gets the value that indicates whether the spell checker is used.

Returns:

true if the spell checker is used; otherwise, false.

getPagePreviewOptions

public PagePreviewOptions getPagePreviewOptions()

Gets the page preview options used to render the page that is fed to the OCR engine.

Returns:

The PagePreviewOptions, or null if not set.

setPagePreviewOptions

public void setPagePreviewOptions(PagePreviewOptions pagePreviewOptions)

Sets the page preview options used to render the page that is fed to the OCR engine.

Parameters:

pagePreviewOptions - The page preview options.

getLanguage

public Language getLanguage()

Gets the language used for optical character recognition.

Returns:

The Language enum value. Defaults to Language.Eng.

setLanguage

public void setLanguage(Language language)

Sets the language used for optical character recognition.

Parameters:

language - The Language enum value.

setRectangle

public void setRectangle(Rectangle rectangle)

Sets the rectangular area that constraints the page area which is used for text recognizing.

Parameters:

rectangle - The rectangle, or null to scan the whole page.

setHandler

public void setHandler(OcrEventHandler handler)

Sets the event handler to catch OCR events.

Parameters:

handler - The event handler.

setUseSpellChecker

public void setUseSpellChecker(boolean useSpellChecker)

Sets the value that indicates whether the spell checker is used.

Parameters:

useSpellChecker - true to enable spell checking.