Project Documentation

Summary

Tag name: <tr:inputText>
UIComponent class: org.apache.myfaces.trinidad.component.core.input.CoreInputText
Component type: org.apache.myfaces.trinidad.CoreInputText

The inputText component creates a browser input text widget. Depending on the value of "rows", this component either maps to a single-row text field or a multi-row text area. If the input should be hidden from the user while displayed, such as for passwords, the secret property should be set to "true". It also supports displaying a label, text, and messages.

Code Example(s)

Simple text input box with the some default text and a label.

<tr:form>
  <tr:inputText label="Input:" value="Some text"/>
</tr:form>

A slightly more interesting example showing a text box twenty five characters in length with hidden input text.

<tr:inputText label="Password:"
              columns="25"
              required="no"
              secret="true"/>

A text input box which will display three rows of wrapped input text, with a vertical scrollbar. If the value is changed, an alert will say so.

<tr:inputText label="Alert:"
              rows="3"
              wrap="soft"
              onchange="alert('Text box has changed.')"
              value="Alert on change."/>

Supported Client Events for Client Behaviors

  • blur
  • change (default)
  • click
  • dblclick
  • focus
  • keydown
  • keypress
  • keyup
  • mousedown
  • mousemove
  • mouseout
  • mouseover
  • mouseup
  • select
  • valueChange

Events

Type Phases Description
javax.faces.event.ValueChangeEventProcess Validations,
Apply Request Values
The valueChange event is delivered when the value attribute is changed.
org.apache.myfaces.trinidad.event.AttributeChangeEventInvoke Application,
Apply Request Values
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

Supported Facets

Name Description
helpThis facet should contain field level help.

Attributes

Name Type Supports EL? Description
accessKeycharYes Character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element). For accessibility reasons, this functionality is not supported in screen reader mode. If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.

This attribute is sometimes referred to as the "mnemonic".

attributeChangeListenerjavax.el.MethodExpressionOnly EL a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
autoCompleteStringYes Valid Values: on, off
Default Value: on

whether previous values of text fields in the form should be remembered and offered for auto completion.
autoSubmitbooleanYes Default Value: false

If set to TRUE on a form element, the component will automatically submit the enclosing form when an appropriate action takes place (a click, text change, etc.).
bindingorg.apache.myfaces.trinidad.component.core.input.CoreInputTextOnly EL an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
columnsintYes the number of columns to display in the text control. If no value is specified, a default of 30 columns is used. One column is approximately one character in the browser's current display font.
contentStyleStringYes the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px".
converterjavax.faces.convert.ConverterYes a converter object
disabledbooleanYes Default Value: false

whether the element is disabled.
idStringNo the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
  • Must not be a zero-length String.
  • First character must be an ASCII letter (A-Za-z) or an underscore ('_').
  • Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
immediatebooleanYes Default Value: false

whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
inlineStyleStringYes the inline CSS style for this element
labelStringYes the label of the bean.
labelAndAccessKeyStringYes An attribute that will simultaneously set both the "value" and "accessKey" attributes from a single value, using conventional ampersand ('&') notation.

For example, setting this attribute to "L&amp;abel" will set the label to "Label" and the access key to 'a'.

maximumLengthintYes the maximum number of characters that can be entered into the text control. Note that this value is independent of the "cols" displayed. If set to 0 or less, the maximumLength is ignored.
onblurStringYes the event handler for the component losing the focus.
Not supported on the following agents: pda
onchangeStringYes event handler for when the value is changed.
onclickStringYes an onclick Javascript handler.
ondblclickStringYes an ondblclick Javascript handler.
onfocusStringYes the event handler for the component gaining the focus.
Not supported on the following agents: pda
onkeydownStringYes an onkeydown Javascript handler.
onkeypressStringYes an onkeypress Javascript handler.
onkeyupStringYes an onkeyup Javascript handler.
onmousedownStringYes an onmousedown Javascript handler.
onmousemoveStringYes an onmousemove Javascript handler.
onmouseoutStringYes an onmouseout Javascript handler.
onmouseoverStringYes an onmouseover Javascript handler.
onmouseupStringYes an onmouseup Javascript handler.
onselectStringYes event handler for when text becomes selected.
partialTriggersString[]Yes the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.
readOnlybooleanYes Default Value: false

whether the element is read-only.
renderedbooleanYes Default Value: true

whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
requiredbooleanYes Default Value: false

whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
requiredMessageDetailStringYes the message to be displayed, if 'required' validation fails.

Parameters:

  • {0} the label that identifies the component
rowsintYes Default Value: 1

the number of rows to display in the text control. The default is one. Setting to more than one row precludes the use of some attributes, such as "secret".
secretbooleanYes Default Value: false

a boolean value that only applies to single line text controls. When set to "true", it hides the actual value of the text from the user, and will prevent the actual "value" from being shown to the user.
shortDescStringYes the short description of the bean. This text is commonly used by user agents to display tooltip help text.
showRequiredbooleanYes Default Value: false

whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed.
simplebooleanYes Default Value: false

a boolean value that controls whether the component provides label and message support; when set to "true", the component will not display messaging support or the label (these attributes may be ignored: label, labelAndAccessKey, accessKey, showRequired, tip), and may use simpler layout primitives
styleClassStringYes Valid Values: AFFieldTextMarker, AFFieldTextLTRMarker, AFPhoneFieldTextMarker, AFPostalCodeFieldTextMarker, AFAddressFieldTextMarker, AFFieldNumberMarker

a CSS style class to use for this component. The styleClass attribute value is rendered on the root dom element. We provide some public style classes you can use that will affect only the 'content' piece of the component: AFFieldTextMarker, AFFieldTextLTRMarker, AFPhoneFieldTextMarker, AFPostalCodeFieldTextMarker, AFAddressFieldTextMarker, AFFieldNumberMarker. You can still modify the public style definitions for these marker style classes and it will be picked up by using these "Marker" style class because in our base skin implementation we map to the public style by doing this: af|inputText.AFFieldNumberMarker af|inputText::content {-tr-rule-ref:selector(".AFFieldNumber")}. We recommend that you do not add style properties to the "Marker" style classes. They are used solely in the css descendant selector to point to the content pseudo-element.
validatorjavax.faces.el.MethodBindingOnly EL a method reference to a validator method
valueObjectYes the value of the component. If the EL binding for the "value" points to a bean property with a getter but no setter, and this is an editable component, the component will be rendered in read-only mode.
valueChangeListenerjavax.faces.el.MethodBindingOnly EL a method reference to a value change listener
wrapStringYes Valid Values: soft, hard, off

the type of text wrapping to be used in a multi-row text control. This attribute is ignored for single row inputText. By default (or "soft"), multirow text wraps visually, but does not include carriage returns in the submitted value. Setting this to "off" will disable wrapping; the multirow text will scroll horizontally. Setting it to "hard" specifies that the value of the text should include any carriage returns needed to wrap the lines.