Floatinglabel Textarea

(part of package 'Bootstrap Components') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent

TextArea is a multi-line text input component that allows users to enter and edit text.

This is a reference page; many components have detailed usage guides here.

Properties

dataProviderID

Bound data provider identifier for the textarea's value. Type: Dataprovider


editable

Flag indicating whether the textarea is editable. Type: Protected Default Value: true


enabled

Flag indicating whether the textarea is enabled for user interaction. Type: Enabled Default Value: true


errorMessage

Error message displayed when the input value is invalid or fails validation. Type: Tagstring


floatLabelText

The text displayed as a floating label when the typeahead input is focused or contains a value. Type: Tagstring


maxLength

Maximum length allowed for the textarea input. Type: Number


styleClass

Set the styleclasses that should be applied at to this component Type: Styleclass Default Value: "form-control"


tabSeq

Tab sequence order for keyboard navigation. Type: Tabseq


toolTipText

Tooltip text displayed when hovering over the textarea. Type: Tagstring


visible

Whether the button is visible or not Type: Visible


Events

onActionMethodID(event)

Fired when an action is triggered on the textarea.

Parameters:

  • {JSEvent} event The event object containing details about the action event e.g. target element, event type


onDataChangeMethodID(oldValue,newValue,event)

Handle changed data, return false if the value should not be accepted. JSEvent.data will contain extra information about dataproviderid, its scope and the scope id (record datasource or form/global variable scope)

Parameters:

Returns: {Boolean}


onFocusGainedMethodID(event)

Fired when the textarea gains focus.

Parameters:

  • {JSEvent} event The event object containing details about the focus gained event e.g. target element, timestamp


onFocusLostMethodID(event)

Fired when the textarea loses focus.

Parameters:

  • {JSEvent} event The event object containing details about the focus lost event e.g. target element, timestamp


onRightClickMethodID(event)

Fired when the textarea is right-clicked.

Parameters:

  • {JSEvent} event The event object containing details about the right-click event e.g. target element, mouse coordinates


API

requestFocus(mustExecuteOnFocusGainedMethod)

Request the focus to this textarea.

Example:

myElement.requestFocus();

Parameters:

  • {Boolean} [mustExecuteOnFocusGainedMethod] If false will not execute the onFocusGained method; the default value is true


toggleErrorMessage(show)

Toggles the display of the error message for the component.

Parameters:

  • {Boolean} show A flag indicating whether to show (true) or hide (false) the error message.



Last updated

Was this helpful?