org.apache.turbine.modules.actions
Class WebMacroSiteAction

java.lang.Object
  |
  +--org.apache.turbine.modules.Assembler
        |
        +--org.apache.turbine.modules.Action
              |
              +--org.apache.turbine.modules.ActionEvent
                    |
                    +--org.apache.turbine.util.webmacro.WebMacroActionEvent
                          |
                          +--org.apache.turbine.modules.actions.WebMacroSiteAction
Direct Known Subclasses:
WebMacroSiteSecureAction

Deprecated. you should use velocity

public abstract class WebMacroSiteAction
extends WebMacroActionEvent

This class provides a convenience methods for WebMacroSite Actions to use. Since this class is abstract, it should only be extended and not used directly.

Version:
$Id: WebMacroSiteAction.java,v 1.1.1.1 2001/08/16 05:08:31 jvanzyl Exp $
Author:
Jon S. Stevens

Fields inherited from class org.apache.turbine.modules.ActionEvent
BUTTON, BUTTON_LENGTH, LENGTH, METHOD_NAME_LENGTH, METHOD_NAME_PREFIX
 
Constructor Summary
WebMacroSiteAction()
          Deprecated.  
 
Method Summary
 void doPerform(RunData data)
          Deprecated. You SHOULD NOT override this method and implement it in your action.
abstract  void doPerform(RunData data, org.webmacro.servlet.WebContext context)
          Deprecated. You SHOULD override this method and implement it in your action.
protected  org.webmacro.servlet.WebContext getContext(RunData data)
          Deprecated. Return the WebContext needed by WebMacro.
protected  void perform(RunData data)
          Deprecated. Sets up the context and then calls super.perform(); thus, subclasses don't have to worry about getting a context themselves!
 void setTemplate(RunData data, java.lang.String template)
          Deprecated. This method is used when you want to short circuit an Action and change the template that will be executed next.
 
Methods inherited from class org.apache.turbine.util.webmacro.WebMacroActionEvent
executeEvents
 
Methods inherited from class org.apache.turbine.modules.ActionEvent
executeEvents, formatString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebMacroSiteAction

public WebMacroSiteAction()
Deprecated. 
Method Detail

doPerform

public void doPerform(RunData data)
               throws java.lang.Exception
Deprecated. 
You SHOULD NOT override this method and implement it in your action.
Overrides:
doPerform in class WebMacroActionEvent
Parameters:
data - Turbine information.
Throws:
Exception, - a generic exception.

doPerform

public abstract void doPerform(RunData data,
                               org.webmacro.servlet.WebContext context)
                        throws java.lang.Exception
Deprecated. 
You SHOULD override this method and implement it in your action.
Parameters:
data - Turbine information.
context - Context for web pages.
Throws:
Exception, - a generic exception.

perform

protected void perform(RunData data)
                throws java.lang.Exception
Deprecated. 
Sets up the context and then calls super.perform(); thus, subclasses don't have to worry about getting a context themselves!
Overrides:
perform in class WebMacroActionEvent
Parameters:
data - Turbine information.
Throws:
Exception, - a generic exception.

setTemplate

public void setTemplate(RunData data,
                        java.lang.String template)
Deprecated. 
This method is used when you want to short circuit an Action and change the template that will be executed next.
Parameters:
data - Turbine information.
template - The template that will be executed next.

getContext

protected org.webmacro.servlet.WebContext getContext(RunData data)
Deprecated. 
Return the WebContext needed by WebMacro. This is first setup in the WebMacroSitePage.
Parameters:
RunData - data
Returns:
WebContext, a context for web pages.


Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.