J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2003-2006 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | package javax.swing.text.html; |
| 26 | |
| 27 | import javax.swing.text.*; |
| 28 | import java.net.URL; |
| 29 | |
| 30 | /** |
| 31 | * FormSubmitEvent is used to notify interested |
| 32 | * parties that a form was submited. |
| 33 | * |
| 34 | * @since 1.5 |
| 35 | * @author Denis Sharypov |
| 36 | */ |
| 37 | |
| 38 | public class FormSubmitEvent extends HTMLFrameHyperlinkEvent { |
| 39 | |
| 40 | /** |
| 41 | * Represents an HTML form method type. |
| 42 | * <UL> |
| 43 | * <LI><code>GET</code> corresponds to the GET form method</LI> |
| 44 | * <LI><code>POST</code> corresponds to the POST from method</LI> |
| 45 | * </UL> |
| 46 | * @since 1.5 |
| 47 | */ |
| 48 | public enum MethodType { GET, POST }; |
| 49 | |
| 50 | /** |
| 51 | * Creates a new object representing an html form submit event. |
| 52 | * |
| 53 | * @param source the object responsible for the event |
| 54 | * @param type the event type |
| 55 | * @param actionURL the form action URL |
| 56 | * @param sourceElement the element that corresponds to the source |
| 57 | * of the event |
| 58 | * @param targetFrame the Frame to display the document in |
| 59 | * @param method the form method type |
| 60 | * @param data the form submission data |
| 61 | */ |
| 62 | FormSubmitEvent(Object source, EventType type, URL targetURL, |
| 63 | Element sourceElement, String targetFrame, |
| 64 | MethodType method, String data) { |
| 65 | super(source, type, targetURL, sourceElement, targetFrame); |
| 66 | this.method = method; |
| 67 | this.data = data; |
| 68 | } |
| 69 | |
| 70 | |
| 71 | /** |
| 72 | * Gets the form method type. |
| 73 | * |
| 74 | * @return the form method type, either |
| 75 | * <code>Method.GET</code> or <code>Method.POST</code>. |
| 76 | */ |
| 77 | public MethodType getMethod() { |
| 78 | return method; |
| 79 | } |
| 80 | |
| 81 | /** |
| 82 | * Gets the form submission data. |
| 83 | * |
| 84 | * @return the string representing the form submission data. |
| 85 | */ |
| 86 | public String getData() { |
| 87 | return data; |
| 88 | } |
| 89 | |
| 90 | private MethodType method; |
| 91 | private String data; |
| 92 | } |