|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.clearsilver.jsilver.interpreter.InterpretedMacro
public class InterpretedMacro
User defined macro that will be executed by the interpreter. NOTE: This is not thread safe and cannot be shared between RenderingContexts. This is taken care of by the TemplateInterpreter.
Constructor Summary | |
---|---|
InterpretedMacro(PCommand command,
Template owningTemplate,
String macroName,
String[] argumentNames,
TemplateInterpreter templateInterpreter,
RenderingContext owningContext)
|
Method Summary | |
---|---|
RenderingContext |
createRenderingContext(Data data,
Appendable out,
ResourceLoader resourceLoader)
Create a new RenderingContext. |
int |
getArgumentCount()
Return the number of arguments this macro expects. |
String |
getArgumentName(int index)
Get the name of the nth argument defined in the macro. |
String |
getDisplayName()
Name to use when displaying error or log messages. |
EscapeMode |
getEscapeMode()
Return the EscapeMode in which this template was generated. |
String |
getMacroName()
Name of macro (e.g. |
String |
getTemplateName()
Name of template (e.g. |
void |
render(Data data,
Appendable out,
ResourceLoader resourceLoader)
Render the template. |
void |
render(RenderingContext context)
Render the template with a custom RenderingContext. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public InterpretedMacro(PCommand command, Template owningTemplate, String macroName, String[] argumentNames, TemplateInterpreter templateInterpreter, RenderingContext owningContext)
Method Detail |
---|
public void render(RenderingContext context) throws IOException
Template
render
in interface Template
context
- RenderingContext to use during rendering.
IOException
public void render(Data data, Appendable out, ResourceLoader resourceLoader) throws IOException
Template
render
in interface Template
data
- Data to merge with template.out
- Target to write to.resourceLoader
- ResourceLoader to use instead of the default template one when loading
files.
IOException
public RenderingContext createRenderingContext(Data data, Appendable out, ResourceLoader resourceLoader)
Template
createRenderingContext
in interface Template
data
- Data to merge with template.out
- Target to write to.resourceLoader
- ResourceLoader to load files.public String getTemplateName()
Template
getTemplateName
in interface Template
public EscapeMode getEscapeMode()
Template
getEscapeMode
in interface Template
public String getDisplayName()
Template
getDisplayName
in interface Template
public String getMacroName()
Macro
getMacroName
in interface Macro
public String getArgumentName(int index)
Macro
getArgumentName
in interface Macro
public int getArgumentCount()
Macro
getArgumentCount
in interface Macro
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |