Class PasswordField
java.lang.Object
org.apache.tapestry5.corelib.base.AbstractField
org.apache.tapestry5.corelib.base.AbstractTextField
org.apache.tapestry5.corelib.components.PasswordField
- All Implemented Interfaces:
ClientElement
,Field
A version of
TextField
, but rendered out as an <input type="password"> element. Further, the output
value for a PasswordField is always blank. When the value provided to the PasswordField is blank, it does not update
its property (care should be taken that the "required" validator not be used in that case).
Includes the size
attribute, if a Width
annotation is present on
the property bound to the value parameter.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). | ||||
clientId | String | literal | ||
Used to explicitly set the client-side id of the element for this component. Normally this is not bound (or null) and org.apache.tapestry5.services.javascript.JavaScriptSupport#allocateClientId(org.apache.tapestry5.ComponentResources) is used to generate a unique client-id based on the component's id. In some cases, when creating client-side behaviors, it is useful to explicitly set a unique id for an element using this parameter. Certain values, such as "submit", "method", "reset", etc., will cause client-side conflicts and are not allowed; using such will cause a runtime exception. | ||||
ensureClientIdUnique | boolean | Since 5.4 | prop | |
A rarely used option that indicates that the actual client id should start with the clientId parameter (if non-null) but should still pass that Id through org.apache.tapestry5.services.javascript.JavaScriptSupport#allocateClientId(String) to generate the final id. An example of this are the components used inside a org.apache.tapestry5.corelib.components.BeanEditor which will specify a clientId (based on the property name) but still require that it be unique. Defaults to false. | ||||
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. | Not Null | 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 |
-
Field Summary
Fields inherited from class org.apache.tapestry5.corelib.base.AbstractField
cssClass, decorator, defaultProvider, disabled, environment, fieldValidationSupport, formSupport, javaScriptSupport, label, request, resources, validationTracker
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
Returns true, blank input should be ignored and not cause an update to the server-side property bound to the value parameter.protected final void
writeFieldTag
(MarkupWriter writer, String value) Invoked fromAbstractTextField.begin(MarkupWriter)
to write out the element and attributes (typically, <input>).Methods inherited from class org.apache.tapestry5.corelib.base.AbstractTextField
getWidth, isRequired, processSubmission
Methods inherited from class org.apache.tapestry5.corelib.base.AbstractField
decorateInsideField, getClientId, getControlName, getLabel, isDisabled, putPropertyNameIntoBeanValidationContext, removePropertyNameFromBeanValidationContext, setDecorator, setFormSupport
-
Constructor Details
-
PasswordField
public PasswordField()
-
-
Method Details
-
writeFieldTag
Description copied from class:AbstractTextField
Invoked fromAbstractTextField.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 invokeMarkupWriter.element(String, Object[])
, and will be responsible for including anAfterRender
phase method to invokeMarkupWriter.end()
.- Specified by:
writeFieldTag
in classAbstractTextField
- Parameters:
writer
- markup write to send output tovalue
- the value (either obtained and translated from the value parameter, or obtained from the tracker)
-
ignoreBlankInput
Returns true, blank input should be ignored and not cause an update to the server-side property bound to the value parameter.- Overrides:
ignoreBlankInput
in classAbstractTextField
- Returns:
- true
-