de.hybris.platform.commons.translator.renderers

Class VelocityRenderer

java.lang.Object

de.hybris.platform.commons.translator.renderers.AbstractRenderer

de.hybris.platform.commons.translator.renderers.VelocityRenderer

public class VelocityRenderer
extends AbstractRenderer

VelocityRenderer is a renderer that uses a velocity template. Templates can be defined in the in <template> element of the Renderers XML file, together with a renderer that uses it. Templates also can be stored in separate files: Instead of defining them in the <template&ggt; element, use the <templateName> element of the renderers XML file. The <templateName> parameter is used to search for a file containing the template definition.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	template
protected java.lang.String	templateName

Fields inherited from class de.hybris.platform.commons.translator.renderers.AbstractRenderer

end, properties, start

Constructor Summary

Constructors

Constructor and Description
VelocityRenderer()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTemplate()
java.lang.String	getTemplateName()
void	loadTemplateFromFile() try to load velocity template from the file
void	loadTemplateFromURL() try to search template in url defined in templateName element from xml file
java.lang.String	renderTextFromNode(AbstractNode node, Translator translator) This method produces output text by using data from the node and by using a reference to the Translator (for subnodes rendereing)
void	setTemplate(java.lang.String template)
void	setTemplateName(java.lang.String templateName)

Methods inherited from class de.hybris.platform.commons.translator.renderers.AbstractRenderer

setEnd, setProperties, setStart

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

templateName

protected java.lang.String templateName

template

protected java.lang.String template

Constructor Detail

VelocityRenderer

public VelocityRenderer()

Method Detail

renderTextFromNode

public java.lang.String renderTextFromNode(AbstractNode node,
                                           Translator translator)

Description copied from class: AbstractRenderer

This method produces output text by using data from the node and by using a reference to the Translator (for subnodes rendereing)

Specified by:

renderTextFromNode in class AbstractRenderer

loadTemplateFromURL

public void loadTemplateFromURL()

try to search template in url defined in templateName element from xml file

loadTemplateFromFile

public void loadTemplateFromFile()

try to load velocity template from the file

getTemplateName

public java.lang.String getTemplateName()

setTemplateName

public void setTemplateName(java.lang.String templateName)

getTemplate

public java.lang.String getTemplate()

setTemplate

public void setTemplate(java.lang.String template)