hr.ngs.templater

Interface ITemplater

public interface ITemplater

Provides access to low level API.

Method Summary

Methods

Modifier and Type	Method and Description
ITemplater[]	clone(int count) Clones a document.
java.lang.String[]	getMetadata(java.lang.String tag, boolean all) Metadata for each specific tag.
boolean	replace(java.lang.String tag, java.lang.Object value) Replace first specified tag with provided value.
boolean	resize(java.lang.String[] tags, int count) Resize context which contains all specified tags.
java.lang.String[]	tags() Recognized tags in the document.

Method Detail

tags

java.lang.String[] tags()

Recognized tags in the document. Each tag is enumerated once.

getMetadata

java.lang.String[] getMetadata(java.lang.String tag,
                             boolean all)

Metadata for each specific tag. Metadata is used for value conversions and formatting.

Parameters:

tag - Tag for which metadata is required

all - True returns metadata for all matching tags, false returns metadata for just the first one

Returns:

String array of tag metadata. If tag is not found empty array will be returned

replace

boolean replace(java.lang.String tag,
              java.lang.Object value)

Replace first specified tag with provided value. Some document formats and value converters support complex values (Date, Image, ...)

Parameters:

tag - Tag to be replaced

value - Replacement value (which can be formatted)

Returns:

Successful replacement

resize

boolean resize(java.lang.String[] tags,
             int count)

Resize context which contains all specified tags. Context can be row in a table, paragraph in a document or named group in a spreadsheet.

Parameters:

tags - Tags which specifies the context

count - Number of contexts after the resize operation; if the count value is zero, the specified context will be removed.

Returns:

Context found and resized

clone

ITemplater[] clone(int count)

Clones a document.

Parameters:

count - Number of clones to create

Returns:

An ITemplater array with cloned tags, text and other document properties