|
||||||||||
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
public abstract class ActionEvent
This is an alternative to the Action class that allows you to do event based actions. Essentially, you label all your submit buttons with the prefix of "eventSubmit_" and the suffix of "methodName". For example, "eventSubmit_doDelete". Then any class that subclasses this class will get its "doDelete(RunData data)" method executed. If for any reason, it was not able to execute the method, it will fall back to executing the doPeform() method which is required to be implemented.
Limitations:
Because ParameterParser makes all the key values lowercase, we have to do some work to format the string into a method name. For example, a button name eventSubmit_doDelete gets converted into eventsubmit_dodelete. Thus, we need to form some sort of naming convention so that dodelete can be turned into doDelete.
Thus, the convention is this:
Field Summary | |
---|---|
protected boolean |
bubbleUpException
If true, then exceptions raised in eventSubmit_do |
protected static String |
BUTTON
The name of the button to look for. |
protected static int |
BUTTON_LENGTH
The length of the button to look for. |
protected static int |
LENGTH
The length of the button to look for. |
protected org.apache.commons.logging.Log |
log
Logging |
protected static int |
METHOD_NAME_LENGTH
The length of the method name. |
protected static String |
METHOD_NAME_PREFIX
The prefix of the method name. |
Fields inherited from class org.apache.turbine.modules.Action |
---|
CACHE_SIZE_DEFAULT, CACHE_SIZE_KEY, NAME, PREFIX |
Constructor Summary | |
---|---|
ActionEvent()
C'tor |
Method Summary | |
---|---|
protected boolean |
considerKey(String key,
org.apache.fulcrum.parser.ParameterParser pp)
Checks whether the selected key really is a valid event. |
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)
This method should be called to execute the event based system. |
void |
executeEvents(RunData data)
Deprecated. Use PipelineData version instead. |
protected String |
formatString(String input,
org.apache.fulcrum.parser.ParameterParser pp)
This method does the conversion of the lowercase method name into the proper case. |
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.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 org.apache.commons.logging.Log log
protected static final String BUTTON
protected static final int BUTTON_LENGTH
protected static final String METHOD_NAME_PREFIX
protected static final int METHOD_NAME_LENGTH
protected static final int LENGTH
protected boolean bubbleUpException
Constructor Detail |
---|
public ActionEvent()
Method Detail |
---|
@Deprecated public abstract void doPerform(RunData data) throws Exception
doPerform
in class Action
data
- Turbine information.
Exception
- a generic exception.public void doPerform(PipelineData pipelineData) throws Exception
doPerform
in class Action
data
- Turbine information.
Exception
- a generic exception.@Deprecated protected void perform(RunData data) throws Exception
perform
in class Action
data
- Turbine information.
Exception
- a generic exception.protected void perform(PipelineData pipelineData) throws Exception
perform
in class Action
data
- Turbine information.
Exception
- a generic exception.@Deprecated public void executeEvents(RunData data) throws Exception
data
- Turbine information.
Exception
- a generic exception.public void executeEvents(PipelineData pipelineData) throws Exception
data
- Turbine information.
Exception
- a generic exception.protected final String formatString(String input, org.apache.fulcrum.parser.ParameterParser pp)
input
- The unconverted method name.pp
- The parameter parser (for correct folding)
protected boolean considerKey(String key, org.apache.fulcrum.parser.ParameterParser pp)
key
- The selected keypp
- The parameter parser to look for the key value
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |