Index

A B C D E F G H I L M N O P R S T V W X

A

actualType - Variable in class hr.ngs.templater.EditorConfigurationBuilder.TagMetadata: When type is not really known or specific type should be used instead, actual type can be specified to be used instead of the one Templater detected.
actualType(Class<?>) - Method in class hr.ngs.templater.EditorConfigurationBuilder.TagMetadata.Builder: Prepare the actual type override.
addAlias(String, String) - Method in interface hr.ngs.templater.EditorConfigurationBuilder: To simplify tag management long tags can be shortened via aliases.

B

blacklist(Member) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: To disable navigation over certain members blacklisting can be used.
build() - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Build a document factory instance.
build(String) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Build a document factory instance using the provided custom license file.
build(String, String) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Build a document factory instance using the provided license information.
build() - Method in class hr.ngs.templater.EditorConfigurationBuilder.TagMetadata.Builder: Build the tag metadata from specified values.
build() - Method in class hr.ngs.templater.ImageInfo.Builder: Create an ImageInfo object from the builder.
builder() - Static method in class hr.ngs.templater.Configuration: To specify custom plugins, initialize document factory with a builder.
builder() - Static method in class hr.ngs.templater.EditorConfigurationBuilder.TagMetadata: Helper builder for constructing tag metadata
Builder() - Constructor for class hr.ngs.templater.EditorConfigurationBuilder.TagMetadata.Builder
builtInFormatters(boolean) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Templater has a lot of builtin formatters (such as format, substring, ...) While they can be overridden, if there is no use for them, they can be excluded from usage
builtInHandlers(boolean) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Templater has few builtin handlers (such as collapse).
builtInLowLevelPlugins(boolean) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Templater has few builtin low level plugins (such as buffered image and image stream on Java) If those classes are not available (as in case of Android) plugins should be disabled.
builtInNavigation(boolean) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Templater has few builtin navigation (such as at(index), ...) If there is no use for them, they can be excluded from usage

C

category(String) - Method in class hr.ngs.templater.EditorConfigurationBuilder.TagMetadata.Builder: Group tags under specific category
category - Variable in class hr.ngs.templater.EditorConfigurationBuilder.TagMetadata: Category which can be used for grouping tags.
clone(int) - Method in interface hr.ngs.templater.Templater: Clones a document.
close() - Method in interface hr.ngs.templater.TemplateDocument: Finish processing and populate output document.
combine(Element, Element[]) - Method in interface hr.ngs.templater.DocumentFactoryBuilder.XmlCombine: Input elements are passed from Templater resize for inspection.
Configuration - Class in hr.ngs.templater: Public entry point.
configure(String) - Static method in class hr.ngs.templater.Configuration: Create an instance of a document factory using the provided custom license file.
configure(String, String) - Static method in class hr.ngs.templater.Configuration: Create an instance of a document factory using the provided license information.
configure() - Method in interface hr.ngs.templater.DocumentFactoryBuilder.SpreadsheetConfigurationBuilder: Finish configuring the Spreadsheet configuration setup.
configure(boolean) - Method in interface hr.ngs.templater.EditorConfigurationBuilder: Finish configuring the Microsoft Office Templater Editor setup.
configureEditor() - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Configure document settings which are used in Templater Editor Add-In for Microsoft Office.
configureSpreadsheet() - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Fine tune specific behavior of spreadsheet processing
content - Variable in class hr.ngs.templater.ImageInfo: Image content as stored on disk
convert(Document) - Method in interface hr.ngs.templater.DocumentFactoryBuilder.SvgConverter: Convert SVG XML into Templater image format.

D

debugLog(boolean) - Method in interface hr.ngs.templater.EditorConfigurationBuilder: Capturing debug log will allow inspection of every Templater processing step.
description(String) - Method in class hr.ngs.templater.EditorConfigurationBuilder.TagMetadata.Builder: Prepare the tag description.
description - Variable in class hr.ngs.templater.EditorConfigurationBuilder.TagMetadata: Description of the tag explaining its purpose.
DocumentFactory - Interface in hr.ngs.templater: Creates template document interface
DocumentFactory.CancellationToken - Interface in hr.ngs.templater: Cancel Templater processing.
DocumentFactoryBuilder - Interface in hr.ngs.templater: Templater document factory builder.
DocumentFactoryBuilder.Formatter - Interface in hr.ngs.templater: Plugin signature for formatting values.
DocumentFactoryBuilder.Handler - Interface in hr.ngs.templater: Plugin signature for invoking low-level API.
DocumentFactoryBuilder.LowLevelReplacer - Interface in hr.ngs.templater: Register a new Low Level replacer plugin.
DocumentFactoryBuilder.Navigate - Interface in hr.ngs.templater: Plugin signature for navigation over tag.
DocumentFactoryBuilder.NavigationEnd - Interface in hr.ngs.templater: Specify ending for navigation plugin.
DocumentFactoryBuilder.Processor<T> - Interface in hr.ngs.templater: Plugin signature for a data type handler.
DocumentFactoryBuilder.SpreadsheetConfigurationBuilder - Interface in hr.ngs.templater: This builder allows for customizing various Spreadsheet specific behaviors, such as formulas and limits.
DocumentFactoryBuilder.SvgConverter - Interface in hr.ngs.templater: Conversion function.
DocumentFactoryBuilder.TagPattern - Enum in hr.ngs.templater: Supported tag patterns
DocumentFactoryBuilder.UnprocessedTagsHandler - Interface in hr.ngs.templater: Register a new unprocessed tags plugin.
DocumentFactoryBuilder.XmlCombine - Interface in hr.ngs.templater: Conversion function.

E

EditorConfigurationBuilder - Interface in hr.ngs.templater: Templater Editor integration is available for Reporting and Enterprise license.
EditorConfigurationBuilder.MetadataProvider - Interface in hr.ngs.templater: Callback for metadata type.
EditorConfigurationBuilder.TagMetadata - Class in hr.ngs.templater: Additional metadata available in Templater Editor.
EditorConfigurationBuilder.TagMetadata.Builder - Class in hr.ngs.templater: Builder helper for metadata construction
EditorConfigurationBuilder.TagStatus - Enum in hr.ngs.templater: Status of the tag used in the Templater Editor.
endsAt(String) - Method in interface hr.ngs.templater.DocumentFactoryBuilder.NavigationEnd: If invalid value is returned (negative or larger than string length) whole input will be used for navigation.
example(String) - Method in class hr.ngs.templater.EditorConfigurationBuilder.TagMetadata.Builder: Prepare the tag value example
example - Variable in class hr.ngs.templater.EditorConfigurationBuilder.TagMetadata: Value example used for this tag.
extension(String) - Method in class hr.ngs.templater.ImageInfo.Builder: Specifying image extension, eg: png, jpg,...
extension - Variable in class hr.ngs.templater.ImageInfo: Extension to use (eg: png, gif, jpg,...)

F

factory() - Static method in class hr.ngs.templater.Configuration: Create an instance of a document factory.
format(Object, String) - Method in interface hr.ngs.templater.DocumentFactoryBuilder.Formatter: If a plugin is applicable (based on the provided metadata) return converted object value otherwise just return provided value.
formulaWarnings(boolean) - Method in interface hr.ngs.templater.DocumentFactoryBuilder.SpreadsheetConfigurationBuilder: In some cases Excel will warn about inconsistent formulas.
forThread(Thread) - Static method in interface hr.ngs.templater.DocumentFactory.CancellationToken: Create cancellation token from the status of Thread.isInterrupted()
from(byte[]) - Static method in class hr.ngs.templater.ImageInfo: ImageInfo builder from byte array
from(InputStream) - Static method in class hr.ngs.templater.ImageInfo: ImageInfo builder from a stream.

G

getMetadata(String, boolean) - Method in interface hr.ngs.templater.Templater: User-defined metadata for tags.
getMetadata(String, int) - Method in interface hr.ngs.templater.Templater: Since there can be multiple tags with same path, metadata for each specific tag in sequence can be obtained by passing in its index.

H

handle(Object, String, String, int, Templater) - Method in interface hr.ngs.templater.DocumentFactoryBuilder.Handler: Plugin should check if its applicable (based on the provided metadata and value).
Handled - Enum in hr.ngs.templater: Specifying behavior of Templater after the handler.
height(int) - Method in class hr.ngs.templater.ImageInfo.Builder: Specifying image height.
height - Variable in class hr.ngs.templater.ImageInfo: Height of the image, eg: 400
horizontalResolution - Variable in class hr.ngs.templater.ImageInfo: Horizontal DPI of the image, eg: 96
hr.ngs.templater - package hr.ngs.templater

I

ImageInfo - Class in hr.ngs.templater: Special image type.
ImageInfo(byte[], String, int, int, float) - Constructor for class hr.ngs.templater.ImageInfo: Basic ImageInfo constructor with same horizontal and vertical DPI
ImageInfo(byte[], String, int, float, int, float) - Constructor for class hr.ngs.templater.ImageInfo: Full ImageInfo constructor where horizontal and vertical DPI can be different
ImageInfo.Builder - Class in hr.ngs.templater: ImageInfo builder for easier initialization.
include(DocumentFactoryBuilder.Navigate) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Register a new navigation plugin.
include(DocumentFactoryBuilder.Formatter) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Register a new formatter plugin.
include(DocumentFactoryBuilder.Handler) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Register a new metadata handler plugin.
include(Class<T>, DocumentFactoryBuilder.Processor<T>) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Register a new processor plugin.
include(DocumentFactoryBuilder.LowLevelReplacer) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: When input values must be replaced before and there is not appropriate metadata.
isCanceled() - Method in interface hr.ngs.templater.DocumentFactory.CancellationToken: Templater will check state of this method in various places and abort further processing when true is returned
issuesListing(boolean) - Method in interface hr.ngs.templater.EditorConfigurationBuilder: When tag detection and analysis is enabled, Templater Editor will search for various issues in the document.

L

lookup(Object) - Method in interface hr.ngs.templater.EditorConfigurationBuilder.MetadataProvider: Custom provided metadata.

M

metadataResolver(EditorConfigurationBuilder.MetadataProvider) - Method in interface hr.ngs.templater.EditorConfigurationBuilder: To make tags more useful and friendly, additional metadata can be attached to schema.

N

navigate(Object, Object, String, String) - Method in interface hr.ngs.templater.DocumentFactoryBuilder.Navigate: Plugin works by accepting parent object, current evaluated object, member used for navigation and detected metadata.
navigateSeparator(char) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Deprecated.
navigateSeparator(char, DocumentFactoryBuilder.NavigationEnd) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Change navigation separator.
navigateUsing(char) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Change navigation character.
newSheetsLimit(int) - Method in interface hr.ngs.templater.DocumentFactoryBuilder.SpreadsheetConfigurationBuilder: To prevent too large spreadsheets, specify maximum number of new sheets which can be added.
NONE - Static variable in interface hr.ngs.templater.DocumentFactory.CancellationToken: Cancellation token which will never cancel processing
numberAsTextWarnings(boolean) - Method in interface hr.ngs.templater.DocumentFactoryBuilder.SpreadsheetConfigurationBuilder: When text can be interpreted as numbers Excel will warn about number being displayed as text.

O

onUnprocessed(DocumentFactoryBuilder.UnprocessedTagsHandler) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Specify custom behavior for tags which were left after processing.
onUnprocessed(String, Templater, String[], Object) - Method in interface hr.ngs.templater.DocumentFactoryBuilder.UnprocessedTagsHandler: Customize behavior for unprocessed tags - tags which did not match input data.
open(String) - Method in interface hr.ngs.templater.DocumentFactory: Templater will recognize the appropriate document format from the file extension.
open(InputStream, String, OutputStream, DocumentFactory.CancellationToken) - Method in interface hr.ngs.templater.DocumentFactory: Opens a document from the specified stream.
open(InputStream, String, OutputStream) - Method in interface hr.ngs.templater.DocumentFactory: Opens a document from the specified stream.

P

position - Variable in class hr.ngs.templater.Templater.TagPosition: Position of the tag in the document.
process(T) - Method in interface hr.ngs.templater.TemplateDocument: Modifies document according to rules for specified data type.

R

replace(Object, String, String[]) - Method in interface hr.ngs.templater.DocumentFactoryBuilder.LowLevelReplacer: A custom plugin can be registered behind the Templater replace API It will be invoked for every replace invocation.
replace(String, Object) - Method in interface hr.ngs.templater.Templater: Replace first specified tag with provided value.
replace(String, int, Object) - Method in interface hr.ngs.templater.Templater: Replace tag at the position in the sequence of same tag paths with provided value.
resize(String[], int) - Method in interface hr.ngs.templater.Templater: Resize context which contains all specified tags.
resize(Templater.TagPosition[], int) - Method in interface hr.ngs.templater.Templater: Resize context which contains all specified tags.
resizeLimit(int) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Maximum number of times same tag can be resized.
resolution(float) - Method in class hr.ngs.templater.ImageInfo.Builder: Image resolution (DPI).

S

sign(X509Certificate, PrivateKey) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Sign office document at the end of processing.
status(EditorConfigurationBuilder.TagStatus) - Method in class hr.ngs.templater.EditorConfigurationBuilder.TagMetadata.Builder: Prepare the tag status.
status - Variable in class hr.ngs.templater.EditorConfigurationBuilder.TagMetadata: Status of the tag.
streaming(int) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Configure the streaming size.
svgConverter(DocumentFactoryBuilder.SvgConverter) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: When adding SVG into documents, use additional converter for fallback image.

T

tag - Variable in class hr.ngs.templater.Templater.TagPosition: Tag value to match.
tagDetection(boolean) - Method in interface hr.ngs.templater.EditorConfigurationBuilder: Continuously run tag detection on any change in the document.
tagListing(boolean) - Method in interface hr.ngs.templater.EditorConfigurationBuilder: Show tag listing when opening up document.
tagManagement(boolean) - Method in interface hr.ngs.templater.EditorConfigurationBuilder: Is the user allowed to specify their own tags.
TagMetadata(EditorConfigurationBuilder.TagStatus, Class<?>, String, String, String) - Constructor for class hr.ngs.templater.EditorConfigurationBuilder.TagMetadata: Create tag metadata description.
TagPosition(String, int) - Constructor for class hr.ngs.templater.Templater.TagPosition: Prepare structure by defining tag and position arguments
tags() - Method in interface hr.ngs.templater.Templater: Recognized tags in the document.
TemplateDocument - Interface in hr.ngs.templater: Template document with analyzed tags.
templater() - Method in interface hr.ngs.templater.TemplateDocument: Provides access to the low-level API.
Templater - Interface in hr.ngs.templater: Provides access to low level API.
Templater.TagPosition - Class in hr.ngs.templater: Exact tag position for the resize method.
throwIfCancellationRequested() - Method in interface hr.ngs.templater.DocumentFactory.CancellationToken: Throw cancellation exception if token has been canceled
tryProcess(String, Templater, T) - Method in interface hr.ngs.templater.DocumentFactoryBuilder.Processor: A custom processor can be registered for specialized data types.
typeVisibility(boolean) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: During type analysis, analyze all vs only public signatures.

V

valueOf(String) - Static method in enum hr.ngs.templater.DocumentFactoryBuilder.TagPattern: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum hr.ngs.templater.EditorConfigurationBuilder.TagStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum hr.ngs.templater.Handled: Returns the enum constant of this type with the specified name.
values() - Static method in enum hr.ngs.templater.DocumentFactoryBuilder.TagPattern: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum hr.ngs.templater.EditorConfigurationBuilder.TagStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum hr.ngs.templater.Handled: Returns an array containing the constants of this enum type, in the order they are declared.
verticalResolution - Variable in class hr.ngs.templater.ImageInfo: Vertical DPI of the image, eg: 96

W

width(int) - Method in class hr.ngs.templater.ImageInfo.Builder: Specifying image width.
width - Variable in class hr.ngs.templater.ImageInfo: Width of the image, eg: 600
withJavaBeans(boolean) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: During class analysis, bean convention can be used.
withMatcher(String) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Customize tag matcher for all patterns.
withMatcher(String, DocumentFactoryBuilder.TagPattern) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Customize tag matcher for a specific pattern.

X

xmlBuilder(DocumentBuilderFactory, boolean) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Change default XML parser.
xmlCombine(String, DocumentFactoryBuilder.XmlCombine) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: To fine tune behavior of xml injection into the document allow for inspection of provided and existing XML and passing in a final XML.
xmlReader(XMLInputFactory, boolean) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Change default XML reader.
xmlTransformer(TransformerFactory, boolean) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Change default XML transformer.
xmlWriter(XMLOutputFactory, boolean) - Method in interface hr.ngs.templater.DocumentFactoryBuilder: Change default XML writer.

A B C D E F G H I L M N O P R S T V W X