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
- 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$
- Author:
- Jon S. Stevens
Method Summary |
void |
doPerform(RunData data)
You SHOULD NOT override this method and implement it in your
action. |
abstract void |
doPerform(RunData data,
org.webmacro.servlet.WebContext context)
You SHOULD override this method and implement it in your
action. |
protected org.webmacro.servlet.WebContext |
getContext(RunData data)
Return the WebContext needed by WebMacro. |
protected void |
perform(RunData data)
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)
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 java.lang.Object |
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait |
WebMacroSiteAction
public WebMacroSiteAction()
doPerform
public void doPerform(RunData data)
throws java.lang.Exception
- 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
- 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
- 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)
- 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)
- Return the WebContext needed by WebMacro. This is first setup
in the WebMacroSitePage.
- Parameters:
RunData
- data- Returns:
- WebContext, a context for web pages.
Copyright © 1999-2001 Apache Software Foundation. All Rights Reserved.