public abstract class BaseTemplate extends Object implements Writable
All templates compiled through MarkupTemplateEngine extend this abstract class, which provides a number of utility methods to generate markup. An instance of this class can be obtained after calling Template.make or Template.make)} on a template generated by MarkupTemplateEngine.createTemplate.
It is advised to use a distinct template instance for each thread (or more simply, each rendered document) for thread safety and avoiding mixing models.
For the application needs, it is possible to provide more helper methods by extending this class and configuring the base template class using the TemplateConfiguration.setBaseTemplateClass method.
| Constructor and description |
|---|
BaseTemplate(MarkupTemplateEngine templateEngine, Map model, Map<String, String> modelTypes, TemplateConfiguration configuration) |
| Type Params | Return Type | Name and description |
|---|---|---|
|
public Object |
call() |
|
public Object |
call(Object args) |
|
public Object |
call(Object arguments) |
|
public BaseTemplate |
comment(Object cs)Renders the supplied object using its Object.toString method inside a comment markup block (<! |
|
public Closure |
contents(Closure cl)Wraps a closure so that it can be used as a prototype for inclusion in layouts. |
|
public Object |
fragment(Map model, String templateText)Renders an embedded template as a fragment. |
|
public Map |
getModel() |
|
public Writer |
getOut()Convenience method to return the current writer instance. |
|
public void |
includeEscaped(String templatePath)Includes contents of another file, not as a template but as escaped text. |
|
public void |
includeGroovy(String templatePath)Includes another template inside this template. |
|
public void |
includeUnescaped(String templatePath)Includes contents of another file, not as a template but as unescaped text. |
|
public Object |
layout(Map model, String templateName)Imports a template and renders it using the specified model, allowing fine grained composition of templates and layouting. |
|
public Object |
layout(Map model, String templateName, boolean inheritModel)Imports a template and renders it using the specified model, allowing fine grained composition of templates and layouting. |
|
public Object |
methodMissing(String tagName, Object args)This is the main method responsible for writing a tag and its attributes. |
|
public void |
newLine()Adds a new line to the output. |
|
public BaseTemplate |
pi(Map<?, ?> attrs) |
|
public abstract Object |
run() |
|
public String |
stringOf(Closure cl) |
|
public String |
toString() |
|
public Object |
tryEscape(Object contents)Escapes the string representation of the supplied object if it derives from CharSequence, otherwise returns the object itself. |
|
public Writer |
writeTo(Writer out)Main method used to render a template. |
|
public BaseTemplate |
xmlDeclaration()Renders an XML declaration header. |
|
public BaseTemplate |
yield(Object obj)Renders the object provided as parameter using its Object.toString method, The contents is rendered after being escaped for XML, enforcing valid XML output. |
|
public BaseTemplate |
yieldUnescaped(Object obj)Renders the object provided as parameter using its Object.toString method, The contents is rendered as is, unescaped. |
Renders the supplied object using its Object.toString method inside a comment markup block (<!-- ... -->). The object is rendered as is, unescaped.
cs - the object to be rendered inside an XML comment block.Wraps a closure so that it can be used as a prototype for inclusion in layouts. This is useful when you want to use a closure in a model, but that you don't want to render the result of the closure but instead call it as if it was a specification of a template fragment.
cl - the fragment to be wrappedRenders an embedded template as a fragment. Fragments are cached in a template, meaning that if you use the same fragment in a template, it will only be compiled once, but once per template instance. This is less performant than using layout(java.util.Map, String).
model - model to be passed to the templatetemplateText - template bodyConvenience method to return the current writer instance.
Includes contents of another file, not as a template but as escaped text.
templatePath - the path to the other fileIncludes another template inside this template.
templatePath - the path to the included resource.Includes contents of another file, not as a template but as unescaped text.
templatePath - the path to the other fileImports a template and renders it using the specified model, allowing fine grained composition of templates and layouting. This works similarily to a template include but allows a distinct model to be used. This version doesn't inherit the model from the parent. If you need model inheritance, see layout(java.util.Map, String, boolean).
model - model to be passed to the templatetemplateName - the name of the template to be used as a layoutImports a template and renders it using the specified model, allowing fine grained composition of templates and layouting. This works similarily to a template include but allows a distinct model to be used. If the layout inherits from the parent model, a new model is created, with the values from the parent model, eventually overridden with those provided specifically for this layout.
model - model to be passed to the templatetemplateName - the name of the template to be used as a layoutinheritModel - a boolean indicating if we should inherit the parent modelThis is the main method responsible for writing a tag and its attributes. The arguments may be:
or a combination of (attributes,string), (attributes,closure)
tagName - the name of the tagargs - tag generation argumentsAdds a new line to the output. The new line string can be configured by TemplateConfiguration.setNewLineString
Renders processing instructions. The supplied map contains all elements to be rendered as processing instructions. The key is the name of the element, the value is either a map of attributes, or an object to be rendered directly. For example:
pi("xml-stylesheet":[href:"mystyle.css", type:"text/css"])
will be rendered as:
<?xml-stylesheet href='mystyle.css' type='text/css'?>
attrs - the attributes to renderEscapes the string representation of the supplied object if it derives from CharSequence, otherwise returns the object itself.
contents - an object to be escaped for XMLMain method used to render a template.
out - the Writer to which this Writable should output its data.Renders an XML declaration header. If the declaration encoding is set in the template configuration, then the encoding is rendered into the declaration.
Renders the object provided as parameter using its Object.toString method, The contents is rendered after being escaped for XML, enforcing valid XML output.
obj - the object to be renderedRenders the object provided as parameter using its Object.toString method, The contents is rendered as is, unescaped. This means that depending on what the Object.toString method call returns, you might create invalid markup.
obj - the object to be rendered unescapedCopyright © 2003-2022 The Apache Software Foundation. All rights reserved.