org.apache.turbine.modules.screens
Class WebMacroSiteScreen

java.lang.Object
  |
  +--org.apache.turbine.modules.Assembler
        |
        +--org.apache.turbine.modules.Screen
              |
              +--org.apache.turbine.modules.screens.TemplateScreen
                    |
                    +--org.apache.turbine.modules.screens.WebMacroSiteScreen

Direct Known Subclasses:

WebMacroSiteErrorScreen, WebMacroSiteSecureScreen

Deprecated. you should use velocity

public class WebMacroSiteScreen

extends TemplateScreen

Base WebMacro Screen. This screen relies on the WebMacroSitePage being set as the default page. This screen can be called directly to generate a WebMacro Screen. The buildTemplate() assumes the template parameter has been set in the RunData object (a default template is specified in the WebMacroSitePage). This provides the ability to execute several templates from one Screen.

If you need more specific behavior in your application, extend this class and override the doBuildTemplate() method.

Version:

$Id: WebMacroSiteScreen.java,v 1.1.1.1 2001/08/16 05:08:38 jvanzyl Exp $

Author:

Dave Bryson

Constructor Summary

WebMacroSiteScreen()
Deprecated.

Method Summary

org.apache.ecs.ConcreteElement	buildTemplate(RunData data) Deprecated. This builds the WebMacro template.
protected java.lang.String	buildWMTemplate(org.webmacro.servlet.WebContext context, java.lang.String templateFile) Deprecated. TurbineWebMacro.handleRequest(context,templateFile) the template.
protected void	doBuildTemplate(RunData data) Deprecated. Needs to be implemented to make TemplateScreen like us.
protected void	doBuildTemplate(RunData data, org.webmacro.servlet.WebContext context) Deprecated. WebMacro Screens extending this class should overide this method to perform any particular business logic and add information to the context.
static org.webmacro.servlet.WebContext	getContext(RunData data) Deprecated. Return the WebContext needed by WebMacro.

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, prepareText, prepareTextMinimum, setLayout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebMacroSiteScreen

public WebMacroSiteScreen()

Deprecated.

Method Detail

doBuildTemplate

protected void doBuildTemplate(RunData data,
                               org.webmacro.servlet.WebContext context)
                        throws java.lang.Exception

Deprecated.

WebMacro Screens extending this class should overide this method to perform any particular business logic and add information to the context.

Parameters:

data - Turbine information.

context - Context for web pages.

Throws:

Exception, - a generic exception.

java.lang.Exception

doBuildTemplate

protected void doBuildTemplate(RunData data)
                        throws java.lang.Exception

Deprecated.

Needs to be implemented to make TemplateScreen like us. The actual method that you should override is the one with the context in the parameter list.

Specified by:

doBuildTemplate in class TemplateScreen

Parameters:

data - Turbine information.

Throws:

Exception, - a generic exception.

java.lang.Exception

buildTemplate

public org.apache.ecs.ConcreteElement buildTemplate(RunData data)
                                             throws java.lang.Exception

Deprecated.

This builds the WebMacro template.

Specified by:

buildTemplate in class TemplateScreen

Parameters:

data - Turbine information.

Returns:

A ConcreteElement.

Throws:

Exception, - a generic exception.

java.lang.Exception

getContext

public static org.webmacro.servlet.WebContext getContext(RunData data)

Deprecated.

Return the WebContext needed by WebMacro.

Parameters:

data - Turbine information.

Returns:

A WebContext.

buildWMTemplate

protected java.lang.String buildWMTemplate(org.webmacro.servlet.WebContext context,
                                           java.lang.String templateFile)
                                    throws java.lang.Exception

Deprecated.

TurbineWebMacro.handleRequest(context,templateFile) the template. This will return a string containing the processed template file.

Parameters:

context - Context for web apps.

templateFile - Name of template file.

Returns:

A String with the processed template file.

Throws:

Exception, - a generic exception.

java.lang.Exception