TextArea

LIVE DEMO

TextArea is a multi-line text editor field.

Component’s XML-name: textArea.

Basics

TextArea mostly replicates the functionality of the TextField component.

An example of the TextArea:

<textArea id="textArea"
          rows="7"
          caption="Text area with 7 rows"/>
text area

Attributes

TextArea has the following specific attributes:

  • rows - set the number of rows of text. The value of height has priority over the value of rows.

  • wordWrap - set this attribute to false to turn off word wrapping.

Events and Handlers

To generate a handler stub in Jmix Studio, select the component in the screen descriptor XML or in the Component Hierarchy panel and use the Handlers tab of the Component Inspector panel.

Alternatively, you can use the Generate Handler button in the top panel of the screen controller.

ContextHelpIconClickEvent

See ContextHelpIconClickEvent.

TextChangeEvent

See TextChangeEvent.

Validator

See Validator.

ValueChangeEvent

See ValueChangeEvent.

Styles

Styling is identical to TextField component.

TextArea XML Attributes

You can view and edit attributes applicable to the component using the Component Inspector panel of the Studio’s Screen Designer.

align - buffered - caption - captionAsHtml - caseConversion - colspan - contextHelpText - contextHelpTextHtmlEnabled - conversionErrorMessage - css - dataContainer - datatype - description - descriptionAsHtml - editable - enable - box.expandRatio - height - htmlSanitizerEnabled - icon - id - inputPrompt - maxLength - property - required - requiredMessage - responsive - rows - rowspan - stylename - tabIndex - textChangeEventMode - textChangeTimeout - trim - visible - width - wordWrap

TextArea XML Element

validators