com.groupdocs.parser.data

Class PageTextArea

java.lang.Object

com.groupdocs.parser.data.PageArea

com.groupdocs.parser.data.PageTextArea

public class PageTextArea
extends PageArea

Represents a page text area which is used to represent a text value in the parsing by template or parsing form functionality.

An instance of PageTextArea class is used as return value of the following methods:

• Parser.getTextAreas()
• Parser.getTextAreas(PageTextAreaOptions)
• Parser.getTextAreas(int)
• Parser.getTextAreas(int, PageTextAreaOptions)

Also an instance of PageTextArea class is used as value of PageArea property.

*

See the usage examples there.

The text area can be single or composite. In the first case it contains a text which is bounded by a rectangular area. In the second case it contains other text areas; text and table properties are calculated by child text areas.

Constructor Summary

Constructors

Constructor and Description
PageTextArea(Iterable<PageTextArea> areas, Page page) Initializes a new instance of the PageTextArea class.
PageTextArea(String text, Double baseLine, TextStyle textStyle, Page page, Rectangle rectangle) Initializes a new instance of the PageTextArea class.
PageTextArea(String text, Page page, Rectangle rectangle) Initializes a new instance of the PageTextArea class.

Method Summary

Modifier and Type	Method and Description
List<PageTextArea>	getAreas() Gets the collection of child text page areas.
double	getBaseLine() Gets the base line.
String	getText() Gets the text.
TextStyle	getTextStyle() Gets the text style such as font size, font name an so on.

Methods inherited from class com.groupdocs.parser.data.PageArea

getPage, getRectangle, setRectangle

Methods inherited from class java.lang.Object

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

Constructor Detail

PageTextArea

public PageTextArea(String text,
                    Page page,
                    Rectangle rectangle)

Initializes a new instance of the PageTextArea class.

Parameters:

text - The value of the text.

page - The page that contains the text area.

rectangle - The rectangular area that contains the text area.

PageTextArea

public PageTextArea(String text,
                    Double baseLine,
                    TextStyle textStyle,
                    Page page,
                    Rectangle rectangle)

Initializes a new instance of the PageTextArea class.

Parameters:

text - The value of the text.

baseLine - The base line of the text.

textStyle - The style of the text.

page - The page that contains the text area.

rectangle - The rectangular area that contains the text area.

PageTextArea

public PageTextArea(Iterable<PageTextArea> areas,
                    Page page)

Initializes a new instance of the PageTextArea class.

Parameters:

areas - The collecton of child text page areas.

page - The page that contains the text area.

Method Detail

getText

public String getText()

Gets the text.

Returns:

A string value that represents a value of the text page area.

getBaseLine

public double getBaseLine()

Gets the base line.

Returns:

A double value that represents the base line.

getTextStyle

public TextStyle getTextStyle()

Gets the text style such as font size, font name an so on.

Returns:

An instance of TextStyle class that represents the text style.

getAreas

public List<PageTextArea> getAreas()

Gets the collection of child text page areas.

Returns:

A collection of child text page areas; empty if the text page area hasn't children.