Skip navigation links
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.IEditorConfigurationBuilder.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.IEditorConfigurationBuilder.TagMetadata.Builder
Prepare the actual type override.
addAlias(String, String) - Method in interface hr.ngs.templater.IEditorConfigurationBuilder
To simplify tag management long tags can be shortened via aliases.

B

blacklist(Member) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
To disable navigation over certain members blacklisting can be used.
build() - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Build a document factory instance.
build(String) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Build a document factory instance using the provided custom license file.
build(String, String) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Build a document factory instance using the provided license information.
build() - Method in class hr.ngs.templater.IEditorConfigurationBuilder.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.IEditorConfigurationBuilder.TagMetadata
Helper builder for constructing tag metadata
Builder() - Constructor for class hr.ngs.templater.IEditorConfigurationBuilder.TagMetadata.Builder
 
builtInFormatters(boolean) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
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.IDocumentFactoryBuilder
Templater has few builtin handlers (such as collapse).
builtInLowLevelPlugins(boolean) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
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.IDocumentFactoryBuilder
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.IEditorConfigurationBuilder.TagMetadata.Builder
Group tags under specific category
category - Variable in class hr.ngs.templater.IEditorConfigurationBuilder.TagMetadata
Category which can be used for grouping tags.
clone(int) - Method in interface hr.ngs.templater.ITemplater
Clones a document.
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(boolean) - Method in interface hr.ngs.templater.IEditorConfigurationBuilder
Finish configuring the Microsoft Office Templater Editor setup.
configureEditor() - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Configure document settings which are used in Templater Editor Add-In for Microsoft Office.
content - Variable in class hr.ngs.templater.ImageInfo
Image content as stored on disk
convert(Document) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder.SvgConverter
Convert SVG XML into Templater image format.

D

debugLog(boolean) - Method in interface hr.ngs.templater.IEditorConfigurationBuilder
Capturing debug log will allow inspection of every Templater processing step.
description(String) - Method in class hr.ngs.templater.IEditorConfigurationBuilder.TagMetadata.Builder
Prepare the tag description.
description - Variable in class hr.ngs.templater.IEditorConfigurationBuilder.TagMetadata
Description of the tag explaining its purpose.

E

example(String) - Method in class hr.ngs.templater.IEditorConfigurationBuilder.TagMetadata.Builder
Prepare the tag value example
example - Variable in class hr.ngs.templater.IEditorConfigurationBuilder.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.
flush() - Method in interface hr.ngs.templater.ITemplateDocument
Flushes current changes to output stream and finishes processing.
format(Object, String) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder.IFormatter
If a plugin is applicable (based on the provided metadata) return converted object value otherwise just return provided value.
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.ITemplater
User-defined metadata for tags.
getMetadata(String, int) - Method in interface hr.ngs.templater.ITemplater
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, ITemplater) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder.IHandler
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

IDocumentFactory - Interface in hr.ngs.templater
Creates template document interface
IDocumentFactoryBuilder - Interface in hr.ngs.templater
Templater document factory builder.
IDocumentFactoryBuilder.IFormatter - Interface in hr.ngs.templater
Plugin signature for formatting values.
IDocumentFactoryBuilder.IHandler - Interface in hr.ngs.templater
Plugin signature for invoking low-level API.
IDocumentFactoryBuilder.ILowLevelReplacer - Interface in hr.ngs.templater
Register a new Low Level replacer plugin.
IDocumentFactoryBuilder.INavigate - Interface in hr.ngs.templater
Plugin signature for navigation over tag.
IDocumentFactoryBuilder.IProcessor<T> - Interface in hr.ngs.templater
Plugin signature for a data type handler.
IDocumentFactoryBuilder.IUnprocessedTagsHandler - Interface in hr.ngs.templater
Register a new unprocessed tags plugin.
IDocumentFactoryBuilder.SvgConverter - Interface in hr.ngs.templater
Conversion function.
IDocumentFactoryBuilder.TagPattern - Enum in hr.ngs.templater
Supported tag patterns
IEditorConfigurationBuilder - Interface in hr.ngs.templater
Templater Editor integration is available for Reporting and Enterprise license.
IEditorConfigurationBuilder.MetadataProvider - Interface in hr.ngs.templater
Callback for metadata type.
IEditorConfigurationBuilder.TagMetadata - Class in hr.ngs.templater
Additional metadata available in Templater Editor.
IEditorConfigurationBuilder.TagMetadata.Builder - Class in hr.ngs.templater
Builder helper for metadata construction
IEditorConfigurationBuilder.TagStatus - Enum in hr.ngs.templater
Status of the tag used in the Templater Editor.
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(IDocumentFactoryBuilder.INavigate) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Register a new navigation plugin.
include(IDocumentFactoryBuilder.IFormatter) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Register a new formatter plugin.
include(IDocumentFactoryBuilder.IHandler) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Register a new metadata handler plugin.
include(Class<T>, IDocumentFactoryBuilder.IProcessor<T>) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Register a new processor plugin.
include(IDocumentFactoryBuilder.ILowLevelReplacer) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
When input values must be replaced before and there is not appropriate metadata.
issuesListing(boolean) - Method in interface hr.ngs.templater.IEditorConfigurationBuilder
When tag detection and analysis is enabled, Templater Editor will search for various issues in the document.
ITemplateDocument - Interface in hr.ngs.templater
Template document with analyzed tags.
ITemplater - Interface in hr.ngs.templater
Provides access to low level API.
ITemplater.TagPosition - Class in hr.ngs.templater
Exact tag position for the resize method.

L

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

M

metadataResolver(IEditorConfigurationBuilder.MetadataProvider) - Method in interface hr.ngs.templater.IEditorConfigurationBuilder
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.IDocumentFactoryBuilder.INavigate
Plugin works by accepting parent object, current evaluated object, member used for navigation and detected metadata.
navigateSeparator(char) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Change navigation separator.
navigateUsing(char) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Change navigation character.

O

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

P

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

R

replace(Object, String, String[]) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder.ILowLevelReplacer
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.ITemplater
Replace first specified tag with provided value.
replace(String, int, Object) - Method in interface hr.ngs.templater.ITemplater
Replace tag at the position in the sequence of same tag paths with provided value.
resize(String[], int) - Method in interface hr.ngs.templater.ITemplater
Resize context which contains all specified tags.
resize(ITemplater.TagPosition[], int) - Method in interface hr.ngs.templater.ITemplater
Resize context which contains all specified tags.
resizeLimit(int) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Maximum number of times same tag can be resized.
resolution(float) - Method in class hr.ngs.templater.ImageInfo.Builder
Image resolution (DPI).

S

status(IEditorConfigurationBuilder.TagStatus) - Method in class hr.ngs.templater.IEditorConfigurationBuilder.TagMetadata.Builder
Prepare the tag status.
status - Variable in class hr.ngs.templater.IEditorConfigurationBuilder.TagMetadata
Status of the tag.
streaming(int) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Configure the streaming size.
svgConverter(IDocumentFactoryBuilder.SvgConverter) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
When adding SVG into documents, use additional converter for fallback image.

T

tag - Variable in class hr.ngs.templater.ITemplater.TagPosition
Tag value to match.
tagDetection(boolean) - Method in interface hr.ngs.templater.IEditorConfigurationBuilder
Continuously run tag detection on any change in the document.
tagListing(boolean) - Method in interface hr.ngs.templater.IEditorConfigurationBuilder
Show tag listing when opening up document.
tagManagement(boolean) - Method in interface hr.ngs.templater.IEditorConfigurationBuilder
Is the user allowed to specify their own tags.
TagMetadata(IEditorConfigurationBuilder.TagStatus, Class<?>, String, String, String) - Constructor for class hr.ngs.templater.IEditorConfigurationBuilder.TagMetadata
Create tag metadata description.
TagPosition(String, int) - Constructor for class hr.ngs.templater.ITemplater.TagPosition
Prepare structure by defining tag and position arguments
tags() - Method in interface hr.ngs.templater.ITemplater
Recognized tags in the document.
templater() - Method in interface hr.ngs.templater.ITemplateDocument
Provides access to the low-level API.
tryProcess(String, ITemplater, T) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder.IProcessor
A custom processor can be registered for specialized data types.

V

valueOf(String) - Static method in enum hr.ngs.templater.Handled
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum hr.ngs.templater.IDocumentFactoryBuilder.TagPattern
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum hr.ngs.templater.IEditorConfigurationBuilder.TagStatus
Returns the enum constant of this type with the specified name.
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.
values() - Static method in enum hr.ngs.templater.IDocumentFactoryBuilder.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.IEditorConfigurationBuilder.TagStatus
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.IDocumentFactoryBuilder
During class analysis, bean convention can be used.
withMatcher(String) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Customize tag matcher for all patterns.
withMatcher(String, IDocumentFactoryBuilder.TagPattern) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Customize tag matcher for a specific pattern.

X

xmlBuilder(DocumentBuilderFactory, boolean) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Change default XML parser.
xmlTransformer(TransformerFactory, boolean) - Method in interface hr.ngs.templater.IDocumentFactoryBuilder
Change default XML transformer (writer).
A B C D E F G H I L M N O P R S T V W X 
Skip navigation links