@Events(value={"toClient","validate","parseClient"}) public abstract class AbstractTextField extends AbstractField
Translator
(specified by the translate parameter, but often automatically derived by Tapestry) to be
augmented.
If the component container (i.e., the page) provides an event handler method for the "toclient" event, and that
handler returns a non-null string, that will be the string value sent to the client. The context passed to the event
handler method is t he current value of the value parameter.
Likewise, on a form submit, the "parseclient" event handler method will be passed the string provided by the client,
and may provide a non-null value as the parsed value. Returning null allows the normal translator to operate. The
event handler may also throw ValidationException
.Name | Type | Flags | Default | Default Prefix |
---|---|---|---|---|
annotationProvider | org. | prop | ||
Provider of annotations used for some defaults. Annotation are usually provided in terms of the value parameter (i.e., from the getter and/or setter bound to the value parameter). | ||||
nulls | org. | default | nullfieldstrategy | |
Defines how nulls on the server side, or sent from the client side, are treated. The selected strategy may replace the nulls with some other value. The default strategy leaves nulls alone. Another built-in strategy, zero, replaces nulls with the value 0. | ||||
translate | org. | Required, Not Null | translate | |
The object which will perform translation between server-side and client-side representations. If not specified, a value will usually be generated based on the type of the value parameter. | ||||
validate | org. | validate | ||
The object that will perform input validation (which occurs after translation). The validate binding prefix is generally used to provide this object in a declarative fashion. | ||||
value | Object | Required | prop | |
The value to be read and updated. This is not necessarily a string, a translator may be provided to convert between client side and server side representations. If not bound, a default binding is made to a property of the container matching the component's id. If no such property exists, then you will see a runtime exception due to the unbound value parameter. |
Name | Description |
---|---|
parseClient | |
toClient | |
validate |
clientId, cssClass, decorator, defaultProvider, disabled, environment, fieldValidationSupport, formSupport, javaScriptSupport, label, request, resources, validationTracker
Constructor and Description |
---|
AbstractTextField() |
Modifier and Type | Method and Description |
---|---|
protected String |
getWidth()
Looks for a
Width annotation and, if present, returns its value as a
string. |
protected boolean |
ignoreBlankInput()
Should blank input be ignored (after validation)? This will be true for
PasswordField . |
boolean |
isRequired()
Returns false; most components do not support declarative validation.
|
protected void |
processSubmission(String controlName)
Method implemented by subclasses to actually do the work of processing the submission of the form.
|
protected abstract void |
writeFieldTag(MarkupWriter writer,
String value)
Invoked from
begin(MarkupWriter) to write out the element and attributes (typically, <input>). |
decorateInsideField, getClientId, getControlName, getLabel, isDisabled, putPropertyNameIntoBeanValidationContext, removePropertyNameFromBeanValidationContext, setDecorator, setFormSupport
public AbstractTextField()
protected abstract void writeFieldTag(MarkupWriter writer, String value)
begin(MarkupWriter)
to write out the element and attributes (typically, <input>). The
controlName and clientId
properties will already have been set or updated.
Generally, the subclass will invoke MarkupWriter.element(String, Object[])
, and will be responsible for
including an AfterRender
phase method to invoke MarkupWriter.end()
.writer
- markup write to send output tovalue
- the value (either obtained and translated from the value parameter, or obtained from the tracker)protected void processSubmission(String controlName)
AbstractField
disabled
.processSubmission
in class AbstractField
controlName
- the control name of the rendered element (used to find the correct parameter in the request)protected boolean ignoreBlankInput()
PasswordField
.public boolean isRequired()
AbstractField
isRequired
in interface Field
isRequired
in class AbstractField
Copyright © 2003-2013 The Apache Software Foundation.