Input - Text Area

Input - Text Area

Allows the user to enter text data. Unlike the Input component, which allows you to specify a number of different types of textual input, the Text Area allows a user to enter multiple lines of text. The input control is usually bound to some type of data storage, such as a database or a bean. When a page with this input control is submitted, the content of the input field is stored in the specified location (for example, a column in the database or a property of the bean).

Component at design time

Drag and drop an
Input - Text Area component onto the page:

The
Input - Text Area component looks like this on the page:

Component at runtime

The
Input - Text Area component looks like this on the page during runtime:

Properties and All Attributes views

The Properties view for a component shows the most common set of attributes you can set on a component, and, depending on the component, you might also see options for adding controls, actions, or other components. To open the Properties view, click

Window | Show View | Properties.

These common attributes for the Input - Text Area component display on the h:inputTextArea, Validation, Behavior, and Accessibility tabs in the Properties view. See the All Input - Text Area table attributes for a complete list of attributes. Additional configuration options to validate input are on the h:inputTextArea>Validation tab:
Table 1. Input - Text Area configuration options

Configuration option

Description

Click to create/edit custom validation code

Switches to the Quick Edit view so that scripts or snippets of code may be entered for various user initiated events.

Constraint

Limits the type of characters that can be entered into the component (for example, Digits Only or ASCII Alphabet Only). Adds hx:validateConstraint with the regex attribute to the All Attributes view.

Display validation error messages in an error message control

Inserts an error message component associated with the selected component. This will display an error message if the validation fails.

Maximum length

The maximum number of characters this component can contain when submitted on the server. Adds the function f:validateLength with a maximum attribute to the All Attributes view.

Minimum length

The minimum number of characters this component can contain when submitted on the server. Adds a function f:validateLength with a minimum attribute to the All Attributes view.

The All Attributes view shows a table of all the attributes you can set on a component, which includes those attributes you can access from the Properties view. To switch to the All Attributes view, click the
All Attributes icon in the upper right corner of the Properties view.

Table 2. All Input - Text Area attributes

Attribute name

Represented in Properties view by

Description

accesskey

Accessibility>Access Key

Specifies a single keyboard key as an access key. Pressing the specified access key at runtime gives focus to this component. Pressing ALT plus the specified access key at runtime gives focus to this component (or executes the component if it is a kind of button).

binding

Not represented

An expression that binds the component's instance (usually a user interface component) to a bean property (usually in the backing file).

cols

Size: Width

Specifies the number of columns displayed at runtime.

converter

Not represented

Specifies the data type to which the value is converted. The JavaServer Faces implementation provides a set of Converter implementations that you can use to convert your component data to a type not supported by its renderer.

dir

Not represented

Specifies the component's direction when rendered at runtime. The values can be either:

ltr - left to right

rtl - right to left
If the direction is not specified, a direction appropriate to the encoding of the component is used.

disabled

Behavior>Control is disabled

If disabled is set to true, the component is displayed at runtime but is not functional. If left blank, the default value is false.

id

ID

Assigns a name to a component. Should be a unique name within a JSP.

immediate

Not represented

If true, skip straight to render phase of life cycle.

lang

Not represented

The language of the component's value(s) and text content. If omitted, the language is inherited from the containing tags (notably the view. Specified as an ISO-standard language abbreviation code. For example, "en" for English, "en-US" for American English, "fr" for French, "de" for German.

Note: This does not "translate" the text in the component, rather, it identifies the language of the component so that operations such as searching, sorting, collating and the like are done correctly.

readonly

Behavior>Control is read-only

Specifies that the value of the component cannot be changed from its initial value.

rendered

Not represented

Can be set to true or false:

false - Component will not be rendered to the browser at runtime.

true - Component will get rendered. This is the default value.

required

Validation>Value is Required

The component must be specified. Check this to require the user to enter a value.

rows

Size: Height

Specifies the number of rows displayed at runtime.

style

Style: Props

Specifies CSS style information for the component (for example, style="font-size : 8pt ; color : red"). Defines the properties (such as font and color) of the selected component. This may be done manually, or by clicking the button and selecting the desired properties from within the window.

styleClass

Style: Classes

Space-separated list of CSS style classes to be applied when this element is rendered. This value must be passed through as the class attribute on generated markup. Defines the classes (such as style sheets) of the selected component. This may be done manually, or by clicking the button and selecting the desired Classes from within the window.

tabindex

Accessibility>Tab order index

Specifies the position of the component in the tabbing order in the JSP. This value must be a number between 0 and 32767.

title

Accessibility>Title

Specifies the title text, shown in browser as a tooltip at runtime. Used by a browser as the alternative text of a component if the alternative text is not specified.

validator

Not represented

A method (represented by a MethodBinding expression) that accepts FacesContext, UIComponent, and Object parameters. It is called during the validation process to ensure that value of the component is correct.

value

Value

Specifies the initial text value for the component displayed at runtime. Contains information to be displayed, in the form of a specified value or a pointer to a dynamic value.

valueChangeListener

Not represented

Method to be notified when value of component has changed.

Configuration option	Description
Click to create/edit custom validation code	Switches to the Quick Edit view so that scripts or snippets of code may be entered for various user initiated events.
Constraint	Limits the type of characters that can be entered into the component (for example, Digits Only or ASCII Alphabet Only). Adds hx:validateConstraint with the regex attribute to the All Attributes view.
Display validation error messages in an error message control	Inserts an error message component associated with the selected component. This will display an error message if the validation fails.
Maximum length	The maximum number of characters this component can contain when submitted on the server. Adds the function f:validateLength with a maximum attribute to the All Attributes view.
Minimum length	The minimum number of characters this component can contain when submitted on the server. Adds a function f:validateLength with a minimum attribute to the All Attributes view.

Attribute name	Represented in Properties view by	Description
accesskey	Accessibility>Access Key	Specifies a single keyboard key as an access key. Pressing the specified access key at runtime gives focus to this component. Pressing ALT plus the specified access key at runtime gives focus to this component (or executes the component if it is a kind of button).
binding	Not represented	An expression that binds the component's instance (usually a user interface component) to a bean property (usually in the backing file).
cols	Size: Width	Specifies the number of columns displayed at runtime.
converter	Not represented	Specifies the data type to which the value is converted. The JavaServer Faces implementation provides a set of Converter implementations that you can use to convert your component data to a type not supported by its renderer.
dir	Not represented	Specifies the component's direction when rendered at runtime. The values can be either: ltr - left to right rtl - right to left If the direction is not specified, a direction appropriate to the encoding of the component is used.
disabled	Behavior>Control is disabled	If disabled is set to true, the component is displayed at runtime but is not functional. If left blank, the default value is false.
id	ID	Assigns a name to a component. Should be a unique name within a JSP.
immediate	Not represented	If true, skip straight to render phase of life cycle.
lang	Not represented	The language of the component's value(s) and text content. If omitted, the language is inherited from the containing tags (notably the view. Specified as an ISO-standard language abbreviation code. For example, "en" for English, "en-US" for American English, "fr" for French, "de" for German. Note: This does not "translate" the text in the component, rather, it identifies the language of the component so that operations such as searching, sorting, collating and the like are done correctly.
readonly	Behavior>Control is read-only	Specifies that the value of the component cannot be changed from its initial value.
rendered	Not represented	Can be set to true or false: false - Component will not be rendered to the browser at runtime. true - Component will get rendered. This is the default value.
required	Validation>Value is Required	The component must be specified. Check this to require the user to enter a value.
rows	Size: Height	Specifies the number of rows displayed at runtime.
style	Style: Props	Specifies CSS style information for the component (for example, style="font-size : 8pt ; color : red"). Defines the properties (such as font and color) of the selected component. This may be done manually, or by clicking the button and selecting the desired properties from within the window.
styleClass	Style: Classes	Space-separated list of CSS style classes to be applied when this element is rendered. This value must be passed through as the class attribute on generated markup. Defines the classes (such as style sheets) of the selected component. This may be done manually, or by clicking the button and selecting the desired Classes from within the window.
tabindex	Accessibility>Tab order index	Specifies the position of the component in the tabbing order in the JSP. This value must be a number between 0 and 32767.
title	Accessibility>Title	Specifies the title text, shown in browser as a tooltip at runtime. Used by a browser as the alternative text of a component if the alternative text is not specified.
validator	Not represented	A method (represented by a MethodBinding expression) that accepts FacesContext, UIComponent, and Object parameters. It is called during the validation process to ensure that value of the component is correct.
value	Value	Specifies the initial text value for the component displayed at runtime. Contains information to be displayed, in the form of a specified value or a pointer to a dynamic value.
valueChangeListener	Not represented	Method to be notified when value of component has changed.