Home » tapestry-src-5.0.19 » org.apache.tapestry5 » [javadoc | source]
org.apache.tapestry5
public interface: Field [javadoc | source]

All Implemented Interfaces:
    ClientElement

All Known Implementing Classes:
    Checkbox, AbstractTextField, Select, AbstractField, Upload, RadioGroup, TextArea, Radio, TextField, DateField, PasswordField, Palette

Defines a field within a form. Fields have a control name that is used when rendering and, later, when the form is submitted, to identify the query parameter.

Timing is important, as components may render multiple times, due to looping and other factors. Generally, a component's #getControlName() will only be accurate after it has rendered. In some cases, when generating JavaScript for example, it is necessary to {@linkplain org.apache.tapestry5.services.Heartbeat#defer(Runnable) wait until the end of the current Heartbeat} to ensure that all components have had thier chance to render.
Method from org.apache.tapestry5.Field Summary:
getControlName,   getLabel,   isDisabled,   isRequired
Method from org.apache.tapestry5.Field Detail:
 public String getControlName()
    Returns the value used as the name attribute of the rendered element. This value will be unique within an enclosing form, even if the same component renders multiple times.
 public String getLabel()
    Returns a user presentable (localized) label for the field, which may be used inside <label> elements on the client, and inside client or server-side validation error messages.
 public boolean isDisabled()
    Returns true if the field is disabled; A disabled field will render a disabled attribute so that it is non-responsive on the client (at least, until its disabled status is changed on the client using JavaScript). A disabled field will ignore any value passed up in a form submit request. Care must be taken if the disabled status of a field can change between the time the field is rendered and the time the enclosing form is submitted.
 public boolean isRequired()