com.groupdocs.parser.templates

Class TemplateItem

java.lang.Object

com.groupdocs.parser.templates.TemplateItem

Direct Known Subclasses:

TemplateBarcode, TemplateField, TemplateTable

public abstract class TemplateItem
extends Object

Provides a base abstract class for template items.

The inheritors of TemplateItem class are used in Template collection.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TemplateItem(String name, Integer pageIndex, boolean useUpperCaseName) Initializes a new instance of the TemplateField class.
protected	TemplateItem(String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName) Initializes a new instance of the TemplateField class.

Method Summary

Modifier and Type	Method and Description
String	getName() Gets the name of the template item.
Integer	getPageIndex() Gets the page index of the template item.
Double	getPageWidth() Gets the width of the page that was used to create the template item.
boolean	getUseUpperCaseName() Gets a value that indicates whether a Name was converted to UPPER CASE.
abstract TemplateItem	scale(double factor) Creates a copy of the current item with all coordinates scaled by the given factor.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateItem

protected TemplateItem(String name,
                       Integer pageIndex,
                       boolean useUpperCaseName)

Initializes a new instance of the TemplateField class.

Parameters:

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.

TemplateItem

protected TemplateItem(String name,
                       Integer pageIndex,
                       Double pageWidth,
                       boolean useUpperCaseName)

Initializes a new instance of the TemplateField class.

Parameters:

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

scale

public abstract TemplateItem scale(double factor)

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

Parameters:

factor - The scaling factor.

Returns:

A new TemplateItem with scaled coordinates.

getName

public String getName()

Gets the name of the template item.

Returns:

An uppercase string value that represents a name of the template item.

getPageIndex

public Integer getPageIndex()

Gets the page index of the template item.

Returns:

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.

getPageWidth

public Double getPageWidth()

Gets the width of the page that was used to create the template item.

Returns:

The width of the page in pixels; null if the page width is unknown.

getUseUpperCaseName

public boolean getUseUpperCaseName()

Gets a value that indicates whether a Name was converted to UPPER CASE.

Returns:

A boolean value that indicates whether a Name was converted to UPPER CASE.