com.groupdocs.parser.templates

Class TemplateField

java.lang.Object

com.groupdocs.parser.templates.TemplateItem

com.groupdocs.parser.templates.TemplateField

public class TemplateField
extends TemplateItem

Provides the template text field.

Text fields are defined by its position on the page. There are three ways to define a text field:

• Using the rectangular area: TemplateFixedPosition
• Using the regular expression: TemplateRegexPosition
• Using the linked field: TemplateLinkedPosition

Constructor Summary

Constructors

Constructor and Description
TemplateField(TemplatePosition position, String name) Initializes a new instance of the TemplateField class.
TemplateField(TemplatePosition position, String name, Integer pageIndex) Initializes a new instance of the TemplateField class with the UPPER CASE name.
TemplateField(TemplatePosition position, String name, Integer pageIndex, boolean useUpperCaseName) Initializes a new instance of the TemplateField class.
TemplateField(TemplatePosition position, String name, Integer pageIndex, Double pageWidth) Initializes a new instance of the TemplateField class with the UPPER CASE name.
TemplateField(TemplatePosition position, String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName) Initializes a new instance of the TemplateField class.

Method Summary

Modifier and Type	Method and Description
TemplatePosition	getPosition() Gets the value that describes how to find the template field on the document page.
TemplateItem	scale(double factor) Creates a copy of the current item with all coordinates scaled by the given factor.

Methods inherited from class com.groupdocs.parser.templates.TemplateItem

getName, getPageIndex, getPageWidth, getUseUpperCaseName

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateField

public TemplateField(TemplatePosition position,
                     String name)

Initializes a new instance of the TemplateField class.

Parameters:

position - The field position.

name - The field name.

TemplateField

public TemplateField(TemplatePosition position,
                     String name,
                     Integer pageIndex)

Initializes a new instance of the TemplateField class with the UPPER CASE name.

Parameters:

position - The field position.

name - The field name.

pageIndex - An integer value that represents the index of the page where the template item is located; null if the template item is located on any page.

TemplateField

public TemplateField(TemplatePosition position,
                     String name,
                     Integer pageIndex,
                     Double pageWidth)

Initializes a new instance of the TemplateField class with the UPPER CASE name.

Parameters:

position - The field position.

name - The field name.

pageIndex - An integer value that represents the index of the page where the template item is located; null if the template item is located on any page.

pageWidth - The width of the page that was used to create the template item.

TemplateField

public TemplateField(TemplatePosition position,
                     String name,
                     Integer pageIndex,
                     boolean useUpperCaseName)

Initializes a new instance of the TemplateField class.

Parameters:

position - The field position.

name - The field name.

pageIndex - An integer value that represents the index of the page where the template item is located; null if the template item is located on any page.

useUpperCaseName - The value that indicates whether a name is converted to UPPER CASE.

TemplateField

public TemplateField(TemplatePosition position,
                     String name,
                     Integer pageIndex,
                     Double pageWidth,
                     boolean useUpperCaseName)

Initializes a new instance of the TemplateField class.

Parameters:

position - The field position.

name - The field name.

pageIndex - An integer value that represents the index of the page where the template item is located; null if the template item is located on any page.

pageWidth - The width of the page that was used to create the template item.

useUpperCaseName - The value that indicates whether a name is converted to UPPER CASE.

Method Detail

getPosition

public TemplatePosition getPosition()

Gets the value that describes how to find the template field on the document page.

Returns:

An instance of TemplatePosition descendant class.

scale

public TemplateItem scale(double factor)

Description copied from class: TemplateItem

Creates a copy of the current item with all coordinates scaled by the given factor.

Specified by:

scale in class TemplateItem

Parameters:

factor - The scaling factor.

Returns:

A new TemplateItem with scaled coordinates.