org.apache.turbine.modules.navigations
Class WebMacroSiteNavigation

java.lang.Object
  |
  +--org.apache.turbine.modules.Assembler
        |
        +--org.apache.turbine.modules.Navigation
              |
              +--org.apache.turbine.modules.navigations.TemplateNavigation
                    |
                    +--org.apache.turbine.modules.navigations.WebMacroSiteNavigation

public class WebMacroSiteNavigation

extends TemplateNavigation

WebMacroSiteNavigation. This screen relies on the WebMacroSitePage being set as the default page. This screen can be called directly to generate a WebMacro Screen. The doBuildTemplate() assumes the user has put the template filename in the RunData parameter and set it to the value of the template file to execute. Specialized Navigations screens should extend this class and overide the doBuildTemplate( data , context) method.

Version:

$Id: WebMacroSiteNavigation.java,v 1.6.10.6 2001/06/01 01:33:18 jvanzyl Exp $

Author:

Dave Bryson

Constructor Summary

WebMacroSiteNavigation()

Method Summary

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

Methods inherited from class org.apache.turbine.modules.navigations.TemplateNavigation

doBuild

Methods inherited from class org.apache.turbine.modules.Navigation

build, prepareText

Methods inherited from class java.lang.Object

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

Constructor Detail

WebMacroSiteNavigation

public WebMacroSiteNavigation()

Method Detail

doBuildTemplate

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

WebMacro Navigations 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

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

Specified by:

doBuildTemplate in class TemplateNavigation

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

This Builds the WebMacro template.

Specified by:

buildTemplate in class TemplateNavigation

Parameters:

data - Turbine information.

Returns:

A ConcreteElement.

Throws:

Exception, - a generic exception.

java.lang.Exception

getContext

protected org.webmacro.servlet.WebContext getContext(RunData data)

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

Build WM template.

Parameters:

context - A WebContext.

templateFile - A String, the name of the template file.

Returns:

A String with the processed template.

Throws:

Exception, - a generic exception.

java.lang.Exception