Java Doc for TurbineTemplate.java in  » Project-Management » turbine » org » apache » turbine » services » template » 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 » Project Management » turbine » org.apache.turbine.services.template 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.turbine.services.template.TurbineTemplate

TurbineTemplate
abstract public class TurbineTemplate (Code)
This is a simple static accessor to common TemplateService tasks such as getting a Screen that is associated with a screen template.
author:
   John D. McNally
version:
   $Id: TurbineTemplate.java 264148 2005-08-29 14:21:04Z henning $




Method Summary
final public static  StringgetDefaultExtension()
     Get the default extension given in the properties file.
final public static  StringgetDefaultLayout()
     Get the default layout module name of the template engine service corresponding to the default template name extension.
final public static  StringgetDefaultLayoutName(String template)
     Get the default layout module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name.
final public static  StringgetDefaultLayoutName(RunData data)
     Find the default layout module name for the given request.
Parameters:
  data - The encapsulation of the request to retrieve thedefault layout for.
final public static  StringgetDefaultLayoutTemplate()
     Get the default layout template given in the properties file.
final public static  StringgetDefaultLayoutTemplateName(String template)
     Get the default layout template name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name.
final public static  StringgetDefaultNavigation()
     Get the default Navigation given in the properties file.
final public static  StringgetDefaultNavigationName(String template)
     Get the default navigation module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name.
final public static  StringgetDefaultPage()
     Get the default page module name of the template engine service corresponding to the default template name extension.
final public static  StringgetDefaultPageName(String template)
     Get the default page module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name.
final public static  StringgetDefaultPageName(RunData data)
     Find the default page module name for the given request.
Parameters:
  data - The encapsulation of the request to retrieve thedefault page for.
final public static  StringgetDefaultScreen()
     Get the Screen template given in the properties file.
final public static  StringgetDefaultScreenName(String template)
     Get the default screen module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name.
final public static  StringgetDefaultTemplate()
     Returns the Default Template Name with the Default Extension.
final public static  StringgetExtension(String template)
    
final public static  StringgetLayoutName(String template)
     Locate and return the name of the layout module to be used with the named layout template.
Parameters:
  template - The layout template name.
final public static  StringgetLayoutTemplateName(String name)
     Locate and return the name of a layout template.
Parameters:
  name - A String with the name of the template.
final public static  StringgetNavigationName(String template)
     Locate and return the name of the navigation module to be used with the named navigation template.
Parameters:
  template - The navigation template name.
final public static  StringgetNavigationTemplateName(String key)
     Locate and return the name of a navigation template.
Parameters:
  key - A String which is the key to the template.
final public static  StringgetScreenName(String name)
     Locate and return the name of a Screen module.
Parameters:
  name - A String with the name of the template.
final public static  StringgetScreenTemplateName(String key)
     Locate and return the name of a screen template.
Parameters:
  key - A String which is the key to the template.
public static  TemplateServicegetService()
    
final public static  TemplateEngineServicegetTemplateEngineService(String template)
     The org.apache.turbine.services.template.TemplateEngineService associated with the specified template's file extension.
Parameters:
  template - The template name.
final public static  booleanisCaching()
    
final public static  voidregisterTemplateEngineService(TemplateEngineService service)
     Registers the provided template engine for use by the TemplateService.
final public static  booleantemplateExists(String template, String[] templatePaths)
     Delegates to the appropriate org.apache.turbine.services.template.TemplateEngineService to check the existance of the specified template.
final public static  String[]translateTemplatePaths(String[] templatePaths)
     Translates the supplied template paths into their Turbine-canonical equivalent (probably absolute paths).
Parameters:
  templatePaths - An array of template paths.



Method Detail
getDefaultExtension
final public static String getDefaultExtension()(Code)
Get the default extension given in the properties file. A String with the extension.



getDefaultLayout
final public static String getDefaultLayout()(Code)
Get the default layout module name of the template engine service corresponding to the default template name extension. The default layout module name.



getDefaultLayoutName
final public static String getDefaultLayoutName(String template)(Code)
Get the default layout module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name. The default layout module name.



getDefaultLayoutName
final public static String getDefaultLayoutName(RunData data)(Code)
Find the default layout module name for the given request.
Parameters:
  data - The encapsulation of the request to retrieve thedefault layout for. The default layout module name.



getDefaultLayoutTemplate
final public static String getDefaultLayoutTemplate()(Code)
Get the default layout template given in the properties file. A String which is the value of the TemplateServicedefault.layout.template property.



getDefaultLayoutTemplateName
final public static String getDefaultLayoutTemplateName(String template)(Code)
Get the default layout template name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name. The default layout template name.



getDefaultNavigation
final public static String getDefaultNavigation()(Code)
Get the default Navigation given in the properties file. A String which is the value of the TemplateServicedefault.navigation property.



getDefaultNavigationName
final public static String getDefaultNavigationName(String template)(Code)
Get the default navigation module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name. The default navigation module name.



getDefaultPage
final public static String getDefaultPage()(Code)
Get the default page module name of the template engine service corresponding to the default template name extension. The default page module name.



getDefaultPageName
final public static String getDefaultPageName(String template)(Code)
Get the default page module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name. The default page module name.



getDefaultPageName
final public static String getDefaultPageName(RunData data)(Code)
Find the default page module name for the given request.
Parameters:
  data - The encapsulation of the request to retrieve thedefault page for. The default page module name.



getDefaultScreen
final public static String getDefaultScreen()(Code)
Get the Screen template given in the properties file. A String which is the value of the TemplateServicedefault.screen property.



getDefaultScreenName
final public static String getDefaultScreenName(String template)(Code)
Get the default screen module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name. The default screen module name.



getDefaultTemplate
final public static String getDefaultTemplate()(Code)
Returns the Default Template Name with the Default Extension. If the extension is unset, return only the template name The default template Name



getExtension
final public static String getExtension(String template)(Code)
Return Extension for a supplied template
Parameters:
  template - The template name extension The extension for the supplied template



getLayoutName
final public static String getLayoutName(String template) throws Exception(Code)
Locate and return the name of the layout module to be used with the named layout template.
Parameters:
  template - The layout template name. The found layout module name.
exception:
  Exception - , a generic exception.



getLayoutTemplateName
final public static String getLayoutTemplateName(String name) throws Exception(Code)
Locate and return the name of a layout template.
Parameters:
  name - A String with the name of the template. A String with the layout template path.
exception:
  Exception - , a generic exception.



getNavigationName
final public static String getNavigationName(String template) throws Exception(Code)
Locate and return the name of the navigation module to be used with the named navigation template.
Parameters:
  template - The navigation template name. The found navigation module name.
exception:
  Exception - , a generic exception.



getNavigationTemplateName
final public static String getNavigationTemplateName(String key) throws Exception(Code)
Locate and return the name of a navigation template.
Parameters:
  key - A String which is the key to the template. A String with the navigation template path.
exception:
  Exception - , a generic exception.



getScreenName
final public static String getScreenName(String name) throws Exception(Code)
Locate and return the name of a Screen module.
Parameters:
  name - A String with the name of the template. A String with the name of the screen.
exception:
  Exception - , a generic exception.



getScreenTemplateName
final public static String getScreenTemplateName(String key) throws Exception(Code)
Locate and return the name of a screen template.
Parameters:
  key - A String which is the key to the template. A String with the screen template path.
exception:
  Exception - , a generic exception.



getService
public static TemplateService getService()(Code)
Utility method for accessing the service implementation a TemplateService implementation instance



getTemplateEngineService
final public static TemplateEngineService getTemplateEngineService(String template)(Code)
The org.apache.turbine.services.template.TemplateEngineService associated with the specified template's file extension.
Parameters:
  template - The template name. The template engine service.



isCaching
final public static boolean isCaching()(Code)
Returns true if the Template Service has caching activated true if Caching is active.



registerTemplateEngineService
final public static void registerTemplateEngineService(TemplateEngineService service)(Code)
Registers the provided template engine for use by the TemplateService.
Parameters:
  service - The TemplateEngineService to register.



templateExists
final public static boolean templateExists(String template, String[] templatePaths)(Code)
Delegates to the appropriate org.apache.turbine.services.template.TemplateEngineService to check the existance of the specified template.
Parameters:
  template - The template to check for the existance of.
Parameters:
  templatePaths - The paths to check for the template.



translateTemplatePaths
final public static String[] translateTemplatePaths(String[] templatePaths)(Code)
Translates the supplied template paths into their Turbine-canonical equivalent (probably absolute paths).
Parameters:
  templatePaths - An array of template paths. An array of translated template paths.



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.