Package org.apache.turbine.modules.layouts

Class VelocityLayout

java.lang.Object

org.apache.turbine.modules.layouts.VelocityLayout

All Implemented Interfaces:

Assembler, Layout

Direct Known Subclasses:

VelocityDirectLayout, VelocityOnlyLayout

public abstract class VelocityLayout
extends Object
implements Layout

This Layout module allows Velocity templates to be used as layouts.

Author:

Thomas Vandahl

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.logging.log4j.Logger	log	Logging
protected static String	prefix	The prefix for lookup up layout pages
protected VelocityService	velocityService	Injected service instance

Fields inherited from interface org.apache.turbine.modules.Layout

CACHE_SIZE_DEFAULT, CACHE_SIZE_KEY, NAME, PREFIX

Constructor Summary

Constructors

Constructor	Description
VelocityLayout()

Method Summary

Modifier and Type	Method	Description
void	doBuild(PipelineData pipelineData)	Method called by LayoutLoader.
protected abstract void	populateContext(PipelineData pipelineData, org.apache.velocity.context.Context context)	Populate Velocity context
protected void	render(PipelineData pipelineData, org.apache.velocity.context.Context context, String templateName)	Render layout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.turbine.modules.Layout

build

Field Detail

log

protected final org.apache.logging.log4j.Logger log

Logging

prefix

protected static final String prefix

The prefix for lookup up layout pages

See Also:

Constant Field Values

velocityService

protected VelocityService velocityService

Injected service instance

Constructor Detail

VelocityLayout

public VelocityLayout()

Method Detail

doBuild

public void doBuild(PipelineData pipelineData)
             throws Exception

Method called by LayoutLoader.

Specified by:

doBuild in interface Layout

Parameters:

pipelineData - PipelineData

Throws:

Exception - generic exception

populateContext

protected abstract void populateContext(PipelineData pipelineData,
                                        org.apache.velocity.context.Context context)
                                 throws Exception

Populate Velocity context

Parameters:

pipelineData - PipelineData

context - the Velocity context

Throws:

Exception - if evaluation fails

render

protected void render(PipelineData pipelineData,
                      org.apache.velocity.context.Context context,
                      String templateName)
               throws Exception

Render layout

Parameters:

pipelineData - PipelineData

context - the Velocity context

templateName - relative path to Velocity template

Throws:

Exception - if rendering fails