BaseJspScreen (Apache Turbine 4.0.2-SNAPSHOT API)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.turbine.modules.Assembler
- - org.apache.turbine.modules.Screen
  - - org.apache.turbine.modules.screens.TemplateScreen
    - - org.apache.turbine.modules.screens.BaseJspScreen

Direct Known Subclasses:

JspErrorScreen
```
public class BaseJspScreen
extends TemplateScreen
```
Base JSP Screen that should be subclassed by screens that want to use JSP. Subclasses should override the doBuildTemplate() method.

Version:

$Id: BaseJspScreen.java 1773378 2016-12-09 13:19:59Z tv $

Author:

John D. McNally, Frank Y. Kim, Henning P. Schmiedehausen, Peter Courcoux

Field Summary
- Fields inherited from class org.apache.turbine.modules.screens.TemplateScreen
  log
- Fields inherited from class org.apache.turbine.modules.Screen
  CACHE_SIZE_DEFAULT, CACHE_SIZE_KEY, NAME, PREFIX

Constructor Summary

Constructors
Constructor and Description

BaseJspScreen()

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`buildTemplate(PipelineData pipelineData)` Method that sets up beans and forward the request to the JSP.
`protected void`	`doBuildTemplate(PipelineData pipelineData)` Method to be overridden by subclasses to include data in beans, etc.

Methods inherited from class org.apache.turbine.modules.screens.TemplateScreen
doBuild, doPostBuildTemplate, doRedirect, doRedirect, setTemplate

Methods inherited from class org.apache.turbine.modules.Screen
build, getLayout, getPrefix, setLayout

Methods inherited from class org.apache.turbine.modules.Assembler
getRunData

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BaseJspScreen
```
public BaseJspScreen()
```
- Method Detail
  - buildTemplate
```
public String buildTemplate(PipelineData pipelineData)
                     throws Exception
```
    Method that sets up beans and forward the request to the JSP.
    
    Specified by:
    
    buildTemplate in class TemplateScreen
    
    Parameters:
    pipelineData - Turbine information.
    
    Returns:
    null - the JSP sends the information.
    
    Throws:
    
    Exception - a generic exception.
  - doBuildTemplate
```
protected void doBuildTemplate(PipelineData pipelineData)
                        throws Exception
```
    Method to be overridden by subclasses to include data in beans, etc.
    
    Specified by:
    
    doBuildTemplate in class TemplateScreen
    
    Parameters:
    pipelineData - the PipelineData object
    
    Throws:
    
    Exception - a generic exception.

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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