TemplateItem

Inheritance: java.lang.Object

public abstract class TemplateItem

Provides a base abstract class for template items.

The inheritors of TemplateItem class are used in Template collection.

Methods

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

scale(double factor)

public abstract TemplateItem scale(double factor)

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

Parameters:

Parameter	Type	Description
factor	double	The scaling factor.

Returns: TemplateItem - A new TemplateItem with scaled coordinates.

getName()

public String getName()

Gets the name of the template item.

Returns: java.lang.String - 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: java.lang.Integer - 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: java.lang.Double - 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: boolean - A boolean value that indicates whether a Name was converted to UPPER CASE.