Java Doc for MultiViewsTool.java in  » Template-Engine » Velocity » org » apache » velocity » tools » view » i18n » 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 » Template Engine » Velocity » org.apache.velocity.tools.view.i18n 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.velocity.tools.view.i18n.MultiViewsTool

MultiViewsTool
public class MultiViewsTool (Code)
Allows for transparent content negotiation in a manner mimicking Apache httpd's MultiViews.

Reads the default language out of the ViewContext as org.apache.velocity.tools.view.i18n.defaultLanguage. See MultiViewsTool.findLocalizedResource(String,String) and MultiViewsTool.findLocalizedResource(String,Locale) for usage.


version:
   $Id: MultiViewsTool.java 477914 2006-11-21 21:52:11Z henning $
author:
   Daniel Rall


Field Summary
final protected static  StringDEFAULT_LANGUAGE_KEY
     The key used to search initialization, context, and JVM parameters for the default language to use.
protected  StringdefaultLanguage
     The two character abbreviation for the request's default language.
protected  VelocityEngineengine
    

Constructor Summary
public  MultiViewsTool()
     Creates a new uninitialized instance.

Method Summary
public  StringfindLocalizedResource(String name, Locale locale)
     Calls MultiViewsTool.findLocalizedResource(String,String) using the language extracted from locale.
public  StringfindLocalizedResource(String name)
     Calls MultiViewsTool.findLocalizedResource(String,String) using the default language.
public  StringfindLocalizedResource(String name, String language)
    

Finds the a localized version of the requested Velocity resource (such as a file or template) which is most appropriate for the locale of the current request.

public  voidinit(Object obj)
     Extracts the default language from the specified ViewContext, looking first at the Velocity context, then the servlet context, then lastly at the JVM default.

Field Detail
DEFAULT_LANGUAGE_KEY
final protected static String DEFAULT_LANGUAGE_KEY(Code)
The key used to search initialization, context, and JVM parameters for the default language to use.



defaultLanguage
protected String defaultLanguage(Code)
The two character abbreviation for the request's default language.



engine
protected VelocityEngine engine(Code)




Constructor Detail
MultiViewsTool
public MultiViewsTool()(Code)
Creates a new uninitialized instance. Call MultiViewsTool.init to initialize it.




Method Detail
findLocalizedResource
public String findLocalizedResource(String name, Locale locale)(Code)
Calls MultiViewsTool.findLocalizedResource(String,String) using the language extracted from locale.
See Also:   MultiViewsTool.findLocalizedResource(String,String)



findLocalizedResource
public String findLocalizedResource(String name)(Code)
Calls MultiViewsTool.findLocalizedResource(String,String) using the default language.
See Also:   MultiViewsTool.findLocalizedResource(String,String)



findLocalizedResource
public String findLocalizedResource(String name, String language)(Code)

Finds the a localized version of the requested Velocity resource (such as a file or template) which is most appropriate for the locale of the current request. Use in conjuction with Apache httpd's MultiViews, or by itself.

Usage from a template would be something like the following:

 #parse ($multiviews.findLocalizedResource("header.vm", "en"))
 #include ($multiviews.findLocalizedResource("my_page.html", "en"))
 #parse ($multiviews.findLocalizedResource("footer.vm", "en"))
 
You might also wrap this method using another pull/view tool which does internationalization/localization/content negation for a single point of access.


Parameters:
  name - The unlocalized name of the file to find.
Parameters:
  language - The language to find localized context for. The localized file name, or name if it isnot localizable.



init
public void init(Object obj)(Code)
Extracts the default language from the specified ViewContext, looking first at the Velocity context, then the servlet context, then lastly at the JVM default. This "narrow scope to wide scope" pattern makes it easy to setup language overrides at different levels within your application.
Parameters:
  obj - the current ViewContext
throws:
  IllegalArgumentException - if the param is not a ViewContext



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.