org.apache.turbine.util.template
Class TemplateNavigation

java.lang.Object
  org.apache.turbine.util.template.TemplateNavigation

public class TemplateNavigation

extends java.lang.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: TemplateNavigation.java 534527 2007-05-02 16:10:59Z tv $

Author:

Dave Bryson

Constructor Summary

TemplateNavigation(RunData data)
Constructor

Method Summary

TemplateNavigation	setTemplate(java.lang.String template) Set the template.
java.lang.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(RunData data)

Constructor

Parameters:

data - A Turbine RunData object.

Method Detail

setTemplate

public TemplateNavigation setTemplate(java.lang.String template)

Set the template.

Parameters:

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

Returns:

A TemplateNavigation (self).

toString

public java.lang.String toString()

Builds the output of the navigation template.

Returns:

A String.