KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > form > FormSupport


1 // Copyright 2005 The Apache Software Foundation
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 package org.apache.tapestry.form;
16
17 import org.apache.tapestry.FormBehavior;
18 import org.apache.tapestry.IRender;
19 import org.apache.tapestry.engine.ILink;
20
21 /**
22  * Interface for a utility object that encapsulates the majority of the
23  * {@link org.apache.tapestry.form.Form}'s behavior.
24  *
25  * @author Howard M. Lewis Ship
26  * @since 4.0
27  */
28 public interface FormSupport extends FormBehavior
29 {
30
31     /**
32      * Invoked when the form is rendering. This should only be invoked by the {@link Form}
33      * component.
34      *
35      * @param method
36      * the HTTP method ("get" or "post")
37      * @param informalParametersRenderer
38      * object that will render informal parameters
39      * @param link
40      * The link to which the form will submit (encapsulating the URL and the query
41      * parameters)
42      */
43     public void render(String JavaDoc method, IRender informalParametersRenderer, ILink link);
44
45     /**
46      * Invoked to rewind the form, which renders the body of the form, allowing form element
47      * components to pull data from the request and update page properties. This should only be
48      * invoked by the {@link Form} component.
49      *
50      * @return a code indicating why the form was submitted: {@link FormConstants#SUBMIT_NORMAL},
51      * {@link FormConstants#SUBMIT_CANCEL} or {@link FormConstants#SUBMIT_REFRESH}.
52      */
53     public String JavaDoc rewind();
54 }
Popular Tags