PageTextArea

Inheritance: java.lang.Object, com.groupdocs.parser.data.PageArea

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:

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.

Constructors

Constructor Description
PageTextArea(String text, Page page, Rectangle rectangle) 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(Iterable areas, Page page) Initializes a new instance of the PageTextArea class.

Methods

Method Description
getText() Gets the text.
getBaseLine() Gets the base line.
getTextStyle() Gets the text style such as font size, font name an so on.
getAreas() Gets the collection of child text page areas.

PageTextArea(String text, Page page, Rectangle rectangle)

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

Initializes a new instance of the PageTextArea class.

Parameters:

Parameter Type Description
text java.lang.String The value of the text.
page Page The page that contains the text area.
rectangle Rectangle The rectangular area that contains the text area.

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

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

Initializes a new instance of the PageTextArea class.

Parameters:

Parameter Type Description
text java.lang.String The value of the text.
baseLine java.lang.Double The base line of the text.
textStyle TextStyle The style of the text.
page Page The page that contains the text area.
rectangle Rectangle The rectangular area that contains the text area.

PageTextArea(Iterable areas, Page page)

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

Initializes a new instance of the PageTextArea class.

Parameters:

Parameter Type Description
areas java.lang.Iterable<com.groupdocs.parser.data.PageTextArea> The collecton of child text page areas.
page Page The page that contains the text area.

getText()

public String getText()

Gets the text.

Returns: java.lang.String - A string value that represents a value of the text page area.

getBaseLine()

public double getBaseLine()

Gets the base line.

Returns: double - 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: TextStyle - An instance of TextStyle class that represents the text style.

getAreas()

public List<PageTextArea> getAreas()

Gets the collection of child text page areas.

Returns: java.util.List<com.groupdocs.parser.data.PageTextArea> - A collection of child text page areas; empty if the text page area hasn’t children.