1 package org.apache.turbine.services.template;
2
3 /* ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2001 The Apache Software Foundation. All rights
7 * reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. The end-user documentation included with the redistribution,
22 * if any, must include the following acknowledgment:
23 * "This product includes software developed by the
24 * Apache Software Foundation (http://www.apache.org/)."
25 * Alternately, this acknowledgment may appear in the software itself,
26 * if and wherever such third-party acknowledgments normally appear.
27 *
28 * 4. The names "Apache" and "Apache Software Foundation" and
29 * "Apache Turbine" must not be used to endorse or promote products
30 * derived from this software without prior written permission. For
31 * written permission, please contact apache@apache.org.
32 *
33 * 5. Products derived from this software may not be called "Apache",
34 * "Apache Turbine", nor may "Apache" appear in their name, without
35 * prior written permission of the Apache Software Foundation.
36 *
37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48 * SUCH DAMAGE.
49 * ====================================================================
50 *
51 * This software consists of voluntary contributions made by many
52 * individuals on behalf of the Apache Software Foundation. For more
53 * information on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57 import org.apache.turbine.util.RunData;
58
59 import org.apache.turbine.services.TurbineServices;
60
61 /***
62 * This is a simple static accessor to common TemplateService tasks such as
63 * getting a Screen that is associated with a screen template.
64 *
65 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
66 * @version $Id: TurbineTemplate.java,v 1.1.1.1 2001/08/16 05:09:22 jvanzyl Exp $
67 */
68 public abstract class TurbineTemplate
69 {
70 /***
71 * Utility method for accessing the service
72 * implementation
73 *
74 * @return a TemplateService implementation instance
75 */
76 protected static TemplateService getService()
77 {
78 return (TemplateService)TurbineServices
79 .getInstance().getService(TemplateService.SERVICE_NAME);
80 }
81
82 /***
83 * Locate and return the name of a screen template.
84 *
85 * @param key A String which is the key to the template.
86 * @return A String with the screen template path.
87 * @exception Exception, a generic exception.
88 */
89 public static final String getScreenTemplateName(String key)
90 throws Exception
91 {
92 return getService().getScreenTemplateName(key);
93 }
94
95 /***
96 * Locate and return the name of a layout template.
97 *
98 * @param name A String with the name of the template.
99 * @return A String with the layout template path.
100 * @exception Exception, a generic exception.
101 */
102 public static final String getLayoutTemplateName(String name)
103 throws Exception
104 {
105 return getService().getLayoutTemplateName(name);
106 }
107
108 /***
109 * Locate and return the name of a Navigation module.
110 *
111 * @param name A String with the name of the template.
112 * @return A String with the name of the navigation.
113 * @exception Exception, a generic exception.
114 */
115 public static final String getNavigationName(String name)
116 throws Exception
117 {
118 return getService().getNavigationName(name);
119 }
120
121 /***
122 * Locate and return the name of a Screen module.
123 *
124 * @param name A String with the name of the template.
125 * @return A String with the name of the screen.
126 * @exception Exception, a generic exception.
127 */
128 public static final String getScreenName(String name)
129 throws Exception
130 {
131 return getService().getScreenName(name);
132 }
133
134 /***
135 * Get the default extension given in the properties file.
136 *
137 * @return A String with the extension.
138 */
139 public static final String getDefaultExtension()
140 {
141 return getService().getDefaultExtension();
142 }
143
144 /***
145 * Get the Screen template given in the properties file.
146 *
147 * @return A String which is the value of the TemplateService
148 * default.screen property.
149 */
150 public static final String getDefaultScreen()
151 {
152 return getService().getDefaultScreen();
153 }
154
155 /***
156 * Get the default Navigation given in the properties file.
157 *
158 * @return A String which is the value of the TemplateService
159 * default.navigation property.
160 */
161 public static final String getDefaultNavigation()
162 {
163 return getService().getDefaultNavigation();
164 }
165
166 /***
167 * Get the default layout template given in the properties file.
168 *
169 * @return A String which is the value of the TemplateService
170 * default.layout.template property.
171 */
172 public static final String getDefaultLayoutTemplate()
173 {
174 return getService().getDefaultLayoutTemplate();
175 }
176
177 public static final void registerTemplateEngineService(TemplateEngineService service)
178 {
179 getService().registerTemplateEngineService(service);
180 }
181
182 public static final String[] translateTemplatePaths(String[] templatePaths)
183 {
184 return getService().translateTemplatePaths(templatePaths);
185 }
186
187 public static final boolean templateExists(String template, String[] templatePaths)
188 {
189 return getService().templateExists(template, templatePaths);
190 }
191
192 public static final String getDefaultPageName(RunData data)
193 {
194 return getService().getDefaultPageName(data);
195 }
196
197 public static final String getDefaultLayoutName(RunData data)
198 {
199 return getService().getDefaultLayoutName(data);
200 }
201 }
This page was automatically generated by Maven