1 package org.apache.turbine.modules.layouts;
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 // Turbine/Village/ECS Imports
58 import org.apache.ecs.ConcreteElement;
59 import org.apache.turbine.modules.Layout;
60 import org.apache.turbine.modules.ScreenLoader;
61 import org.apache.turbine.services.webmacro.TurbineWebMacro;
62 import org.apache.turbine.services.webmacro.WebMacroService;
63 import org.apache.turbine.util.RunData;
64 import org.apache.turbine.util.template.TemplateNavigation;
65
66 // WebMacro Stuff
67 import org.webmacro.servlet.WebContext;
68
69 /***
70 * This Layout module allows WebMacro templates to be used as layouts.
71 * Since dynamic content is supposed to be primarily located in
72 * screens and navigations there should be relatively few reasons to
73 * subclass this Layout.
74 *
75 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
76 * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
77 * @version $Id: WebMacroSiteLayout.java,v 1.1.1.1 2001/08/16 05:08:34 jvanzyl Exp $
78 * @deprecated you should use velocity
79 */
80 public class WebMacroSiteLayout extends Layout
81 {
82 /***
83 * Build the layout.
84 *
85 * @param data Turbine information.
86 * @exception Exception, a generic exception.
87 */
88 public void doBuild( RunData data )
89 throws Exception
90 {
91 /* Get the context needed by WebMacro. */
92 WebContext context = getContext( data );
93 /* Screen results. */
94 String returnValue = "";
95
96 /*
97 * First, generate the screen and put it in the context so we
98 * can grab it the layout template.
99 */
100 ConcreteElement results = ScreenLoader.getInstance()
101 .eval(data, data.getScreen());
102 if (results != null)
103 returnValue = results.toString();
104
105 /* Variable for the screen in the layout template. */
106 context.put("screen_placeholder", returnValue);
107
108 /*
109 * Variable to reference the navigation screen in the layout
110 * template.
111 */
112 context.put("navigation", new TemplateNavigation( data ));
113
114 /*
115 * Grab the layout template set in the WebMacroSitePage. If
116 * null, then use the default layout template ( done by the
117 * TemplateInfo object ).
118 */
119 String templateName = data.getTemplateInfo().getLayoutTemplate();
120
121 /*
122 * Finally, generate the layout template and add it to the
123 * body of the Document in the RunData.
124 */
125 data.getPage().getBody()
126 .addElement(TurbineWebMacro.handleRequest(context, "layouts"
127 + templateName));
128 }
129
130 /***
131 * Return the WebContext needed by WebMacro.
132 *
133 * @param RunData data
134 * @return WebContext
135 */
136 protected WebContext getContext(RunData data)
137 {
138 // attempt to get it from the session first.
139 // if it doesn't exist, create it and then stuff it into the session
140 WebContext wc = (WebContext)data.getTemplateInfo().getTemplateContext(
141 WebMacroService.WEBMACRO_CONTEXT);
142 if (wc == null)
143 {
144 wc = TurbineWebMacro.getContext(data);
145 data.getTemplateInfo().setTemplateContext(
146 WebMacroService.WEBMACRO_CONTEXT, wc);
147 }
148 return wc;
149 }
150
151 }
This page was automatically generated by Maven