|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.turbine.modules.Assembler
org.apache.turbine.modules.Action
org.apache.turbine.modules.ActionEvent
org.apache.turbine.util.velocity.VelocityActionEvent
org.apache.turbine.modules.actions.VelocityAction
public abstract class VelocityAction
This class provides a convenience methods for Velocity Actions to use. Since this class is abstract, it should only be extended and not used directly.
Field Summary |
---|
Fields inherited from class org.apache.turbine.util.velocity.VelocityActionEvent |
---|
initialized |
Fields inherited from class org.apache.turbine.modules.ActionEvent |
---|
bubbleUpException, BUTTON, BUTTON_LENGTH, LENGTH, log, METHOD_NAME_LENGTH, METHOD_NAME_PREFIX |
Fields inherited from class org.apache.turbine.modules.Action |
---|
CACHE_SIZE_DEFAULT, CACHE_SIZE_KEY, NAME, PREFIX |
Constructor Summary | |
---|---|
VelocityAction()
|
Method Summary | |
---|---|
void |
doPerform(PipelineData pipelineData)
You SHOULD NOT override this method and implement it in your action. |
void |
doPerform(PipelineData pipelineData,
org.apache.velocity.context.Context context)
You SHOULD override this method and implement it in your action. |
void |
doPerform(RunData data)
Deprecated. Use PipelineData version instead. |
abstract void |
doPerform(RunData data,
org.apache.velocity.context.Context context)
Deprecated. Use PipelineData version instead. |
protected org.apache.velocity.context.Context |
getContext(PipelineData pipelineData)
Return the Context needed by Velocity. |
protected org.apache.velocity.context.Context |
getContext(RunData data)
Deprecated. Use PipelineData version instead. |
void |
initialize()
Initialize the module. |
protected void |
perform(PipelineData pipelineData)
Sets up the context and then calls super.perform(); thus, subclasses don't have to worry about getting a context themselves! |
protected void |
perform(RunData data)
Deprecated. Use PipelineData version instead. |
void |
setTemplate(PipelineData pipelineData,
String template)
This method is used when you want to short circuit an Action and change the template that will be executed next. |
void |
setTemplate(RunData data,
String template)
Deprecated. Use PipelineData version instead. |
Methods inherited from class org.apache.turbine.util.velocity.VelocityActionEvent |
---|
executeEvents, executeEvents |
Methods inherited from class org.apache.turbine.modules.ActionEvent |
---|
considerKey, executeEvents, executeEvents, formatString |
Methods inherited from class org.apache.turbine.modules.Action |
---|
getPrefix |
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 |
---|
public VelocityAction()
Method Detail |
---|
@Deprecated public void doPerform(RunData data) throws Exception
doPerform
in class VelocityActionEvent
data
- Turbine information.
Exception
- a generic exception.public void doPerform(PipelineData pipelineData) throws Exception
doPerform
in class VelocityActionEvent
data
- Turbine information.
Exception
- a generic exception.public void initialize() throws Exception
initialize
in class VelocityActionEvent
Exception
- a generic exception.@Deprecated public abstract void doPerform(RunData data, org.apache.velocity.context.Context context) throws Exception
data
- Turbine information.context
- Context for web pages.
Exception
- a generic exception.public void doPerform(PipelineData pipelineData, org.apache.velocity.context.Context context) throws Exception
data
- Turbine information.context
- Context for web pages.
Exception
- a generic exception.@Deprecated protected void perform(RunData data) throws Exception
perform
in class VelocityActionEvent
data
- Turbine information.
Exception
- a generic exception.protected void perform(PipelineData pipelineData) throws Exception
perform
in class VelocityActionEvent
data
- Turbine information.
Exception
- a generic exception.@Deprecated public void setTemplate(RunData data, String template)
data
- Turbine information.template
- The template that will be executed next.public void setTemplate(PipelineData pipelineData, String template)
data
- Turbine information.template
- The template that will be executed next.@Deprecated protected org.apache.velocity.context.Context getContext(RunData data)
data
- Turbine information.
protected org.apache.velocity.context.Context getContext(PipelineData pipelineData)
data
- Turbine information.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |