Class TextArea

  extended by org.apache.tapestry5.corelib.base.AbstractField
      extended by org.apache.tapestry5.corelib.base.AbstractTextField
          extended by org.apache.tapestry5.corelib.components.TextArea
All Implemented Interfaces:
ClientElement, Field

public class TextArea
extends AbstractTextField

TextArea component corresponds to a <textarea> element. The value parameter is almost always bound to a string, but this is not an absolute requirement. Since the component accepts informal parameters, the rows and cols attribute may be set that way (there is not a formal parameter).

Includes the cols attribute, if a Width annotation is present on the property bound to the value parameter.

See Also:
TextOutput, TextField, Form
Component Parameters
NameDescriptionTypeFlagsDefaultDefault PrefixSince
annotationProviderProvider 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).org.apache.tapestry5.ioc.AnnotationProviderprop
clientIdThe id used to generate a page-unique client-side identifier for the component. If a component renders multiple times, a suffix will be appended to the to id to ensure uniqueness. The uniqued value may be accessed via the clientId property.Stringprop:componentResources.idliteral
disabledIf true, then the field will render out with a disabled attribute (to turn off client-side behavior). When the form is submitted, the bound value is evaluated again and, if true, the field's value is ignored (not even validated) and the component's events are not fired.booleanfalseprop
labelThe user presentable label for the field. If not provided, a reasonable label is generated from the component's id, first by looking for a message key named "id-label" (substituting the component's actual id), then by converting the actual id to a presentable string (for example, "userId" to "User Id").Stringliteral
nullsDefines 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
translateThe 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, Not Nulltranslate
validateThe object that will perform input validation (which occurs after translation). The validate binding prefix is generally used to provide this object in a declarative
valueThe 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.ObjectRequiredprop



Constructor Summary
Method Summary
protected  void writeFieldTag(MarkupWriter writer, String value)
          Invoked from AbstractTextField.begin(MarkupWriter) to write out the element and attributes (typically, <input>).
Methods inherited from class org.apache.tapestry5.corelib.base.AbstractTextField
getWidth, ignoreBlankInput, isRequired, processSubmission
Methods inherited from class org.apache.tapestry5.corelib.base.AbstractField
decorateInsideField, getClientId, getControlName, getLabel, isDisabled, putPropertyNameIntoBeanValidationContext, removePropertyNameFromBeanValidationContext, setDecorator, setFormSupport
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public TextArea()
Method Detail


protected final void writeFieldTag(MarkupWriter writer,
                                   String value)
Description copied from class: AbstractTextField
Invoked from AbstractTextField.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().

Specified by:
writeFieldTag in class AbstractTextField
writer - markup write to send output to
value - the value (either obtained and translated from the value parameter, or obtained from the tracker)

Copyright © 2003-2012 The Apache Software Foundation.