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


java.lang.Object
   com.opensymphony.webwork.views.freemarker.FreemarkerManager

FreemarkerManager
public class FreemarkerManager (Code)
Static Configuration Manager for the FreemarkerResult's configuration

Possible extension points are :-

  • createConfiguration method
  • loadSettings method
  • getTemplateLoader method
  • populateContext method

createConfiguration method
Create a freemarker Configuration.

loadSettings method
Load freemarker settings, default to freemarker.properties (if found in classpath)

getTemplateLoader method
create a freemarker TemplateLoader that loads freemarker template in the following order :-

  1. path defined in ServletContext init parameter named 'templatePath' or 'TemplatePath' (must be an absolute path)
  2. webapp classpath
  3. webwork's static folder (under [WEBWORK_SOURCE]/com/opensymphony/webwork/static/

populateContext method
populate the created model.
author:
   CameronBraid
author:
   tm_jee
version:
   $Date: 2007-03-10 12:42:13 +0100 (Sat, 10 Mar 2007) $ $Id: FreemarkerManager.java 2859 2007-03-10 11:42:13Z tm_jee $



Field Summary
final public static  StringCONFIG_SERVLET_CONTEXT_KEY
    
final public static  StringKEY_APPLICATION
    
final public static  StringKEY_EXCEPTION
    
final public static  StringKEY_JSP_TAGLIBS
    
final public static  StringKEY_REQUEST_MODEL
    
final public static  StringKEY_REQUEST_PARAMETER_MODEL
    
final public static  StringKEY_SESSION_MODEL
    


Method Summary
protected  ScopesHashModelbuildScopesHashModel(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, ObjectWrapper wrapper, OgnlValueStack stack)
    
public  SimpleHashbuildTemplateModel(OgnlValueStack stack, Object action, ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, ObjectWrapper wrapper)
    
protected  freemarker.template.ConfigurationcreateConfiguration(ServletContext servletContext)
     Create the instance of the freemarker Configuration object.
final public synchronized  freemarker.template.ConfigurationgetConfiguration(ServletContext servletContext)
    
final public static synchronized  FreemarkerManagergetInstance()
     To allow for custom configuration of freemarker, sublcass this class "ConfigManager" and set the webwork configuration property webwork.freemarker.configmanager.classname to the fully qualified classname.
protected  BeansWrappergetObjectWrapper()
    
protected  TemplateLoadergetTemplateLoader(ServletContext servletContext)
     The default template loader is a MultiTemplateLoader which includes a ClassTemplateLoader and a WebappTemplateLoader (and a FileTemplateLoader depending on the init-parameter 'TemplatePath').

The ClassTemplateLoader will resolve fully qualified template includes that begin with a slash.

protected  voidloadSettings(ServletContext servletContext, freemarker.template.Configuration configuration)
    
public  voidpopulateContext(ScopesHashModel model, OgnlValueStack stack, Object action, HttpServletRequest request, HttpServletResponse response)
    

Field Detail
CONFIG_SERVLET_CONTEXT_KEY
final public static String CONFIG_SERVLET_CONTEXT_KEY(Code)



KEY_APPLICATION
final public static String KEY_APPLICATION(Code)



KEY_EXCEPTION
final public static String KEY_EXCEPTION(Code)



KEY_JSP_TAGLIBS
final public static String KEY_JSP_TAGLIBS(Code)



KEY_REQUEST_MODEL
final public static String KEY_REQUEST_MODEL(Code)



KEY_REQUEST_PARAMETER_MODEL
final public static String KEY_REQUEST_PARAMETER_MODEL(Code)



KEY_SESSION_MODEL
final public static String KEY_SESSION_MODEL(Code)





Method Detail
buildScopesHashModel
protected ScopesHashModel buildScopesHashModel(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, ObjectWrapper wrapper, OgnlValueStack stack)(Code)



buildTemplateModel
public SimpleHash buildTemplateModel(OgnlValueStack stack, Object action, ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, ObjectWrapper wrapper)(Code)



createConfiguration
protected freemarker.template.Configuration createConfiguration(ServletContext servletContext) throws TemplateException(Code)
Create the instance of the freemarker Configuration object.

this implementation

  • obtains the default configuration from Configuration.getDefaultConfiguration()
  • sets up template loading from a ClassTemplateLoader and a WebappTemplateLoader
  • sets up the object wrapper to be the BeansWrapper
  • loads settings from the classpath file /freemarker.properties

Parameters:
  servletContext -



getConfiguration
final public synchronized freemarker.template.Configuration getConfiguration(ServletContext servletContext) throws TemplateException(Code)



getInstance
final public static synchronized FreemarkerManager getInstance()(Code)
To allow for custom configuration of freemarker, sublcass this class "ConfigManager" and set the webwork configuration property webwork.freemarker.configmanager.classname to the fully qualified classname.

This allows you to override the protected methods in the ConfigMangaer to programatically create your own Configuration instance




getObjectWrapper
protected BeansWrapper getObjectWrapper()(Code)



getTemplateLoader
protected TemplateLoader getTemplateLoader(ServletContext servletContext)(Code)
The default template loader is a MultiTemplateLoader which includes a ClassTemplateLoader and a WebappTemplateLoader (and a FileTemplateLoader depending on the init-parameter 'TemplatePath').

The ClassTemplateLoader will resolve fully qualified template includes that begin with a slash. for example /com/company/template/common.ftl

The WebappTemplateLoader attempts to resolve templates relative to the web root folder




loadSettings
protected void loadSettings(ServletContext servletContext, freemarker.template.Configuration configuration)(Code)
Load the settings from the /freemarker.properties file on the classpath
See Also:   freemarker.template.Configuration.setSettings
See Also:    for the definition of valid settings



populateContext
public void populateContext(ScopesHashModel model, OgnlValueStack stack, Object action, HttpServletRequest request, HttpServletResponse response)(Code)



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.