1 package org.apache.turbine.modules.actions;
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 Stuff
58 import org.apache.turbine.modules.screens.TemplateScreen;
59 import org.apache.turbine.modules.screens.WebMacroSiteScreen;
60 import org.apache.turbine.util.RunData;
61 import org.apache.turbine.util.webmacro.WebMacroActionEvent;
62
63 // WebMacro Stuff
64 import org.webmacro.servlet.WebContext;
65
66
67 /***
68 * This class provides a convenience methods for WebMacroSite Actions
69 * to use. Since this class is abstract, it should only be extended
70 * and not used directly.
71 *
72 * @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>
73 * @version $Id: WebMacroSiteAction.java,v 1.1.1.1 2001/08/16 05:08:31 jvanzyl Exp $
74 * @deprecated you should use velocity
75 */
76 public abstract class WebMacroSiteAction extends WebMacroActionEvent
77 {
78 /***
79 * You SHOULD NOT override this method and implement it in your
80 * action.
81 *
82 * @param data Turbine information.
83 * @exception Exception, a generic exception.
84 */
85 public void doPerform( RunData data )
86 throws Exception
87 {
88 doPerform(data, getContext(data));
89 }
90
91 /***
92 * You SHOULD override this method and implement it in your
93 * action.
94 *
95 * @param data Turbine information.
96 * @param context Context for web pages.
97 * @exception Exception, a generic exception.
98 */
99 public abstract void doPerform( RunData data, WebContext context )
100 throws Exception;
101
102 /***
103 * Sets up the context and then calls super.perform(); thus,
104 * subclasses don't have to worry about getting a context
105 * themselves!
106 *
107 * @param data Turbine information.
108 * @exception Exception, a generic exception.
109 */
110 protected void perform( RunData data )
111 throws Exception
112 {
113 super.perform(data);
114 }
115
116 /***
117 * This method is used when you want to short circuit an Action
118 * and change the template that will be executed next.
119 *
120 * @param data Turbine information.
121 * @param template The template that will be executed next.
122 */
123 public void setTemplate(RunData data, String template)
124 {
125 TemplateScreen.setTemplate(data, template);
126 }
127
128 /***
129 * Return the WebContext needed by WebMacro. This is first setup
130 * in the WebMacroSitePage.
131 *
132 * @param RunData data
133 * @return WebContext, a context for web pages.
134 */
135 protected WebContext getContext(RunData data)
136 {
137 return WebMacroSiteScreen.getContext(data);
138 }
139 }
This page was automatically generated by Maven