Package org.apache.turbine.util.template

Class TemplateNavigation

java.lang.Object

org.apache.turbine.util.template.TemplateNavigation

public class TemplateNavigation
extends Object

Returns output of a Navigation module. An instance of this is placed in the WebMacro context by the WebMacroSiteLayout. This allows template authors to set the navigation template they'd like to place in their templates. Here's how it's used in a template:

$navigation.setTemplate("admin_navigation.wm")

Version:

$Id$

Author:

Dave Bryson

Constructor Summary

Constructors

Constructor	Description
TemplateNavigation(PipelineData pipelineData)	Constructor

Method Summary

Modifier and Type	Method	Description
TemplateNavigation	setTemplate(String template)	Set the template.
String	toString()	Builds the output of the navigation template.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateNavigation

public TemplateNavigation(PipelineData pipelineData)

Constructor

Parameters:

pipelineData - A Turbine PipelineData object.

Method Detail

setTemplate

public TemplateNavigation setTemplate(String template)

Set the template.

Parameters:

template - A String with the name of the navigation template.

Returns:

A TemplateNavigation (self).

toString

public String toString()

Builds the output of the navigation template.

Overrides:

toString in class Object

Returns:

A String.