KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > google > gwt > user > client > ui > FormHandler


1 /*
2  * Copyright 2007 Google Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
5  * use this file except in compliance with the License. You may obtain a copy of
6  * the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13  * License for the specific language governing permissions and limitations under
14  * the License.
15  */

16 package com.google.gwt.user.client.ui;
17
18 import java.util.EventListener JavaDoc;
19
20 /**
21  * Handler interface for form submit events.
22  */

23 public interface FormHandler extends EventListener JavaDoc {
24
25   /**
26    * Fired when the form is submitted.
27    *
28    * <p>
29    * The FormPanel must <em>not</em> be detached (i.e. removed from its parent
30    * or otherwise disconnected from a {@link RootPanel}) until the submission
31    * is complete. Otherwise, notification of submission will fail.
32    * </p>
33    *
34    * @param event an event object containing information about the form
35    * submission
36    */

37   void onSubmit(FormSubmitEvent event);
38
39   /**
40    * Fired when a form has been submitted successfully.
41    *
42    * @param event an event object containing information about the form
43    * submission
44    */

45   void onSubmitComplete(FormSubmitCompleteEvent event);
46 }
47
Popular Tags