com.groupdocs.parser.options

Class PageTextAreaOptions

java.lang.Object

com.groupdocs.parser.options.PageAreaOptions

com.groupdocs.parser.options.PageTextAreaOptions

public class PageTextAreaOptions
extends PageAreaOptions

Provides the options which are used for page text areas extraction.

An instance of PageTextAreaOptions class is used as parameter in Parser.getTextAreas(PageTextAreaOptions) and Parser.getTextAreas(int, PageTextAreaOptions) methods. See the usage examples there.

Learn more:

• Extract text areas

Constructor Summary

Constructors

Constructor and Description
PageTextAreaOptions() Initializes a new instance of the PageTextAreaOptions class with default values.
PageTextAreaOptions(boolean useOcr) Initializes a new instance of the TextOptions class with the OCR usage option.
PageTextAreaOptions(boolean useOcr, OcrOptions ocrOptions) Initializes a new instance of the TextOptions class with the ability to set OCR options.
PageTextAreaOptions(String expression) Initializes a new instance of the PageTextAreaOptions class with the regular expression.
PageTextAreaOptions(String expression, boolean matchCase, boolean uniteSegments, boolean ignoreFormatting, Rectangle rectangle) Initializes a new instance of the PageTextAreaOptions class.
PageTextAreaOptions(String expression, boolean matchCase, boolean uniteSegments, boolean ignoreFormatting, Rectangle rectangle, double rectangleTolerance) Initializes a new instance of the PageTextAreaOptions class with the size of the ignored border.
PageTextAreaOptions(String expression, Rectangle rectangle) Initializes a new instance of the PageTextAreaOptions class with the regular expression and rectangular area.
PageTextAreaOptions(String expression, Rectangle rectangle, double rectangleTolerance) Initializes a new instance of the PageTextAreaOptions class with the regular expression, rectangular area and the size of the ignored border.

Method Summary

Modifier and Type	Method and Description
String	getExpression() Gets the regular expression.
OcrOptions	getOcrOptions() Gets the additional options for OCR functionality.
boolean	isIgnoreFormatting() Gets the value that indicates whether text formatting is ignored.
boolean	isMatchCase() Gets the value that indicates whether a text case isn't ignored.
boolean	isUniteSegments() Gets the value that indicates whether segments are united.
boolean	isUseOcr() Gets the value that indicates whether the OCR Connector is used to extract a text.

Methods inherited from class com.groupdocs.parser.options.PageAreaOptions

getRectangle, getRectangleTolerance

Methods inherited from class java.lang.Object

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

Constructor Detail

PageTextAreaOptions

public PageTextAreaOptions()

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

PageTextAreaOptions

public PageTextAreaOptions(boolean useOcr)

Initializes a new instance of the TextOptions class with the OCR usage option.

Parameters:

useOcr - The value that indicates whether the OCR functionality is used to extract a text.

PageTextAreaOptions

public PageTextAreaOptions(boolean useOcr,
                           OcrOptions ocrOptions)

Initializes a new instance of the TextOptions class with the ability to set OCR options.

Parameters:

useOcr - The value that indicates whether the OCR functionality is used to extract a text.

ocrOptions - The additional options for OCR functionality.

PageTextAreaOptions

public PageTextAreaOptions(String expression)

Initializes a new instance of the PageTextAreaOptions class with the regular expression. Other options are set by default (see remarks for details).

The following properties have default values:

• MatchCase: false
• UniteSegments: false
• IgnoreFormatting: false
• Rectangle: null

Parameters:

expression - The regular expression.

PageTextAreaOptions

public PageTextAreaOptions(String expression,
                           Rectangle rectangle)

Initializes a new instance of the PageTextAreaOptions class with the regular expression and rectangular area. Other options are set by default (see remarks for details).

The following properties have default values:

• MatchCase: false
• UniteSegments: false
• IgnoreFormatting: false

Parameters:

expression - The regular expression.

rectangle - The rectangular area that contains page areas.

PageTextAreaOptions

public PageTextAreaOptions(String expression,
                           Rectangle rectangle,
                           double rectangleTolerance)

Initializes a new instance of the PageTextAreaOptions class with the regular expression, rectangular area and the size of the ignored border. Other options are set by default (see remarks for details).

Parameters:

expression - The regular expression.

rectangle - The rectangular area that contains page areas.

rectangleTolerance - The size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height.

rectangleTolerance - The size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height.

PageTextAreaOptions

public PageTextAreaOptions(String expression,
                           boolean matchCase,
                           boolean uniteSegments,
                           boolean ignoreFormatting,
                           Rectangle rectangle)

Initializes a new instance of the PageTextAreaOptions class.

Parameters:

expression - The regular expression.

matchCase - The value that indicates whether a text case isn't ignored.

uniteSegments - The value that indicates whether segments are united.

ignoreFormatting - The value that indicates whether text formatting is ignored.

rectangle - The rectangular area that contains page areas.

PageTextAreaOptions

public PageTextAreaOptions(String expression,
                           boolean matchCase,
                           boolean uniteSegments,
                           boolean ignoreFormatting,
                           Rectangle rectangle,
                           double rectangleTolerance)

Initializes a new instance of the PageTextAreaOptions class with the size of the ignored border.

Parameters:

expression - The regular expression.

matchCase - The value that indicates whether a text case isn't ignored.

uniteSegments - The value that indicates whether segments are united.

ignoreFormatting - The value that indicates whether text formatting is ignored.

rectangle - The rectangular area that contains page areas.

rectangleTolerance - The size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height.

Method Detail

getExpression

public String getExpression()

Gets the regular expression.

Returns:

A string that represents the regular expression.

isMatchCase

public boolean isMatchCase()

Gets the value that indicates whether a text case isn't ignored.

Returns:

true if a text case isn't ignored; otherwise, false.

isUniteSegments

public boolean isUniteSegments()

Gets the value that indicates whether segments are united.

Returns:

{code true} if segments are united; otherwise, {code false}.

isIgnoreFormatting

public boolean isIgnoreFormatting()

Gets the value that indicates whether text formatting is ignored.

Returns:

true if text formatting is ignored; otherwise, false.

isUseOcr

public boolean isUseOcr()

Gets the value that indicates whether the OCR Connector is used to extract a text.

Returns:

true if the OCR functionality is used; otherwise, false.

getOcrOptions

public OcrOptions getOcrOptions()

Gets the additional options for OCR functionality.

Returns:

An instance of OcrOptions class with the additional OCR options.