org.apache.turbine.util.template

## Class TemplateScreen

- java.lang.Object
- - org.apache.turbine.util.template.TemplateScreen

-     public class TemplateScreen
      extends Object

  Returns output of a Screen module. An instance of this is placed in the Velocity context by the VelocityDirectLayout. This allows the screen to be executed only at rendering. Here's how it's used in a template:

  `$screen_placeholder`

  `$screen_placeholder.setScreen("Test")`

  Version:
    $Id: TemplateScreen.java 1723699 2016-01-08 11:29:21Z tv $
  Author:
    Raphaël Luta

- - ### Constructor Summary

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

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `TemplateScreen` | `setScreen(String screen)` Set the screen.
    `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

    - #### TemplateScreen

          public TemplateScreen(RunData data)

      Constructor
      Parameters:
        `data` - A Turbine RunData object.

  - ### Method Detail

    - #### setScreen

          public TemplateScreen setScreen(String screen)

      Set the screen.
      Parameters:
        `screen` - A String with the name of the screen module
      Returns:
        A TemplateScreen (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.