PageAreaOptions

Inheritance: java.lang.Object

public class PageAreaOptions

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.

Constructors

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

Methods

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

PageAreaOptions(Rectangle rectangle)

public PageAreaOptions(Rectangle rectangle)

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

Parameters:

Parameter Type Description
rectangle Rectangle The rectangular area that contains page areas.

PageAreaOptions(Rectangle rectangle, double rectangleTolerance)

public PageAreaOptions(Rectangle rectangle, double rectangleTolerance)

Initializes a new instance of the PageAreaOptions class.

Parameters:

Parameter Type Description
rectangle Rectangle The rectangular area that contains page areas.
rectangleTolerance double 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.

getRectangle()

public Rectangle getRectangle()

Gets the rectangular area that contains page areas.

Returns: Rectangle - 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: double - The double value from 0 (no border) to 1 (ignore the whole element).