A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

append(char) - Method in DelegatingIndentWriter

B

BaseTemplate - Class in groovy.text.markup

BaseTemplate(MarkupTemplateEngine, Map, Map<String, String>, TemplateConfiguration) - Constructor in BaseTemplate

C

cache - Field in MarkupTemplateEngine.CachingTemplateResolver

close() - Method in DelegatingIndentWriter

comment(Object) - Method in BaseTemplate

Renders the supplied object using its Object.toString method inside a comment markup block (<!

configure(ClassLoader, TemplateConfiguration) - Method in MarkupTemplateEngine.CachingTemplateResolver

configure(ClassLoader, TemplateConfiguration) - Method in MarkupTemplateEngine.DefaultTemplateResolver

configure(ClassLoader, TemplateConfiguration) - Method in TemplateResolver

This method is called once the template engine is initialized, providing the resolver with the template engine configuration and its template class loader.

contents(Closure) - Method in BaseTemplate

Wraps a closure so that it can be used as a prototype for inclusion in layouts.

createTemplate(Reader) - Method in GStringTemplateEngine

createTemplate(URL) - Method in MarkupTemplateEngine

createTemplate(Reader) - Method in SimpleTemplateEngine

createTemplate(Reader) - Method in StreamingTemplateEngine

Creates a template instance using the template source from the provided Reader.

createTemplate(URL) - Method in TemplateEngine

createTemplate(Reader) - Method in XmlTemplateEngine

createTemplateByPath(String) - Method in MarkupTemplateEngine

createTypeCheckedModelTemplate(URL, Map<String, String>) - Method in MarkupTemplateEngine

createTypeCheckedModelTemplateByPath(String, Map<String, String>) - Method in MarkupTemplateEngine

D

DEFAULT_INDENTATION - Field in XmlTemplateEngine

DelegatingIndentWriter - Class in groovy.text.markup

A writer which delegates to another writer and supports an additional indenting level.

DelegatingIndentWriter(Writer, String) - Constructor in DelegatingIndentWriter

E

F

flush() - Method in DelegatingIndentWriter

fragment(Map, String) - Method in BaseTemplate

Renders an embedded template as a fragment.

G

getAutoIndentString() - Method in TemplateConfiguration

getBaseTemplateClass() - Method in TemplateConfiguration

getColumn() - Method in TemplateParseException

getCompilerConfiguration() - Method in MarkupTemplateEngine

getDeclarationEncoding() - Method in TemplateConfiguration

@return the encoding used in the declaration header

getIndentation() - Method in XmlTemplateEngine

getLineNumber() - Method in TemplateExecutionException

Returns the line number in the template source where the error occurred

getLineNumber() - Method in TemplateParseException

getLocale() - Method in TemplateConfiguration

getModel() - Method in BaseTemplate

getNewLineString() - Method in TemplateConfiguration

getOut() - Method in BaseTemplate

Convenience method to return the current writer instance.

getTemplateConfiguration() - Method in MarkupTemplateEngine

getTemplateLoader() - Method in MarkupTemplateEngine

GStringTemplateEngine - Class in groovy.text

Processes template source files substituting variables and expressions into placeholders in a template source text to produce the desired output using a streaming approach.

GStringTemplateEngine(ClassLoader) - Constructor in GStringTemplateEngine

H

hasLocale() - Method in MarkupTemplateEngine.TemplateResource

I

includeEscaped(String) - Method in BaseTemplate

Includes contents of another file, not as a template but as escaped text.

includeGroovy(String) - Method in BaseTemplate

Includes another template inside this template.

includeUnescaped(String) - Method in BaseTemplate

Includes contents of another file, not as a template but as unescaped text.

isAutoEscape() - Method in TemplateConfiguration

@return true if variables in the model which are assignable to CharSequence should be automatically escaped.

isAutoIndent() - Method in TemplateConfiguration

@return true if the template engine should handle indents automatically

isAutoNewLine() - Method in TemplateConfiguration

isCacheTemplates() - Method in TemplateConfiguration

isEscapeBackslash() - Method in SimpleTemplateEngine

isExpandEmptyElements() - Method in TemplateConfiguration

@return whether elements without body should be written in the short form (ex: <br/>) or in an expanded form (ex: <br></br>)

isUseDoubleQuotes() - Method in TemplateConfiguration

@return true if attributes should use double quotes instead of single quotes

isVerbose() - Method in SimpleTemplateEngine

J

K

L

layout(Map, String, boolean) - Method in BaseTemplate

Imports a template and renders it using the specified model, allowing fine grained composition of templates and layouting.

M

make(Map) - Method in Template

MarkupTemplateEngine - Class in groovy.text.markup

A template engine which leverages groovy.xml.StreamingMarkupBuilder to generate XML/XHTML.

MarkupTemplateEngine.CachingTemplateResolver - Class in groovy.text.markup

A template resolver which avoids calling ClassLoader.getResource if a template path already has been queried before.

MarkupTemplateEngine.CachingTemplateResolver() - Constructor in MarkupTemplateEngine.CachingTemplateResolver

Creates a new caching template resolver using a concurrent hash map as the backing cache.

MarkupTemplateEngine.DefaultTemplateResolver - Class in groovy.text.markup

MarkupTemplateEngine.DefaultTemplateResolver() - Constructor in MarkupTemplateEngine.DefaultTemplateResolver

MarkupTemplateEngine.TemplateResource - Class in groovy.text.markup

MarkupTemplateEngine(ClassLoader, File, TemplateConfiguration) - Constructor in MarkupTemplateEngine

Convenience constructor to build a template engine which searches for templates into a directory

MarkupTemplateTypeCheckingExtension - Class in groovy.text.markup

methodMissing(String, Object) - Method in BaseTemplate

This is the main method responsible for writing a tag and its attributes.

methodMissing(String, def) - Method in TagLibAdapter

N

newLine() - Method in BaseTemplate

Adds a new line to the output.

next() - Method in DelegatingIndentWriter

O

P

parse(String) - Method in MarkupTemplateEngine.TemplateResource

pi(Map<?, ?>) - Method in BaseTemplate

previous() - Method in DelegatingIndentWriter

Q

R

registerTagLib(Object) - Method in TagLibAdapter

resolveTemplate(String) - Method in MarkupTemplateEngine

resolveTemplate(String) - Method in MarkupTemplateEngine.CachingTemplateResolver

resolveTemplate(String) - Method in MarkupTemplateEngine.DefaultTemplateResolver

resolveTemplate(String) - Method in TemplateResolver

Resolvers must implement this method in order to resolve a template, given a template path.

run() - Method in BaseTemplate

run() - Method in MarkupTemplateTypeCheckingExtension

S

setAutoEscape(boolean) - Method in TemplateConfiguration

Set to true if you want variables in the model which are assignable to CharSequence to be escaped automatically in templates.

setAutoIndent(boolean) - Method in TemplateConfiguration

Set this to true if you want the template engine to render indents automatically.

setAutoIndentString(String) - Method in TemplateConfiguration

setAutoNewLine(boolean) - Method in TemplateConfiguration

setBaseTemplateClass(Class<? extends BaseTemplate>) - Method in TemplateConfiguration

Set the template base class.

setCacheTemplates(boolean) - Method in TemplateConfiguration

If cache is enabled, then templates are compiled once for each source (URL or File).

setDeclarationEncoding(String) - Method in TemplateConfiguration

Set the encoding used to write the declaration header.

setEscapeBackslash(boolean) - Method in SimpleTemplateEngine

setExpandEmptyElements(boolean) - Method in TemplateConfiguration

setIndentation(String) - Method in XmlTemplateEngine

setLocale(Locale) - Method in TemplateConfiguration

setNewLineString(String) - Method in TemplateConfiguration

setUseDoubleQuotes(boolean) - Method in TemplateConfiguration

setVerbose(boolean) - Method in SimpleTemplateEngine

@param verbose true if you want the engine to display the template source file for debugging purposes

SimpleTemplateEngine - Class in groovy.text

Processes template source files substituting variables and expressions into placeholders in a template source text to produce the desired output.

SimpleTemplateEngine(GroovyShell) - Constructor in SimpleTemplateEngine

SPACES - Field in DelegatingIndentWriter

StreamingTemplateEngine - Class in groovy.text

Processes template source files substituting variables and expressions into placeholders in a template source text to produce the desired output using a closure based approach.

StreamingTemplateEngine(ClassLoader) - Constructor in StreamingTemplateEngine

Create a streaming template engine instance using a custom class loader

stringOf(Closure) - Method in BaseTemplate

T

TAB - Field in DelegatingIndentWriter

TagLibAdapter - Class in groovy.text.markup

Adapts Grails taglibs for use in the template engine.

TagLibAdapter(BaseTemplate) - Constructor in TagLibAdapter

Template - Interface in groovy.text

A template is a block of text with an associated binding that can be output to a writer or evaluated to a string.

TemplateConfiguration - Class in groovy.text.markup

Configuration options for the markup template engine.

TemplateConfiguration(TemplateConfiguration) - Constructor in TemplateConfiguration

TemplateEngine - Class in groovy.text

Represents an API to any template engine which is basically a factory of Template instances from a given text input.

TemplateExecutionException - Class in groovy.text

A custom exception class to flag template execution errors

TemplateExecutionException(int, Throwable) - Constructor in TemplateExecutionException

TemplateParseException - Class in groovy.text

A custom exception class to flag template parsing errors

TemplateParseException(Throwable, int, int) - Constructor in TemplateParseException

TemplateResolver - Interface in groovy.text.markup

Interface for template resolvers, which, given a template identifier, return an URL where the template can be loaded.

toString() - Method in BaseTemplate

toString() - Method in MarkupTemplateEngine.TemplateResource

toString() - Method in XmlTemplateEngine

tryEscape(Object) - Method in BaseTemplate

Escapes the string representation of the supplied object if it derives from CharSequence, otherwise returns the object itself.

U

useCache - Field in MarkupTemplateEngine.CachingTemplateResolver

V

W

withLocale(String) - Method in MarkupTemplateEngine.TemplateResource

write(String, int, int) - Method in DelegatingIndentWriter

writeIndent() - Method in DelegatingIndentWriter

writeTo(Writer) - Method in BaseTemplate

Main method used to render a template.

X

xmlDeclaration() - Method in BaseTemplate

Renders an XML declaration header.

XmlTemplateEngine - Class in groovy.text

Template engine for use in templating scenarios where both the template source and the expected output are intended to be XML.

XmlTemplateEngine(XmlParser, GroovyShell) - Method in XmlTemplateEngine

Y

yield(Object) - Method in BaseTemplate

Renders the object provided as parameter using its Object.toString method, The contents is rendered after being escaped for XML, enforcing valid XML output.

yieldUnescaped(Object) - Method in BaseTemplate

Renders the object provided as parameter using its Object.toString method, The contents is rendered as is, unescaped.

Z

_