com.groupdocs.parser.options

Class PageAreaOptions

java.lang.Object

com.groupdocs.parser.options.PageAreaOptions

Direct Known Subclasses:

PageTableAreaOptions, PageTextAreaOptions

public class PageAreaOptions
extends Object

Provides the options which are used for page areas extraction.

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

Constructor Summary

Constructors

Constructor and Description
PageAreaOptions(Rectangle rectangle) Initializes a new instance of the PageAreaOptions class with the size of the ignored border.
PageAreaOptions(Rectangle rectangle, double rectangleTolerance) Initializes a new instance of the PageAreaOptions class.

Method Summary

Modifier and Type	Method and Description
Rectangle	getRectangle() Gets the rectangular area that contains page areas.
double	getRectangleTolerance() Gets the size of the border that is ignored when captured by the rectangular area.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageAreaOptions

public PageAreaOptions(Rectangle rectangle)

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

Parameters:

rectangle - The rectangular area that contains page areas.

PageAreaOptions

public PageAreaOptions(Rectangle rectangle,
                       double rectangleTolerance)

Initializes a new instance of the PageAreaOptions class.

Parameters:

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

getRectangle

public Rectangle getRectangle()

Gets the rectangular area that contains page areas.

Returns:

An instance of Rectangle class that represents the rectangular area that contains page areas; null if it isn't set.

getRectangleTolerance

public double getRectangleTolerance()

Gets 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.

Returns:

The double value from 0 (no border) to 1 (ignore the whole element).