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 1723699 2016-01-08 11:29:21Z tv $
  Author:
    Dave Bryson

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `TemplateNavigation(RunData data)` Constructor

  - ### Method Summary

    Methods
    Modifier and Type | Method and 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(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.

Copyright © 2000–2018 The Apache Software Foundation. All rights reserved.