01: // Copyright 2006, 2007 The Apache Software Foundation
02: //
03: // Licensed under the Apache License, Version 2.0 (the "License");
04: // you may not use this file except in compliance with the License.
05: // You may obtain a copy of the License at
06: //
07: // http://www.apache.org/licenses/LICENSE-2.0
08: //
09: // 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: /**
18: * Defines a field within a form.
19: */
20: public interface Field extends ClientElement {
21: /**
22: * Returns the value used as the name attribute of the rendered element. This value will be
23: * unique within an enclosing form, even if the same component renders multiple times.
24: */
25: String getElementName();
26:
27: /**
28: * Returns a user presentable (localized) label for the field, which may be used inside
29: * <label> elements on the client, and inside client or server-side validation error
30: * messages.
31: *
32: * @return the label
33: */
34: String getLabel();
35:
36: /**
37: * Returns true if the field is disabled; A disabled field will render a disabled attribute so
38: * that it is non-responsive on the client (at least, until its disabled status is changed on
39: * the client using JavaScript). A disabled field will ignore any value passed up in a form
40: * submit request. Care must be taken if the disabled status of a field can change between the
41: * time the field is rendered and the time the enclosing form is submitted.
42: */
43: boolean isDisabled();
44: }
|