Java Doc for VelocityManager.java in  » J2EE » webwork-2.2.6 » com » opensymphony » webwork » views » velocity » 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 » J2EE » webwork 2.2.6 » com.opensymphony.webwork.views.velocity 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.opensymphony.webwork.views.velocity.VelocityManager

VelocityManager
public class VelocityManager (Code)
Manages the environment for Velocity result types
author:
   Matt Ho


Field Summary
final public static  StringPARENT
    
final public static  StringTAG
    
final public static  StringWEBWORK
    
protected  ToolboxManagertoolboxManager
     A reference to the toolbox manager.

Constructor Summary
protected  VelocityManager()
    

Method Summary
public  ContextcreateContext(OgnlValueStack stack, HttpServletRequest req, HttpServletResponse res)
     This method is responsible for creating the standard VelocityContext used by all WW2 velocity views.
public static synchronized  VelocityManagergetInstance()
    
public  VelocityEnginegetVelocityEngine()
    
public  PropertiesgetVelocityProperties()
    
public synchronized  voidinit(ServletContext context)
     initializes the VelocityManager.
protected  voidinit()
    
protected  voidinitChainedContexts()
     allow users to specify via the webwork.properties file a set of additional VelocityContexts to chain to the the WebWorkVelocityContext.
protected  voidinitToolbox(ServletContext context)
     Initializes the ServletToolboxManager for this servlet's toolbox (if any).
public  PropertiesloadConfiguration(ServletContext context)
     load optional velocity properties using the following loading strategy
  • relative to the servlet context path
  • relative to the WEB-INF directory
  • on the classpath

Parameters:
  context - the current ServletContext.
protected  VelocityEnginenewVelocityEngine(ServletContext context)
    

Instantiates a new VelocityEngine.

The following is the default Velocity configuration

 resource.loader = file, class
 file.resource.loader.path = real path of webapp
 class.resource.loader.description = Velocity Classpath Resource Loader
 class.resource.loader.class = com.opensymphony.webwork.views.velocity.WebWorkResourceLoader
 

this default configuration can be overridden by specifying a webwork.velocity.configfile property in the webwork.properties file.

protected  VelocityContext[]prepareChainedContexts(HttpServletRequest servletRequest, HttpServletResponse servletResponse, Map extraContext)
     constructs contexts for chaining on this request.
public  voidsetVelocityProperties(Properties velocityProperties)
    

Field Detail
PARENT
final public static String PARENT(Code)
the parent JSP tag



TAG
final public static String TAG(Code)
the current JSP tag



WEBWORK
final public static String WEBWORK(Code)



toolboxManager
protected ToolboxManager toolboxManager(Code)
A reference to the toolbox manager.




Constructor Detail
VelocityManager
protected VelocityManager()(Code)




Method Detail
createContext
public Context createContext(OgnlValueStack stack, HttpServletRequest req, HttpServletResponse res)(Code)
This method is responsible for creating the standard VelocityContext used by all WW2 velocity views. The following context parameters are defined:

a new WebWorkVelocityContext



getInstance
public static synchronized VelocityManager getInstance()(Code)
retrieve an instance to the current VelocityManager



getVelocityEngine
public VelocityEngine getVelocityEngine()(Code)
a reference to the VelocityEngine used by all webwork velocity thingies with the exception ofdirectly accessed *.vm pages



getVelocityProperties
public Properties getVelocityProperties()(Code)
the velocityProperties



init
public synchronized void init(ServletContext context)(Code)
initializes the VelocityManager. this should be called during the initialization process, say by ServletDispatcher. this may be called multiple times safely although calls beyond the first won't do anything
Parameters:
  context - the current servlet context



init
protected void init()(Code)
performs one-time initializations



initChainedContexts
protected void initChainedContexts()(Code)
allow users to specify via the webwork.properties file a set of additional VelocityContexts to chain to the the WebWorkVelocityContext. The intent is to allow these contexts to store helper objects that the ui developer may want access to. Examples of reasonable VelocityContexts would be an IoCVelocityContext, a SpringReferenceVelocityContext, and a ToolboxVelocityContext



initToolbox
protected void initToolbox(ServletContext context)(Code)
Initializes the ServletToolboxManager for this servlet's toolbox (if any).



loadConfiguration
public Properties loadConfiguration(ServletContext context)(Code)
load optional velocity properties using the following loading strategy
  • relative to the servlet context path
  • relative to the WEB-INF directory
  • on the classpath

Parameters:
  context - the current ServletContext. may not be null the optional properties if webwork.velocity.configfile was specified, an empty Properties file otherwise



newVelocityEngine
protected VelocityEngine newVelocityEngine(ServletContext context)(Code)

Instantiates a new VelocityEngine.

The following is the default Velocity configuration

 resource.loader = file, class
 file.resource.loader.path = real path of webapp
 class.resource.loader.description = Velocity Classpath Resource Loader
 class.resource.loader.class = com.opensymphony.webwork.views.velocity.WebWorkResourceLoader
 

this default configuration can be overridden by specifying a webwork.velocity.configfile property in the webwork.properties file. the specified config file will be searched for in the following order:

  • relative to the servlet context path
  • relative to the WEB-INF directory
  • on the classpath

Parameters:
  context - the current ServletContext. may not be null



prepareChainedContexts
protected VelocityContext[] prepareChainedContexts(HttpServletRequest servletRequest, HttpServletResponse servletResponse, Map extraContext)(Code)
constructs contexts for chaining on this request. This method does not perform any initialization of the contexts. All that must be done in the context itself.
Parameters:
  servletRequest -
Parameters:
  servletResponse -
Parameters:
  extraContext - an VelocityContext[] of contexts to chain



setVelocityProperties
public void setVelocityProperties(Properties velocityProperties)(Code)

Parameters:
  velocityProperties - the velocityProperties to set



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.