Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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 override the doBuildTemplate( data , context) method.

Version:
  $Id: VelocityNavigation.java 1078552 2011-03-06 19:58:46Z tv $
Author:
  Dave Bryson, Henning P. Schmiedehausen, Peter Courcoux

Field Summary

Fields inherited from class org.apache.turbine.modules.Navigation
`CACHE_SIZE_DEFAULT, CACHE_SIZE_KEY, NAME, PREFIX`

Constructor Summary
`VelocityNavigation()`

Method Summary
`org.apache.ecs.ConcreteElement` | `buildTemplate(PipelineData pipelineData)` This Builds the Velocity template.
`org.apache.ecs.ConcreteElement` | `buildTemplate(RunData data)` Deprecated. Use PipelineData version instead.
`protected void` | `doBuildTemplate(PipelineData pipelineData)` Needs to be implemented to make TemplateNavigation like us.
`protected void` | `doBuildTemplate(PipelineData pipelineData, 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.
`protected void` | `doBuildTemplate(RunData data)` Deprecated. Use PipelineData version instead.
`protected void` | `doBuildTemplate(RunData data, org.apache.velocity.context.Context context)` Deprecated. Use PipelineData version instead.

Methods inherited from class org.apache.turbine.modules.navigations.TemplateNavigation
`doBuild, doBuild`

Methods inherited from class org.apache.turbine.modules.Navigation
`build, build, getPrefix, prepareText`

Methods inherited from class org.apache.turbine.modules.Assembler
`getRunData`

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

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

  Deprecated. Use PipelineData version instead.

  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.
    `Exception`

### doBuildTemplate

    protected void doBuildTemplate(PipelineData pipelineData,
                                   org.apache.velocity.context.Context context)
                            throws 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.
    `Exception`

### doBuildTemplate

    @Deprecated
    protected void doBuildTemplate(RunData data)
                            throws Exception

  Deprecated. Use PipelineData version instead.

  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.
    `Exception` - a generic exception.

### doBuildTemplate

    protected void doBuildTemplate(PipelineData pipelineData)
                            throws 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.

  Overrides:
    `doBuildTemplate` in class `TemplateNavigation`
  Parameters:
    `pipelineData` - Turbine information.
  Throws:
    `Exception,` - a generic exception.
    `Exception` - a generic exception.

### buildTemplate

    @Deprecated
    public org.apache.ecs.ConcreteElement buildTemplate(RunData data)
                                                 throws Exception

  Deprecated. Use PipelineData version instead.

  This Builds the Velocity template.

  Specified by:
    `buildTemplate` in class `TemplateNavigation`
  Parameters:
    `data` - Turbine information.
  Returns:
    A ConcreteElement.
  Throws:
    `Exception,` - a generic exception.
    `Exception` - a generic exception.

### buildTemplate

    public org.apache.ecs.ConcreteElement buildTemplate(PipelineData pipelineData)
                                                 throws Exception

  This Builds the Velocity template.

  Overrides:
    `buildTemplate` in class `TemplateNavigation`
  Parameters:
    `data` - Turbine information.
  Returns:
    A ConcreteElement.
  Throws:
    `Exception,` - a generic exception.
    `Exception` - a generic exception.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2011 The Apache Software Foundation. All Rights Reserved.