Package de.hybris.platform.commons.renderer.impl

Class VelocityTemplateRenderer

  • All Implemented Interfaces:
    Renderer
    public class VelocityTemplateRenderer
extends java.lang.Object
implements Renderer
    Renders velocity template. Rendered content is output to Writer specified as 3rd parameter passed to render method.

    Context object is registered as 'contextName' property in Spring XML file. Context object stores properties as key-value map. So if you set 'contextName' as 'ctx' and in context you place key1=value1 you refer to it as $ctx.key1.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void evaluate​(java.io.Writer result, org.apache.velocity.VelocityContext ctx, java.io.Reader reader)  
      void render​(RendererTemplateModel template, java.lang.Object context, java.io.Writer output)
      Renders template.
      void setContextName​(java.lang.String contextName)  
      void setMediaService​(MediaService mediaService)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • VelocityTemplateRenderer

        public VelocityTemplateRenderer()

    • Method Detail

      • render

        public void render​(RendererTemplateModel template,
                   java.lang.Object context,
                   java.io.Writer output)
        Description copied from interface: Renderer
        Renders template. Rendered content is stored into output.
        Specified by:
        render in interface Renderer
        Parameters:
        template - to render
        context - context (usually map of properties)
        output - rendered content

      • evaluate

        protected void evaluate​(java.io.Writer result,
                        org.apache.velocity.VelocityContext ctx,
                        java.io.Reader reader)
                 throws java.io.IOException
        Throws:
        java.io.IOException

      • setMediaService

        public void setMediaService​(MediaService mediaService)
        Parameters:
        mediaService - the mediaService to set

      • setContextName

        public void setContextName​(java.lang.String contextName)
        Parameters:
        contextName - the contextName to set