com.groupdocs.parser.templates

Class Template

java.lang.Object

com.groupdocs.parser.templates.Template

All Implemented Interfaces:

Iterable<TemplateItem>

public class Template
extends Object
implements Iterable<TemplateItem>

Provides the document page template. It consists of TemplateItem objects which represent the items of the template such as text field and table definitions.

Learn more:

• Working with templates

Constructor Summary

Constructors

Constructor and Description
Template(Iterable<? extends TemplateItem> items) Initializes a new instance of the Template class.
Template(Iterable<? extends TemplateItem> items, TemplateOptions options) Initializes a new instance of the Template class.

Method Summary

Modifier and Type	Method and Description
TemplateItem	get(int index) Gets the template item by an index.
int	getCount() Gets the total number of template items.
TemplateOptions	getOptions() Gets the template options.
Iterator<TemplateItem>	iterator()
static Template	load(InputStream stream) Loads a template from a stream.
static Template	load(String filePath) Loads a template from a file.
void	save(OutputStream stream) Saves a template to a stream.
void	save(String filePath) Saves a template to a file.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Template

public Template(Iterable<? extends TemplateItem> items)

Initializes a new instance of the Template class.

Usage:

 // Create an array of template fields
 TemplateItem[] fields = new TemplateItem[]
 {
     new TemplateField(new TemplateRegexPosition("From"), "From", 0),
     new TemplateField(
         new TemplateLinkedPosition("From", new Size(100, 10), new TemplateLinkedPositionEdges(false, false, false, true)),
         "FromCompany",
         0),
     new TemplateField(
         new TemplateLinkedPosition("FromCompany", new Size(100, 30), new TemplateLinkedPositionEdges(false, false, false, true)),
         "FromAddress",
         0)
 };
 // Create a document template
 Template template = new Template(java.util.Arrays.asList(fields));
 

Parameters:

items - The collection of TemplateItem objects.

Template

public Template(Iterable<? extends TemplateItem> items,
                TemplateOptions options)

Initializes a new instance of the Template class.

Parameters:

items - The collection of TemplateItem objects.

options - The template options.

Method Detail

getCount

public int getCount()

Gets the total number of template items.

Returns:

An integer that represents the total number of template items.

get

public TemplateItem get(int index)

Gets the template item by an index.

Parameters:

index - The zero-based index of the template item.

Returns:

An instance of TemplateItem class.

getOptions

public TemplateOptions getOptions()

Gets the template options.

Returns:

An instance of TemplateOptions class.

iterator

public Iterator<TemplateItem> iterator()

Specified by:

iterator in interface Iterable<TemplateItem>

load

public static Template load(String filePath)
                     throws IOException

Loads a template from a file.

Parameters:

filePath - The path to the file.

Returns:

An instance of Template class with loaded template.

Throws:

IOException - File is not found

GroupDocsParserException - The file does not represent the template in a valid format.

load

public static Template load(InputStream stream)

Loads a template from a stream.

Parameters:

stream - The input stream.

Returns:

An instance of Template class with loaded template.

Throws:

GroupDocsParserException - The file does not represent the template in a valid format.

save

public void save(String filePath)
          throws IOException

Saves a template to a file.

Parameters:

filePath - The path to the file.

Throws:

IOException - File is not found

save

public void save(OutputStream stream)

Saves a template to a stream.

Parameters:

stream - The output stream.