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.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: TemplateNavigation.java 615328 2008-01-25 20:25:05Z tv $
Author:
  Dave Bryson

Constructor Summary
`TemplateNavigation(RunData data)` Constructor

Method Summary
`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(RunData data)

  Constructor

  Parameters:
    `data` - A Turbine RunData 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.

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.