1 package org.apache.turbine.modules.screens;
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.services.jsp.JspService;
60 import org.apache.turbine.services.TurbineServices;
61 import org.apache.turbine.services.template.TurbineTemplate;
62 import org.apache.turbine.util.RunData;
63
64
65 /***
66 * Base JSP Screen that should be subclassed by screens that want to
67 * use JSP. Subclasses should override the doBuildTemplate() method.
68 *
69 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
70 * @author Frank Y. Kim
71 * @version $Id: BaseJspScreen.java,v 1.1.1.1 2001/08/16 05:08:37 jvanzyl Exp $
72 */
73 public class BaseJspScreen extends TemplateScreen
74 {
75 /***
76 * Method that sets up beans and forward the request to the JSP.
77 *
78 * @param data Turbine information.
79 * @return null - the JSP sends the information.
80 * @exception Exception, a generic exception.
81 */
82 public ConcreteElement buildTemplate( RunData data )
83 throws Exception
84 {
85 // set up any data in beans, etc
86 doBuildTemplate(data);
87
88 // get the name of the JSP we want to use
89 String templateName = TurbineTemplate.getScreenTemplateName(
90 data.getTemplateInfo().getScreenTemplate() );
91
92 // Template service adds the leading slash, but make it sure.
93 if ((templateName.length() > 0) &&
94 (templateName.charAt(0) != '/'))
95 {
96 templateName = '/' + templateName;
97 }
98
99 // let service know whether we are using a layout
100 JspService jsp = (JspService)
101 TurbineServices.getInstance().getService(JspService.SERVICE_NAME);
102 jsp.handleRequest(data, "/screens" + templateName,
103 getLayout(data) == null);
104
105 return null;
106 }
107
108 /***
109 * Method to be overidden by subclasses to include data in beans, etc.
110 *
111 * @param data, the Rundata object
112 * @exception Exception, a generic exception.
113 */
114 protected void doBuildTemplate(RunData data) throws Exception
115 {
116 }
117 }
This page was automatically generated by Maven