|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.jelly.TagSupport
org.apache.commons.jelly.tags.velocity.VelocityTagSupport
org.apache.commons.jelly.tags.velocity.MergeTag
A tag that uses Velocity to render a specified template with the JellyContext storing the results in either a variable in the JellyContext or in a specified file.
Field Summary | |
private java.lang.String |
basedir
|
private static java.lang.String |
ENCODING
|
private java.lang.String |
inputEncoding
|
private java.lang.String |
name
|
private java.lang.String |
outputEncoding
|
private boolean |
readOnly
|
private java.lang.String |
template
|
private java.lang.String |
var
|
Fields inherited from class org.apache.commons.jelly.tags.velocity.VelocityTagSupport |
VELOCITY_ENGINE_VAR_NAME |
Fields inherited from class org.apache.commons.jelly.TagSupport |
body, context, hasTrimmed, parent, shouldTrim |
Constructor Summary | |
MergeTag()
|
Method Summary | |
void |
doTag(org.apache.commons.jelly.XMLOutput output)
|
private void |
mergeTemplate(java.io.Writer writer)
Merges the Velocity template with the Jelly context. |
void |
setBasedir(java.lang.String basedir)
Sets the base directory used for loading of templates by the Velocity file resource loader. |
void |
setInputEncoding(java.lang.String encoding)
Sets the input encoding used in the specified template which defaults to ISO-8859-1. |
void |
setName(java.lang.String name)
Sets the file name for the merged output. |
void |
setOutputEncoding(java.lang.String encoding)
Sets the output encoding mode which defaults to ISO-8859-1 used when storing the results of a merge in a file. |
void |
setReadOnly(boolean readOnly)
Sets the read-only flag for this adapter which prevents modifications in the Velocity context from propogating to the JellyContext. |
void |
setTemplate(java.lang.String template)
Sets the filename of the template used to merge with the JellyContext. |
void |
setVar(java.lang.String var)
Sets the var used to store the results of the merge. |
Methods inherited from class org.apache.commons.jelly.tags.velocity.VelocityTagSupport |
getVelocityEngine |
Methods inherited from class org.apache.commons.jelly.TagSupport |
findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, getBody, getBodyText, getBodyText, getContext, getParent, invokeBody, isEscapeText, isTrim, setBody, setContext, setEscapeText, setParent, setTrim, trimBody |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private static final java.lang.String ENCODING
private java.lang.String var
private java.lang.String name
private java.lang.String basedir
private java.lang.String template
private java.lang.String inputEncoding
private java.lang.String outputEncoding
private boolean readOnly
Constructor Detail |
public MergeTag()
Method Detail |
public void doTag(org.apache.commons.jelly.XMLOutput output) throws org.apache.commons.jelly.JellyTagException
org.apache.commons.jelly.JellyTagException
public void setVar(java.lang.String var)
var
- The var to set in the JellyContext with the results of
the merge.public void setName(java.lang.String name)
name
- The name of the output file that is used to store the
results of the merge.public void setBasedir(java.lang.String basedir)
basedir
- The directory where templates can be located by
the Velocity file resource loader.public void setTemplate(java.lang.String template)
template
- The filename of the template to be merged.public void setReadOnly(boolean readOnly)
readOnly
- true prevents modifications from
propogating (the default), or false which permits
modifications.public void setOutputEncoding(java.lang.String encoding)
encoding
- The file encoding to use when writing the
output.public void setInputEncoding(java.lang.String encoding)
encoding
- The encoding used in the template.private void mergeTemplate(java.io.Writer writer) throws org.apache.commons.jelly.JellyTagException
writer
- The output writer used to write the merged results.
java.lang.Exception
- If an exception occurs during the merge.
org.apache.commons.jelly.JellyTagException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |