Java Doc for FreemarkerResult.java in  » Web-Framework » struts-2.0.11 » org » apache » struts2 » 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 » Web Framework » struts 2.0.11 » org.apache.struts2.views.freemarker 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.struts2.dispatcher.StrutsResultSupport
      org.apache.struts2.views.freemarker.FreemarkerResult

FreemarkerResult
public class FreemarkerResult extends StrutsResultSupport (Code)
Renders a view using the Freemarker template engine.

The FreemarkarManager class configures the template loaders so that the template location can be either

  • relative to the web root folder. eg /WEB-INF/views/home.ftl
  • a classpath resuorce. eg com/company/web/views/home.ftl
This result type takes the following parameters:
  • location (default) - the location of the template to process.
  • parse - true by default. If set to false, the location param will not be parsed for Ognl expressions.
  • contentType - defaults to "text/html" unless specified.
Example:
 
 <result name="success" type="freemarker">foo.ftl</result>
 
 


Field Summary
protected  Configurationconfiguration
    
protected  FreemarkerManagerfreemarkerManager
    
protected  ActionInvocationinvocation
    
protected  Stringlocation
    
protected  ObjectWrapperwrapper
    

Constructor Summary
public  FreemarkerResult()
    
public  FreemarkerResult(String location)
    

Method Summary
protected  TemplateModelcreateModel()
    
protected  LocalededuceLocale()
     Returns the locale used for the Configuration.getTemplate(StringLocale) call.
public  voiddoExecute(String location, ActionInvocation invocation)
     Execute this result, using the specified template location.
protected  ConfigurationgetConfiguration()
     This method is called from FreemarkerResult.doExecute(String,ActionInvocation) to obtain the FreeMarker configuration object that this result will use for template loading.
public  StringgetContentType()
    
protected  ObjectWrappergetObjectWrapper()
     This method is called from FreemarkerResult.doExecute(String,ActionInvocation) to obtain the FreeMarker object wrapper object that this result will use for adapting objects into template models.
protected  WritergetWriter()
     The default writer writes directly to the response writer.
protected  voidpostTemplateProcess(Template template, TemplateModel data)
    
protected  booleanpreTemplateProcess(Template template, TemplateModel model)
     Called before the execution is passed to template.process(). This is a generic hook you might use in subclasses to perform a specific action before the template is processed.
public  voidsetContentType(String aContentType)
    
public  voidsetFreemarkerManager(FreemarkerManager mgr)
    
public  voidsetWriter(Writer writer)
    

Field Detail
configuration
protected Configuration configuration(Code)



freemarkerManager
protected FreemarkerManager freemarkerManager(Code)



invocation
protected ActionInvocation invocation(Code)



location
protected String location(Code)



wrapper
protected ObjectWrapper wrapper(Code)




Constructor Detail
FreemarkerResult
public FreemarkerResult()(Code)



FreemarkerResult
public FreemarkerResult(String location)(Code)




Method Detail
createModel
protected TemplateModel createModel() throws TemplateModelException(Code)
Build the instance of the ScopesHashModel, including JspTagLib support

Objects added to the model are

  • Application - servlet context attributes hash model
  • JspTaglibs - jsp tag lib factory model
  • Request - request attributes hash model
  • Session - session attributes hash model
  • request - the HttpServletRequst object for direct access
  • response - the HttpServletResponse object for direct access
  • stack - the OgnLValueStack instance for direct access
  • ognl - the instance of the OgnlTool
  • action - the action itself
  • exception - optional : the JSP or Servlet exception as per the servlet spec (for JSP Exception pages)
  • struts - instance of the StrutsUtil class



deduceLocale
protected Locale deduceLocale()(Code)
Returns the locale used for the Configuration.getTemplate(StringLocale) call. The base implementation simply returns the locale setting of the action (assuming the action implements LocaleProvider ) or, if the action does not the configuration's locale is returned. Override this method to provide different behaviour,



doExecute
public void doExecute(String location, ActionInvocation invocation) throws IOException, TemplateException(Code)
Execute this result, using the specified template location.

The template location has already been interoplated for any variable substitutions

this method obtains the freemarker configuration and the object wrapper from the provided hooks. It them implements the template processing workflow by calling the hooks for preTemplateProcess and postTemplateProcess




getConfiguration
protected Configuration getConfiguration() throws TemplateException(Code)
This method is called from FreemarkerResult.doExecute(String,ActionInvocation) to obtain the FreeMarker configuration object that this result will use for template loading. This is a hook that allows you to custom-configure the configuration object in a subclass, or to fetch it from an IoC container.

The default implementation obtains the configuration from the ConfigurationManager instance.




getContentType
public String getContentType()(Code)
allow parameterization of the contentType the default being text/html



getObjectWrapper
protected ObjectWrapper getObjectWrapper()(Code)
This method is called from FreemarkerResult.doExecute(String,ActionInvocation) to obtain the FreeMarker object wrapper object that this result will use for adapting objects into template models. This is a hook that allows you to custom-configure the wrapper object in a subclass.

The default implementation returns Configuration.getObjectWrapper




getWriter
protected Writer getWriter() throws IOException(Code)
The default writer writes directly to the response writer.



postTemplateProcess
protected void postTemplateProcess(Template template, TemplateModel data) throws IOException(Code)
the default implementation of postTemplateProcess applies the contentType parameter



preTemplateProcess
protected boolean preTemplateProcess(Template template, TemplateModel model) throws IOException(Code)
Called before the execution is passed to template.process(). This is a generic hook you might use in subclasses to perform a specific action before the template is processed. By default does nothing. A typical action to perform here is to inject application-specific objects into the model root true to process the template, false to suppress template processing.



setContentType
public void setContentType(String aContentType)(Code)



setFreemarkerManager
public void setFreemarkerManager(FreemarkerManager mgr)(Code)



setWriter
public void setWriter(Writer writer)(Code)



Fields inherited from org.apache.struts2.dispatcher.StrutsResultSupport
final public static String DEFAULT_PARAM(Code)(Java Doc)

Methods inherited from org.apache.struts2.dispatcher.StrutsResultSupport
protected String conditionalParse(String param, ActionInvocation invocation)(Code)(Java Doc)
abstract protected void doExecute(String finalLocation, ActionInvocation invocation) throws Exception(Code)(Java Doc)
public void execute(ActionInvocation invocation) throws Exception(Code)(Java Doc)
public String getLastFinalLocation()(Code)(Java Doc)
public void setEncode(boolean encode)(Code)(Java Doc)
public void setLocation(String location)(Code)(Java Doc)
public void setParse(boolean parse)(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.