Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ValidatableFieldSupport |
|
| 1.0;1 |
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.IMarkupWriter; | |
18 | import org.apache.tapestry.IRequestCycle; | |
19 | import org.apache.tapestry.form.validator.Required; | |
20 | import org.apache.tapestry.valid.ValidatorException; | |
21 | ||
22 | /** | |
23 | * Implements the logic used by {@link Required}s for required field checking on rewind and | |
24 | * generating client-side logic during render. | |
25 | * | |
26 | * @author Paul Ferraro | |
27 | * @since 4.0 | |
28 | */ | |
29 | public interface ValidatableFieldSupport | |
30 | { | |
31 | /** | |
32 | * Called during render of the specified component. Renders any contributions from validators. | |
33 | */ | |
34 | void renderContributions(ValidatableField field, IMarkupWriter writer, | |
35 | IRequestCycle cycle); | |
36 | ||
37 | /** | |
38 | * Called during rewind of the specified component. Specified value is validated using the | |
39 | * component's validators. | |
40 | * | |
41 | * @throws ValidatorException if validation fails | |
42 | */ | |
43 | void validate(ValidatableField component, IMarkupWriter writer, IRequestCycle cycle, Object value) throws ValidatorException; | |
44 | ||
45 | /** | |
46 | * Returns true if this component is required. This usually entails a search of the component's | |
47 | * validators. | |
48 | */ | |
49 | boolean isRequired(ValidatableField field); | |
50 | } |