Java Doc for ActionEvent.java in  » Web-Framework » TURBINE » org » apache » turbine » modules » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Web Framework » TURBINE » org.apache.turbine.modules 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.turbine.modules.Assembler
      org.apache.turbine.modules.Action
         org.apache.turbine.modules.ActionEvent

All known Subclasses:   org.apache.turbine.util.velocity.VelocityActionEvent,  org.apache.turbine.util.jsp.JspActionEvent,
ActionEvent
abstract public class ActionEvent extends Action (Code)

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:

  • The variable name MUST have the prefix "eventSubmit_".
  • The variable name after the prefix MUST begin with the letters "do".
  • The first letter after the "do" will be capitalized and the rest will be lowercase
If you follow these conventions, then you should be ok with your method naming in your Action class.
author:
   Jon S. Stevens
author:
   Henning P. Schmiedehausen
author:
   Quinton McCombs
version:
   $Id: ActionEvent.java 534527 2007-05-02 16:10:59Z tv $


Field Summary
final protected static  StringBUTTON
     The name of the button to look for.
final protected static  intBUTTON_LENGTH
     The length of the button to look for.
final protected static  intLENGTH
     The length of the button to look for.
final protected static  intMETHOD_NAME_LENGTH
     The length of the method name.
final protected static  StringMETHOD_NAME_PREFIX
     The prefix of the method name.
protected  Loglog
    

Constructor Summary
public  ActionEvent()
    

Method Summary
protected  booleanconsiderKey(String key, ParameterParser pp)
     Checks whether the selected key really is a valid event.
abstract public  voiddoPerform(RunData data)
     You need to implement this in your classes that extend this class.
public  voidexecuteEvents(RunData data)
     This method should be called to execute the event based system.
final protected  StringformatString(String input)
     This method does the conversion of the lowercase method name into the proper case.
Parameters:
  input - The unconverted method name.
protected  voidperform(RunData data)
     This overrides the default Action.perform() to execute the doEvent() method.

Field Detail
BUTTON
final protected static String BUTTON(Code)
The name of the button to look for.



BUTTON_LENGTH
final protected static int BUTTON_LENGTH(Code)
The length of the button to look for.



LENGTH
final protected static int LENGTH(Code)
The length of the button to look for.



METHOD_NAME_LENGTH
final protected static int METHOD_NAME_LENGTH(Code)
The length of the method name.



METHOD_NAME_PREFIX
final protected static String METHOD_NAME_PREFIX(Code)
The prefix of the method name.



log
protected Log log(Code)
Logging




Constructor Detail
ActionEvent
public ActionEvent()(Code)
C'tor




Method Detail
considerKey
protected boolean considerKey(String key, ParameterParser pp)(Code)
Checks whether the selected key really is a valid event.
Parameters:
  key - The selected key
Parameters:
  pp - The parameter parser to look for the key value true if this key is really an ActionEvent Key



doPerform
abstract public void doPerform(RunData data) throws Exception(Code)
You need to implement this in your classes that extend this class.
Parameters:
  data - Turbine information.
exception:
  Exception - a generic exception.



executeEvents
public void executeEvents(RunData data) throws Exception(Code)
This method should be called to execute the event based system.
Parameters:
  data - Turbine information.
exception:
  Exception - a generic exception.



formatString
final protected String formatString(String input)(Code)
This method does the conversion of the lowercase method name into the proper case.
Parameters:
  input - The unconverted method name. A string with the method name in the proper case.



perform
protected void perform(RunData data) throws Exception(Code)
This overrides the default Action.perform() to execute the doEvent() method. If that fails, then it will execute the doPerform() method instead.
Parameters:
  data - Turbine information.
exception:
  Exception - a generic exception.



Methods inherited from org.apache.turbine.modules.Action
abstract public void doPerform(RunData data) throws Exception(Code)(Java Doc)
protected void perform(RunData data) throws Exception(Code)(Java Doc)


Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.