Package groovy.text.markup
Class TemplateConfiguration
java.lang.Object
groovy.text.markup.TemplateConfiguration
Configuration options for the 
markup template engine.- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionClass<? extends BaseTemplate>booleanbooleanbooleanbooleanbooleanbooleanvoidsetAutoEscape(boolean autoEscape) Set to true if you want variables in the model which are assignable toCharSequenceto be escaped automatically in templates.voidsetAutoIndent(boolean autoIndent) Set this to true if you want the template engine to render indents automatically.voidsetAutoIndentString(String autoIndentString) voidsetAutoNewLine(boolean autoNewLine) voidsetBaseTemplateClass(Class<? extends BaseTemplate> baseTemplateClass) Set the template base class.voidsetCacheTemplates(boolean cacheTemplates) If cache is enabled, then templates are compiled once for each source (URL or File).voidsetDeclarationEncoding(String declarationEncoding) Set the encoding used to write the declaration header.voidsetExpandEmptyElements(boolean expandEmptyElements) voidvoidsetNewLineString(String newLineString) voidsetUseDoubleQuotes(boolean useDoubleQuotes) 
- 
Constructor Details- 
TemplateConfigurationpublic TemplateConfiguration()
- 
TemplateConfiguration
 
- 
- 
Method Details- 
getDeclarationEncoding- Returns:
- the encoding used in the declaration header
 
- 
setDeclarationEncodingSet the encoding used to write the declaration header. Note that it is the responsibility of the user to ensure that it matches the writer encoding.- Parameters:
- declarationEncoding- encoding to be used in the declaration string
 
- 
isExpandEmptyElementspublic boolean isExpandEmptyElements()- Returns:
- whether elements without body should be written in the short form (ex: <br/>) or in an expanded form (ex: <br></br>)
 
- 
setExpandEmptyElementspublic void setExpandEmptyElements(boolean expandEmptyElements) 
- 
isUseDoubleQuotespublic boolean isUseDoubleQuotes()- Returns:
- true if attributes should use double quotes instead of single quotes
 
- 
setUseDoubleQuotespublic void setUseDoubleQuotes(boolean useDoubleQuotes) 
- 
getNewLineString
- 
setNewLineString
- 
isAutoEscapepublic boolean isAutoEscape()- Returns:
- true if variables in the model which are assignable to CharSequenceshould be automatically escaped.
 
- 
setAutoEscapepublic void setAutoEscape(boolean autoEscape) Set to true if you want variables in the model which are assignable toCharSequenceto be escaped automatically in templates. If this flag is set to true and that you want a value not to be automatically escaped, then you need to use ${unescaped.variable} instead of $variable- Parameters:
- autoEscape- value if the autoEscape flag
 
- 
isAutoIndentpublic boolean isAutoIndent()- Returns:
- true if the template engine should handle indents automatically
 
- 
setAutoIndentpublic void setAutoIndent(boolean autoIndent) Set this to true if you want the template engine to render indents automatically. In that case, the supplied writer is wrapped into aDelegatingIndentWriterand indents are inserted after each call to newLine.- Parameters:
- autoIndent- the auto-indent flag
 
- 
getAutoIndentString
- 
setAutoIndentString
- 
isAutoNewLinepublic boolean isAutoNewLine()
- 
setAutoNewLinepublic void setAutoNewLine(boolean autoNewLine) 
- 
getBaseTemplateClass
- 
setBaseTemplateClassSet the template base class. You can use a distinct template class to provide more statically available data to your templates.- Parameters:
- baseTemplateClass- a class extending- BaseTemplate
 
- 
getLocale
- 
setLocale
- 
isCacheTemplatespublic boolean isCacheTemplates()
- 
setCacheTemplatespublic void setCacheTemplates(boolean cacheTemplates) If cache is enabled, then templates are compiled once for each source (URL or File). It is recommended to keep this flag to true unless you are in development mode and want automatic reloading of templates.- Parameters:
- cacheTemplates- should templates be cached
 
 
-