org.apache.turbine.modules.navigations
Class VelocityNavigation

java.lang.Object
  org.apache.turbine.modules.Assembler
      org.apache.turbine.modules.Navigation
          org.apache.turbine.modules.navigations.TemplateNavigation
              org.apache.turbine.modules.navigations.VelocityNavigation

public class VelocityNavigation

extends TemplateNavigation

VelocityNavigation. This screen relies on the VelocityPage being set as the default page. The doBuildTemplate() assumes the user has put the template filename in the RunData parameter and set it to the value of the template file to execute. Specialized Navigations screens should extend this class and overide the doBuildTemplate( data , context) method.

Version:

$Id: VelocityNavigation.java 534527 2007-05-02 16:10:59Z tv $

Author:

Dave Bryson, Henning P. Schmiedehausen

Constructor Summary

VelocityNavigation()

Method Summary

org.apache.ecs.ConcreteElement	buildTemplate(RunData data) This Builds the Velocity template.
protected void	doBuildTemplate(RunData data) Needs to be implemented to make TemplateNavigation like us.
protected void	doBuildTemplate(RunData data, org.apache.velocity.context.Context context) Velocity Navigations extending this class should overide this method to perform any particular business logic and add information to the context.

Methods inherited from class org.apache.turbine.modules.navigations.TemplateNavigation

doBuild

Methods inherited from class org.apache.turbine.modules.Navigation

build, prepareText

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityNavigation

public VelocityNavigation()

Method Detail

doBuildTemplate

protected void doBuildTemplate(RunData data,
                               org.apache.velocity.context.Context context)
                        throws java.lang.Exception

Velocity Navigations extending this class should overide this method to perform any particular business logic and add information to the context.

Parameters:

data - Turbine information.

context - Context for web pages.

Throws:

Exception, - a generic exception.

java.lang.Exception

doBuildTemplate

protected void doBuildTemplate(RunData data)
                        throws java.lang.Exception

Needs to be implemented to make TemplateNavigation like us. The actual method that you should override is the one with the context in the parameter list.

Specified by:

doBuildTemplate in class TemplateNavigation

Parameters:

data - Turbine information.

Throws:

Exception, - a generic exception.

java.lang.Exception - a generic exception.

buildTemplate

public org.apache.ecs.ConcreteElement buildTemplate(RunData data)
                                             throws java.lang.Exception

This Builds the Velocity template.

Specified by:

buildTemplate in class TemplateNavigation

Parameters:

data - Turbine information.

Returns:

A ConcreteElement.

Throws:

Exception, - a generic exception.

java.lang.Exception - a generic exception.