|
|||||||||||||||||||
30 day Evaluation Version distributed via the Maven Jar Repository. Clover is not free. You have 30 days to evaluate it. Please visit http://www.thecortex.net/clover to obtain a licensed version of Clover | |||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
IForm.java | - | - | - | - |
|
1 |
// Copyright 2004, 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;
|
|
16 |
|
|
17 |
import org.apache.tapestry.valid.IValidationDelegate;
|
|
18 |
|
|
19 |
/**
|
|
20 |
* A generic way to access a component which defines an HTML form (or, perhaps, other similar
|
|
21 |
* constructs, such as a WML {@link org.apache.tapestry.wml.Go}). This interface exists so that the
|
|
22 |
* {@link IRequestCycle}can invoke the {@link #rewind(IMarkupWriter, IRequestCycle)}method (which
|
|
23 |
* is used to deal with a Form that uses the direct service). In release 1.0.5, more responsibility
|
|
24 |
* for forms was moved here.
|
|
25 |
*
|
|
26 |
* @author Howard Lewis Ship
|
|
27 |
* @since 1.0.2
|
|
28 |
*/
|
|
29 |
|
|
30 |
public interface IForm extends IAction, FormBehavior |
|
31 |
{ |
|
32 |
|
|
33 |
/**
|
|
34 |
* Attribute name used with the request cycle; allows other components to locate the IForm.
|
|
35 |
*
|
|
36 |
* @since 1.0.5
|
|
37 |
* @deprecated To be removed; use {@link TapestryUtils#FORM_ATTRIBUTE}instead.
|
|
38 |
*/
|
|
39 |
|
|
40 |
public static final String ATTRIBUTE_NAME = TapestryUtils.FORM_ATTRIBUTE; |
|
41 |
|
|
42 |
/**
|
|
43 |
* Invoked by the {@link IRequestCycle}to allow a form that uses the direct service, to respond
|
|
44 |
* to the form submission.
|
|
45 |
*/
|
|
46 |
|
|
47 |
public void rewind(IMarkupWriter writer, IRequestCycle cycle); |
|
48 |
|
|
49 |
/**
|
|
50 |
* Returns the name of the form. The name is determined as the form component begins to render,
|
|
51 |
* but is not reset (as a convienience for building client-side JavaScript event handlers).
|
|
52 |
*
|
|
53 |
* @since 1.0.5
|
|
54 |
*/
|
|
55 |
|
|
56 |
public String getName();
|
|
57 |
|
|
58 |
/**
|
|
59 |
* Returns the validation delegate for the form. Returns null if the form does not have a
|
|
60 |
* delegate.
|
|
61 |
*
|
|
62 |
* @since 1.0.8
|
|
63 |
*/
|
|
64 |
|
|
65 |
public IValidationDelegate getDelegate();
|
|
66 |
} |
|