View Javadoc
1 package org.apache.turbine.util.webmacro; 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 import java.lang.reflect.Method; 58 import java.util.Enumeration; 59 import org.apache.turbine.modules.ActionEvent; 60 import org.apache.turbine.services.webmacro.WebMacroService; 61 import org.apache.turbine.util.ParameterParser; 62 import org.apache.turbine.util.RunData; 63 import org.webmacro.servlet.WebContext; 64 65 /*** 66 * If you are using WebMacroSite stuff, then your Action's should 67 * extend this class instead of extending the ActionEvent class. The 68 * difference between this class and the ActionEvent class is that 69 * this class will first attempt to execute one of your doMethod's 70 * with a constructor like this: 71 * 72 * <p>doEvent(RunData data, WebContext context) 73 * 74 * <p>It gets the context from the TemplateInfo.getTemplateContext() 75 * method. If it can't find a method like that, then it will try to 76 * execute the method without the WebContext in it. 77 * 78 * @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a> 79 * @version $Id: WebMacroActionEvent.java,v 1.2 2002/07/11 16:53:19 mpoeschl Exp $ 80 * @deprecated you should use velocity 81 */ 82 public abstract class WebMacroActionEvent 83 extends ActionEvent 84 { 85 /*** 86 * You need to implement this in your classes that extend this 87 * class. 88 * 89 * @param data A Turbine RunData object. 90 * @exception Exception, a generic exception. 91 */ 92 public abstract void doPerform(RunData data) 93 throws Exception; 94 95 /*** 96 * This overrides the default Action.perform() to execute the 97 * doEvent() method. If that fails, then it will execute the 98 * doPerform() method instead. 99 * 100 * @param data A Turbine RunData object. 101 * @exception Exception, a generic exception. 102 */ 103 protected void perform(RunData data) 104 throws Exception 105 { 106 try 107 { 108 executeEvents(data, (WebContext) data.getTemplateInfo() 109 .getTemplateContext(WebMacroService.WEBMACRO_CONTEXT)); 110 } 111 catch (NoSuchMethodException e) 112 { 113 doPerform(data); 114 } 115 } 116 117 /*** 118 * This method should be called to execute the event based system. 119 * 120 * @param data A Turbine RunData object. 121 * @param context WebMacro context information. 122 * @exception Exception, a generic exception. 123 */ 124 public void executeEvents(RunData data, WebContext context) 125 throws Exception 126 { 127 // Name of the button. 128 String theButton = null; 129 130 // ParameterParser. 131 ParameterParser pp = data.getParameters(); 132 133 String button = pp.convert(BUTTON); 134 135 // Loop through and find the button. 136 for (Enumeration e = pp.keys() ; e.hasMoreElements() ;) 137 { 138 String key = (String) e.nextElement(); 139 if (key.startsWith(button)) 140 { 141 theButton = formatString(key); 142 break; 143 } 144 } 145 146 if (theButton == null) 147 { 148 throw new NoSuchMethodException("ActionEvent: The button was null"); 149 } 150 151 try 152 { 153 // The arguments to the method to find. 154 Class[] classes = new Class[2]; 155 classes[0] = RunData.class; 156 classes[1] = WebContext.class; 157 158 // The arguments to pass to the method to execute. 159 Object[] args = new Object[2]; 160 161 Method method = getClass().getMethod(theButton, classes); 162 args[0] = data; 163 args[1] = context; 164 method.invoke(this, args ); 165 } 166 catch (NoSuchMethodException nsme) 167 { 168 // Attempt to execut things the old way.. 169 super.executeEvents(data); 170 } 171 } 172 }

This page was automatically generated by Maven