|
||||||||||
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
public abstract class VelocityActionEvent
If you are using VelocitySite stuff, then your Action's should extend this class instead of extending the ActionEvent class. The difference between this class and the ActionEvent class is that this class will first attempt to execute one of your doMethod's with a constructor like this:
doEvent(RunData data, Context context)
It gets the context from the TemplateInfo.getTemplateContext() method. If it can't find a method like that, then it will try to execute the method without the Context in it.
Field Summary | |
---|---|
protected boolean |
initialized
Indicates whether or not this module has been 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 | |
---|---|
VelocityActionEvent()
|
Method Summary | |
---|---|
void |
doPerform(PipelineData pipelineData)
You need to implement this in your classes that extend this class. |
abstract void |
doPerform(RunData data)
Deprecated. Use PipelineData version instead. |
void |
executeEvents(PipelineData pipelineData,
org.apache.velocity.context.Context context)
This method should be called to execute the event based system. |
void |
executeEvents(RunData data,
org.apache.velocity.context.Context context)
Deprecated. Use PipelineData version instead. |
protected abstract void |
initialize()
Provides a means of initializing the module. |
protected void |
perform(PipelineData pipelineData)
This overrides the default Action.perform() to execute the doEvent() method. |
protected void |
perform(RunData data)
Deprecated. Use PipelineData version instead. |
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 |
Field Detail |
---|
protected boolean initialized
Constructor Detail |
---|
public VelocityActionEvent()
Method Detail |
---|
@Deprecated public abstract void doPerform(RunData data) throws Exception
doPerform
in class ActionEvent
data
- A Turbine RunData object.
Exception
- a generic exception.public void doPerform(PipelineData pipelineData) throws Exception
doPerform
in class ActionEvent
data
- Turbine information.
Exception
- a generic exception.protected abstract void initialize() throws Exception
Exception
- a generic exception.@Deprecated protected void perform(RunData data) throws Exception
perform
in class ActionEvent
data
- A Turbine RunData object.
Exception
- a generic exception.protected void perform(PipelineData pipelineData) throws Exception
perform
in class ActionEvent
data
- A Turbine RunData object.
Exception
- a generic exception.@Deprecated public void executeEvents(RunData data, org.apache.velocity.context.Context context) throws Exception
data
- A Turbine RunData object.context
- Velocity context information.
Exception
- a generic exception.public void executeEvents(PipelineData pipelineData, org.apache.velocity.context.Context context) throws Exception
data
- A Turbine RunData object.context
- Velocity context information.
Exception
- a generic exception.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |