# com.bea.wlw.netui.tags.html
TextArea Class

public class TextArea
extends `DefaultableDataSourceTag`
implements `Formattable`, `IAttributeConsumer`

Renders a databound TextArea with the given attributes.

Attribute Descriptions
Attribute | Required | Runtime Expression Evaluation | Data Bindable
--- | --- | --- | ---
accessKey | No | No | No
Define the keyboard navigation key for the element.
cols | No | No | Read Only
The number of columns in the TextArea
dataSource | Yes | No | Read / Write
The name of a form bean property or an expression that contains the TextArea state.
defaultValue | No | No | Read Only
A literal value or an expression that is used to set the TextArea's initial state. The default value is applied only if the dataSource returns null.
disabled | No | No | Read Only
A boolean specifying whether the TextArea is disabled.
readOnly | No | No | No
A boolean specifying whether the TextArea is read-only.
rows | No | No | Read Only
The number of rows in the TextArea.
tagId | No | No | No
The ID of this textarea used by the enclosing html tag to get the tag's name for JavaScript and focus purposes.

Related Topics

<netui:textArea> Sample

Hierarchy
  `Object`
  `TagSupport`
  `BodyTagSupport`
  `AbstractBaseTag`
  `DataSourceTag`
  `DefaultableDataSourceTag`
  `TextArea`

All Implemented Interfaces
  `BodyTag`, `Formattable`, `IAttributeConsumer`, `IterationTag`, `Serializable`, `Tag`

## Field Summary

`protected `String`` | `cols` The number of columns in the TextArea.
`public static final `String`` | `COLS` String
`protected `String`` | `disabled` Whether or not the TextArea is disabled
`public static final `String`` | `DISABLED` String
`protected `ArrayList`` | `formatters` ArrayList
`protected boolean` | `readonly` The read-only status of the TextArea
`public static final `String`` | `READONLY` String
`protected `String`` | `rows` The number of row in the TextArea
`public static final `String`` | `ROWS` String

Fields from com.bea.wlw.netui.tags`.`AbstractBaseTag``
``ATTR_GENERAL`, `ATTR_GENERAL_EXPRESSION`, `ATTR_JAVASCRIPT`, `ATTR_STYLE`, `CLASS`, `ID`, `JAVASCRIPT_STATUS`, `NAME`, `NETUI_UNIQUE_CNT`, `ONCLICK`, `ONDBLCLICK`, `ONKEYDOWN`, `ONKEYPRESS`, `ONKEYUP`, `ONMOUSEDOWN`, `ONMOUSEMOVE`, `ONMOUSEOUT`, `ONMOUSEOVER`, `ONMOUSEUP`, `STYLE`, `TABINDEX``

Fields from javax.servlet.jsp.tagext`.`BodyTagSupport``
`bodyContent`

Fields from javax.servlet.jsp.tagext`.`TagSupport``
`id, pageContext`

Fields from interface javax.servlet.jsp.tagext`.`BodyTag``
`EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

Fields from interface javax.servlet.jsp.tagext`.`IterationTag``
`EVAL_BODY_AGAIN`

Fields from interface javax.servlet.jsp.tagext`.`Tag``
`EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

## Constructor Summary

TextArea()

## Method Summary

`public void` | `addFormatter`(`FormatTag.Formatter` formatter) Adds a FormatTag.Formatter to the TextArea's set of formatters
`public int` | `doEndTag`() Render the TextArea.
`public int` | `doStartTag`() Prepare the TextArea's formatters.
`public `String`` | `getAccessKey`() Gets the accessKey attribute value.
`public `String`` | `getCols`() Gets the number of columns in the TextArea.
`public `String`` | `getDisabled`() Gets if this TextArea is disabled or not.
`public `String`` | `getOnBlur`() Gets the onBlur javascript event.
`public `String`` | `getOnChange`() Gets the onChange javascript event.
`public `String`` | `getOnClick`() Gets the onClick javascript event.
`public `String`` | `getOnDblClick`() Gets the onDblClick javascript event.
`public `String`` | `getOnFocus`() Gets the onFocus javascript event.
`public `String`` | `getOnKeyDown`() Gets the onKeyDown javascript event.
`public `String`` | `getOnKeyPress`() Gets the onKeyPress javascript event.
`public `String`` | `getOnKeyUp`() Gets the onKeyUp javascript event.
`public `String`` | `getOnMouseDown`() Gets the onMouseDown javascript event.
`public `String`` | `getOnMouseMove`() Gets the onMouseMove javascript event.
`public `String`` | `getOnMouseOut`() Gets the onMouseOut javascript event.
`public `String`` | `getOnMouseOver`() Gets the onMouseOver javascript event.
`public `String`` | `getOnMouseUp`() Gets the onMouseUp javascript event.
`public `String`` | `getOnSelect`() Gets the onSelect javascript event.
`public boolean` | `getReadonly`() Gets if this TextArea is read-only.
`public `String`` | `getRows`() Gets the number of rows in the TextArea.
`public `String`` | `getStyle`() Gets the style of the rendered html tag.
`public `String`` | `getStyleClass`() Gets the style class of the rendered html tag.
`public `String`` | `getTabindex`() Gets the tabIndex of the rendered html tag.
`public `String`` | `getTagId`() Return the ID of the textarea.
`public `String`` | `getTagName`() Return the name of the Tag.
`protected void` | `localRelease`() Release any acquired resources.
`public void` | `setAccessKey`(`String` accessKey) Sets the accessKey attribute value.
`public void` | `setAttribute`(`String` name, `String` value) Set an attribute value.
`public void` | `setCols`(`String` cols) Sets the number of columns in the TextArea.
`public void` | `setDisabled`(`String` disabled) Set if this TextArea is disabled or not.
`public void` | `setOnBlur`(`String` onblur) Sets the onBlur javascript event.
`public void` | `setOnChange`(`String` onchange) Sets the onChange javascript event.
`public void` | `setOnClick`(`String` onclick) Sets the onClick javascript event.
`public void` | `setOnDblClick`(`String` ondblclick) Sets the onDblClick javascript event.
`public void` | `setOnFocus`(`String` onblur) Sets the onFocus javascript event.
`public void` | `setOnKeyDown`(`String` onkeydown) Sets the onKeyDown javascript event.
`public void` | `setOnKeyPress`(`String` onkeypress) Sets the onKeyPress javascript event.
`public void` | `setOnKeyUp`(`String` onkeyup) Sets the onKeyUp javascript event.
`public void` | `setOnMouseDown`(`String` onmousedown) Sets the onMouseDown javascript event.
`public void` | `setOnMouseMove`(`String` onmousemove) Sets the onMouseMove javascript event.
`public void` | `setOnMouseOut`(`String` onmouseout) Sets the onMouseOut javascript event.
`public void` | `setOnMouseOver`(`String` onmouseover) Sets the onMouseOver javascript event.
`public void` | `setOnMouseUp`(`String` onmouseup) Sets the onMouseUp javascript event.
`public void` | `setOnSelect`(`String` onselect) Sets the onSelect javascript event.
`public void` | `setReadonly`(boolean readonly) Set if this TextArea is read-only.
`public void` | `setRows`(`String` rows) Sets the number of rows in the TextArea.
`public void` | `setStyle`(`String` style) Sets the style of the rendered html tag.
`public void` | `setStyleClass`(`String` styleClass) Sets the style class of the rendered html tag.
`public void` | `setTabindex`(`String` tabindex) Sets the tabIndex of the rendered html tag.
`public void` | `setTagId`(`String` tagId) Set the ID of the textarea.

Methods from `com.bea.wlw.netui.tags.`DefaultableDataSourceTag``
``getDefaultValue`, `setDefaultValue``

Methods from `com.bea.wlw.netui.tags.`DataSourceTag``
``getDataSource`, `localRelease`, `setDataSource``

Methods from `com.bea.wlw.netui.tags.`AbstractBaseTag``
``addTagIdMapping`, `evaluateAttributeToString`, `filter`, `filter`, `getJavaScriptUtils`, `getNearestForm`, `getScriptReporter`, `getUserLocale`, `localRelease`, `registerTagError`, `release`, `renderAttribute`, `rewriteName`, `write``

Methods from `javax.servlet.jsp.tagext.`BodyTagSupport``
`doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

Methods from `javax.servlet.jsp.tagext.`TagSupport``
`doAfterBody, doEndTag, doStartTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue`

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods from interface `javax.servlet.jsp.tagext.`BodyTag``
`doInitBody, setBodyContent`

Methods from interface `com.bea.wlw.netui.tags.html.`Formattable``
``addFormatter``

Methods from interface `com.bea.wlw.netui.tags.`IAttributeConsumer``
``setAttribute``

Methods from interface `javax.servlet.jsp.tagext.`IterationTag``
`doAfterBody`

Methods from interface `javax.servlet.jsp.tagext.`Tag``
`doEndTag, doStartTag, getParent, release, setPageContext, setParent`

## Field Detail

### cols

    protected String cols

  The number of columns in the TextArea.

### COLS

    public static final String COLS

### disabled

    protected String disabled

  Whether or not the TextArea is disabled

### DISABLED

    public static final String DISABLED

### formatters

    protected ArrayList formatters

### readonly

    protected boolean readonly

  The read-only status of the TextArea

### READONLY

    public static final String READONLY

### rows

    protected String rows

  The number of row in the TextArea

### ROWS

    public static final String ROWS

## Constructor Detail

### TextArea

    public TextArea()

## Method Detail

### addFormatter(FormatTag.Formatter) Method

    public void addFormatter(FormatTag.Formatter formatter)

Adds a FormatTag.Formatter to the TextArea's set of formatters

#### Parameters

formatter
  - a FormatTag.Formatter added by a child FormatTag.

### doEndTag() Method

    public int doEndTag()
         throws JspException

Render the TextArea.

Overrides
  `BodyTagSupport.doEndTag()`

#### Exceptions

``JspException``
  if a JSP exception has occurred

### doStartTag() Method

    public int doStartTag()
         throws JspException

Prepare the TextArea's formatters.

Overrides
  `BodyTagSupport.doStartTag()`

#### Exceptions

``JspException``
  if a JSP exception has occurred

### getAccessKey() Method

    public String getAccessKey()

Gets the accessKey attribute value.

#### Returns

the accessKey value.

### getCols() Method

    public String getCols()

Gets the number of columns in the TextArea.

#### Returns

the number of columns

### getDisabled() Method

    public String getDisabled()

Gets if this TextArea is disabled or not.

#### Returns

the disabled state (true or false)

### getOnBlur() Method

    public String getOnBlur()

Gets the onBlur javascript event.

#### Returns

the onBlur event.

### getOnChange() Method

    public String getOnChange()

Gets the onChange javascript event.

#### Returns

the onChange event.

### getOnClick() Method

    public String getOnClick()

Gets the onClick javascript event.

#### Returns

the onClick event.

### getOnDblClick() Method

    public String getOnDblClick()

Gets the onDblClick javascript event.

#### Returns

the onDblClick event.

### getOnFocus() Method

    public String getOnFocus()

Gets the onFocus javascript event.

#### Returns

the onFocus event.

### getOnKeyDown() Method

    public String getOnKeyDown()

Gets the onKeyDown javascript event.

#### Returns

the onKeyDown event.

### getOnKeyPress() Method

    public String getOnKeyPress()

Gets the onKeyPress javascript event.

#### Returns

the onKeyPress event.

### getOnKeyUp() Method

    public String getOnKeyUp()

Gets the onKeyUp javascript event.

#### Returns

the onKeyUp event.

### getOnMouseDown() Method

    public String getOnMouseDown()

Gets the onMouseDown javascript event.

#### Returns

the onMouseDown event.

### getOnMouseMove() Method

    public String getOnMouseMove()

Gets the onMouseMove javascript event.

#### Returns

the onMouseMove event.

### getOnMouseOut() Method

    public String getOnMouseOut()

Gets the onMouseOut javascript event.

#### Returns

the onMouseOut event.

### getOnMouseOver() Method

    public String getOnMouseOver()

Gets the onMouseOver javascript event.

#### Returns

the onMouseOver event.

### getOnMouseUp() Method

    public String getOnMouseUp()

Gets the onMouseUp javascript event.

#### Returns

the onMouseUp event.

### getOnSelect() Method

    public String getOnSelect()

Gets the onSelect javascript event.

#### Returns

the onSelect event.

### getReadonly() Method

    public boolean getReadonly()

Gets if this TextArea is read-only.

#### Returns

the read-only state

### getRows() Method

    public String getRows()

Gets the number of rows in the TextArea.

#### Returns

the number of rows

### getStyle() Method

    public String getStyle()

Gets the style of the rendered html tag.

#### Returns

the style.

### getStyleClass() Method

    public String getStyleClass()

Gets the style class of the rendered html tag.

#### Returns

the style class.

### getTabindex() Method

    public String getTabindex()

Gets the tabIndex of the rendered html tag.

#### Returns

the tabindex.

### getTagId() Method

    public String getTagId()

Return the ID of the textarea.

#### Returns

the ID.

### getTagName() Method

    public String getTagName()

Return the name of the Tag.

Overrides
  `AbstractBaseTag.getTagName()`

### localRelease() Method

    protected void localRelease()

Release any acquired resources.

Overrides
  `DefaultableDataSourceTag.localRelease()`

### setAccessKey(String) Method

    public void setAccessKey(String accessKey)

Sets the accessKey attribute value. This should key value of the keyboard navigation key. It is recommended not to use the following values because there are often used by browsers `A, C, E, F, G, H, V, left arrow, and right arrow`.

#### Parameters

accessKey
  - the accessKey value.

### setAttribute(String, String) Method

    public void setAttribute(String name,
                             String value)
         throws JspException

Set an attribute value. The `name` represents the name of the attribute. The `value` represents the value and may contain a netui expression. This method may result in errors being generated. This requires that the tag buffer its body and write attributes in the end tag. For the textarea tag it is not legal to set the `id` or `name` attributes with this method.

#### Parameters

name
  The name of the attribute. This value may not be null or the empty string.

value
  The value of the attribute. This may contain a netui expression.

#### Exceptions

``JspException``
  A JspException may be thrown if there is an error setting the attribute.

### setCols(String) Method

    public void setCols(String cols)

Sets the number of columns in the TextArea.

#### Parameters

cols
  - the number of columns

### setDisabled(String) Method

    public void setDisabled(String disabled)

Set if this TextArea is disabled or not.

#### Parameters

disabled
  - true or false

### setOnBlur(String) Method

    public void setOnBlur(String onblur)

Sets the onBlur javascript event.

#### Parameters

onblur
  - the onBlur event.

### setOnChange(String) Method

    public void setOnChange(String onchange)

Sets the onChange javascript event.

#### Parameters

onchange
  - the onChange event.

### setOnClick(String) Method

    public void setOnClick(String onclick)

Sets the onClick javascript event.

#### Parameters

onclick
  - the onClick event.

### setOnDblClick(String) Method

    public void setOnDblClick(String ondblclick)

Sets the onDblClick javascript event.

#### Parameters

ondblclick
  - the onDblClick event.

### setOnFocus(String) Method

    public void setOnFocus(String onblur)

Sets the onFocus javascript event.

#### Parameters

onblur
  - the onFocus event.

### setOnKeyDown(String) Method

    public void setOnKeyDown(String onkeydown)

Sets the onKeyDown javascript event.

#### Parameters

onkeydown
  - the onKeyDown event.

### setOnKeyPress(String) Method

    public void setOnKeyPress(String onkeypress)

Sets the onKeyPress javascript event.

#### Parameters

onkeypress
  - the onKeyPress event.

### setOnKeyUp(String) Method

    public void setOnKeyUp(String onkeyup)

Sets the onKeyUp javascript event.

#### Parameters

onkeyup
  - the onKeyUp event.

### setOnMouseDown(String) Method

    public void setOnMouseDown(String onmousedown)

Sets the onMouseDown javascript event.

#### Parameters

onmousedown
  - the onMouseDown event.

### setOnMouseMove(String) Method

    public void setOnMouseMove(String onmousemove)

Sets the onMouseMove javascript event.

#### Parameters

onmousemove
  - the onMouseMove event.

### setOnMouseOut(String) Method

    public void setOnMouseOut(String onmouseout)

Sets the onMouseOut javascript event.

#### Parameters

onmouseout
  - the onMouseOut event.

### setOnMouseOver(String) Method

    public void setOnMouseOver(String onmouseover)

Sets the onMouseOver javascript event.

#### Parameters

onmouseover
  - the onMouseOver event.

### setOnMouseUp(String) Method

    public void setOnMouseUp(String onmouseup)

Sets the onMouseUp javascript event.

#### Parameters

onmouseup
  - the onMouseUp event.

### setOnSelect(String) Method

    public void setOnSelect(String onselect)

Sets the onSelect javascript event.

#### Parameters

onselect
  - the onSelect event.

### setReadonly(boolean) Method

    public void setReadonly(boolean readonly)

Set if this TextArea is read-only.

#### Parameters

readonly
  - the read-only state

### setRows(String) Method

    public void setRows(String rows)

Sets the number of rows in the TextArea.

#### Parameters

rows
  - the number of rows

### setStyle(String) Method

    public void setStyle(String style)

Sets the style of the rendered html tag.

#### Parameters

style
  - the html style.

### setStyleClass(String) Method

    public void setStyleClass(String styleClass)

Sets the style class of the rendered html tag.

#### Parameters

styleClass
  - the html style class.

### setTabindex(String) Method

    public void setTabindex(String tabindex)

Sets the tabIndex of the rendered html tag.

#### Parameters

tabindex
  - the tab index.

### setTagId(String) Method

    public void setTagId(String tagId)

Set the ID of the textarea.

#### Parameters

tagId
  - the ID.