|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ITemplate
Define a template instance API
Nested Class Summary | |
---|---|
static class |
ITemplate.__Context
The render time context. |
Nested classes/interfaces inherited from interface org.rythmengine.template.ITag |
---|
ITag.__Body, ITag.__Parameter, ITag.__ParameterList |
Method Summary | ||
---|---|---|
ITemplate |
__cloneMe(RythmEngine engine,
ITemplate caller)
Get a copy of this template instance and pass in the engine and caller |
|
ICodeType |
__curCodeType()
(not API) Return current code type. |
|
Escape |
__curEscape()
(not API) Return the current escape scheme |
|
Locale |
__curLocale()
(not API) Return the current locale |
|
RythmEngine |
__engine()
Return the engine instance that is running this template |
|
StringBuilder |
__getBuffer()
Return the internal buffer |
|
|
__getRenderArg(String name)
Return a render arg value by name |
|
org.rythmengine.internal.compiler.TemplateClass |
__getTemplateClass(boolean useCaller)
Return the template class of this template instance |
|
Map<String,Object> |
__getUserContext()
Return user context previously set to this template instance. |
|
void |
__init()
Must be called before real render() happened. |
|
ITemplate |
__setOutputStream(OutputStream os)
Set binary output stream to the template instance. |
|
ITemplate |
__setRenderArg(int position,
Object arg)
Set a render arg by position |
|
ITemplate |
__setRenderArg(JSONWrapper jsonData)
Set renderArgs using JSON data |
|
ITemplate |
__setRenderArg(String name,
Object arg)
Set a render arg by name |
|
ITemplate |
__setRenderArgs(Map<String,Object> args)
Set renderArgs in name-value pair |
|
ITemplate |
__setRenderArgs(Object... args)
Set renderArgs in position |
|
ITemplate |
__setSecureCode(String secureCode)
Set secure code (for sandbox purpse) |
|
ITemplate |
__setUserContext(Map<String,Object> userContext)
Set user context to the template instance |
|
ITemplate |
__setWriter(Writer writer)
Set a character based writer to the template instance |
|
String |
render()
Render the template and return result as String |
|
void |
render(OutputStream os)
Render the template and put the result into outputstream |
|
void |
render(Writer w)
Render the template and put the result into writer |
Methods inherited from interface org.rythmengine.template.ITag |
---|
__call, __getName, __setBodyContext |
Method Detail |
---|
RythmEngine __engine()
engine
instanceorg.rythmengine.internal.compiler.TemplateClass __getTemplateClass(boolean useCaller)
useCaller
- if set to true then return caller template class if this template has no template class
ITemplate __setOutputStream(OutputStream os)
os
-
NullPointerException
- if os specified is null
IllegalStateException
- if output stream or writer
is already setITemplate __setWriter(Writer writer)
writer
-
NullPointerException
- if os specified is null
IllegalStateException
- if output stream
or writer is already setITemplate __setUserContext(Map<String,Object> userContext)
userContext
-
Map<String,Object> __getUserContext()
ITemplate __setRenderArgs(Map<String,Object> args)
args
-
ITemplate __setRenderArgs(Object... args)
args
-
ITemplate __setRenderArg(String name, Object arg)
name
- arg
-
<T> T __getRenderArg(String name)
T
- name
-
ITemplate __setRenderArg(int position, Object arg)
position
- arg
-
ITemplate __setRenderArg(JSONWrapper jsonData)
jsonData
-
String render()
void render(OutputStream os)
os
- void render(Writer w)
w
- void __init()
StringBuilder __getBuffer()
ITemplate __setSecureCode(String secureCode)
secureCode
-
ITemplate __cloneMe(RythmEngine engine, ITemplate caller)
engine
- the rythm enginecaller
- the caller template
Locale __curLocale()
Escape __curEscape()
ICodeType __curCodeType()
type
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |