1 /*
2 * $Header: /home/cvs/jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/tags/define/DynamicTag.java,v 1.7 2002/05/17 15:18:12 jstrachan Exp $
3 * $Revision: 1.7 $
4 * $Date: 2002/05/17 15:18:12 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>.
59 *
60 * $Id: DynamicTag.java,v 1.7 2002/05/17 15:18:12 jstrachan Exp $
61 */
62 package org.apache.commons.jelly.tags.swing;
63
64 import java.awt.event.WindowEvent;
65 import java.awt.event.WindowListener;
66
67 import org.apache.commons.jelly.JellyException;
68 import org.apache.commons.jelly.Script;
69 import org.apache.commons.jelly.TagSupport;
70 import org.apache.commons.jelly.XMLOutput;
71
72 import org.apache.commons.logging.Log;
73 import org.apache.commons.logging.LogFactory;
74
75 /***
76 * Creates a WindowListener which is attached to its parent window control which will invoke
77 * named Jelly scripts as window events are fired, or will invoke its body if there is no script
78 * specified for the named event type.
79 *
80 * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
81 * @version $Revision: 1.7 $
82 */
83 public class WindowListenerTag extends TagSupport {
84
85 /*** The Log to which logging calls will be made. */
86 private static final Log log = LogFactory.getLog(WindowListenerTag.class);
87
88 private String var;
89 private Script activated;
90 private Script closed;
91 private Script closing;
92 private Script deactivated;
93 private Script deiconified;
94 private Script iconified;
95 private Script opened;
96
97 public WindowListenerTag() {
98 }
99
100 // Tag interface
101 //-------------------------------------------------------------------------
102 public void doTag(final XMLOutput output) throws Exception {
103
104 // now lets add this action to its parent if we have one
105 ComponentTag tag = (ComponentTag) findAncestorWithClass( ComponentTag.class );
106 if ( tag != null ) {
107 WindowListener listener = new WindowListener() {
108 public void windowActivated(WindowEvent e) {
109 invokeScript( output, e, activated );
110 }
111
112 public void windowClosed(WindowEvent e) {
113 invokeScript( output, e, closed );
114 }
115
116 public void windowClosing(WindowEvent e) {
117 invokeScript( output, e, closing );
118 }
119
120 public void windowDeactivated(WindowEvent e) {
121 invokeScript( output, e, deactivated );
122 }
123
124 public void windowDeiconified(WindowEvent e) {
125 invokeScript( output, e, deiconified );
126 }
127
128 public void windowIconified(WindowEvent e) {
129 invokeScript( output, e, iconified );
130 }
131
132 public void windowOpened(WindowEvent e) {
133 invokeScript( output, e, opened );
134 }
135 };
136 tag.addWindowListener(listener);
137 }
138 }
139
140 // Properties
141 //-------------------------------------------------------------------------
142
143
144 /***
145 * Sets the name of the variable to use to expose the Event object
146 */
147 public void setVar(String var) {
148 this.var = var;
149 }
150
151 /***
152 * Sets the Script to be executed when the window is activated.
153 */
154 public void setActivated(Script activated) {
155 this.activated = activated;
156 }
157
158 /***
159 * Sets the Script to be executed when the window is closed.
160 */
161 public void setClosed(Script closed) {
162 this.closed = closed;
163 }
164
165 /***
166 * Sets the Script to be executed when the window is closing.
167 */
168 public void setClosing(Script closing) {
169 this.closing = closing;
170 }
171
172 /***
173 * Sets the Script to be executed when the window is deactivated.
174 */
175 public void setDeactivated(Script deactivated) {
176 this.deactivated = deactivated;
177 }
178
179 /***
180 * Sets the Script to be executed when the window is deiconified.
181 */
182 public void setDeiconified(Script deiconified) {
183 this.deiconified = deiconified;
184 }
185
186 /***
187 * Sets the Script to be executed when the window is iconified.
188 */
189 public void setIconified(Script iconified) {
190 this.iconified = iconified;
191 }
192
193 /***
194 * Sets the Script to be executed when the window is opened.
195 */
196 public void setOpened(Script opened) {
197 this.opened = opened;
198 }
199
200
201
202 // Implementation methods
203 //-------------------------------------------------------------------------
204 protected void invokeScript(XMLOutput output, WindowEvent event, Script script) {
205 if ( var != null ) {
206 // define a variable of the event
207 context.setVariable(var, event);
208 }
209
210 try {
211 if ( script != null ) {
212 script.run(context, output );
213 }
214 else {
215 // invoke the body
216 invokeBody(output);
217 }
218 }
219 catch (Exception e) {
220 log.error( "Caught exception processing window event: " + event, e );
221 }
222 }
223
224 }
This page was automatically generated by Maven