1 package org.apache.turbine.modules.layouts;
2
3 /* ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2001-2003 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.commons.logging.Log;
58 import org.apache.commons.logging.LogFactory;
59
60 import org.apache.ecs.ConcreteElement;
61
62 import org.apache.turbine.TurbineConstants;
63 import org.apache.turbine.modules.Layout;
64 import org.apache.turbine.modules.ScreenLoader;
65 import org.apache.turbine.services.velocity.TurbineVelocity;
66 import org.apache.turbine.util.RunData;
67 import org.apache.turbine.util.template.TemplateNavigation;
68
69 import org.apache.velocity.context.Context;
70
71 /***
72 * This Layout module allows Velocity templates to be used as layouts.
73 * Since dynamic content is supposed to be primarily located in
74 * screens and navigations there should be relatively few reasons to
75 * subclass this Layout.
76 *
77 * To get the same functionality as with VelocityECSLayout, you can use two
78 * supplied VelocityMacros, TurbineHtmlHead and TurbineHtmlBodyAttributes
79 * in your templates. These are used to put HtmlPageAttributes into a page
80 * before rendering.
81 *
82 * Use these macros should be used in the Layout template like this:
83 *
84 * ... set things like style sheets, scripts here.
85 * <html>
86 * #TurbineHtmlHead()
87 * <body #TurbineHtmlBodyAttributes() >
88 * .... your body information
89 * </body>
90 * </html>
91 *
92 * As the layout template is rendered _after_ the screen template, you
93 * can of course, add information to the $page tool in your screen template.
94 * This will be added correctly to the <head>...</head> and
95 * <body> tags.
96 *
97 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
98 * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
99 * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
100 * @version $Id: VelocityOnlyLayout.java,v 1.12 2003/06/20 22:09:12 mpoeschl Exp $
101 */
102 public class VelocityOnlyLayout
103 extends Layout
104 {
105 /*** Logging */
106 private static Log log = LogFactory.getLog(VelocityOnlyLayout.class);
107
108 /*** The prefix for lookup up layout pages */
109 private String prefix = TurbineConstants.LAYOUT_PREFIX + "/";
110
111 /***
112 * Build the layout. Also sets the ContentType and Locale headers
113 * of the HttpServletResponse object.
114 *
115 * @param data Turbine information.
116 * @exception Exception a generic exception.
117 */
118 public void doBuild(RunData data)
119 throws Exception
120 {
121 // Get the context needed by Velocity.
122 Context context = TurbineVelocity.getContext(data);
123
124 String screenName = data.getScreen();
125
126 log.debug("Loading Screen " + screenName);
127
128 // First, generate the screen and put it in the context so
129 // we can grab it the layout template.
130 ConcreteElement results =
131 ScreenLoader.getInstance().eval(data, screenName);
132
133 String returnValue = (results == null) ? "" : results.toString();
134
135 // variable for the screen in the layout template
136 context.put(TurbineConstants.SCREEN_PLACEHOLDER, returnValue);
137
138 // variable to reference the navigation screen in the layout template
139 context.put(TurbineConstants.NAVIGATION_PLACEHOLDER,
140 new TemplateNavigation(data));
141
142 // Grab the layout template set in the VelocityPage.
143 // If null, then use the default layout template
144 // (done by the TemplateInfo object)
145 String templateName = data.getTemplateInfo().getLayoutTemplate();
146
147 // Set the locale and content type
148 data.getResponse().setLocale(data.getLocale());
149 data.getResponse().setContentType(data.getContentType());
150
151 log.debug("Now trying to render layout " + templateName);
152
153 // Finally, generate the layout template and send it to the browser
154 data.getOut().print(TurbineVelocity
155 .handleRequest(context, prefix + templateName));
156 }
157 }