The MobileTextArea widget represents a text box that allows multiple lines of text. It is useful for adding comments and feedback.


  • UI Type:

Extends: BaseWidget

Properties

Name Desciption
DisabledThe widget cannot be used.
Display LimitDisplays the remaining Character Allowed for User to type.
HiddenHides the widget from the user.
LabelText label shown on the widget.
Label StyleSet how the text should be displayed.
Maximum LengthSet the maximum length of text which can be entered.
PlaceholderValue to display until the user has entered something. This can provide the user with a clue as to what type of information is requested in the field.
ResizableSet this widget to be resizable.
RowsSet how many rows should be visible in the text area.
Speech InputEnables speech to text via voice record. Limited to browser capabilities.
Speech TimeoutTimout value in ms.
Spell CheckEnable/Disable spell check for textarea.
Tab IndexThe Tab Index is an integer that tells the order of the widget when using the tab-key to move from one widget to another.

Style

Name Desciption
Background-colorChange background color of the widget.
Border colorAdd the color for the border.
Border radiusAdd curves to the borders of the widget.
Border styleThe style of the border whether it is solid, dotted or dashed.
Border widthDefine the border width in pixels for the widget.
ColorColor of the text inside the widgets. May not apply to all text inside all widgets.
Font SizeSet the font size in pixels for text.
Label colorThe text color of the label.
Margin (left right)Generate space in the left and right area of the widget.
Margin (top bottom)Generate space in the top and bottom area of the widget.
Speech icon backgroundWhen Speech input is enabled, a microphone icon gets enabled in the text area, this lets us change the background color of the speech icon.
Text-alignmentSet left, centered or right. Applies both to icon and text.

Events

Name Description Event Attribute
Blur Event when a widget goes out of focus
event The event that gets triggered when the user "leaves" an element.
Change Event triggered after the element has finished changing
event The current value of the text area
Click Event that triggers based on touch or click
event The event that triggered the handler
DblClick Event that triggers based on double click
event The event that triggered the handler
Focus Event when indicating/ highlighting widget using the cursor
event Focus is the event that gets triggered when a user makes an element come into focus, by clicking on it.
KeyDown Triggered when the user is pressing a key on the element
event Object with information about the code (event.code), key (event.key) and key code (event.keyCode) that triggered the event
KeyPress Event triggered when a keypress event occurs on the element
event Object with information about the code (event.code), key (event.key) and key code (event.keyCode) that triggered the event
KeyUp Event triggered to an element when the user releases a key on the keyboard
event Object with information about the code (event.code), key (event.key) and key code (event.keyCode) that triggered the event

Function

blur ( )

Triggers the blur event.

focus ( )

Triggers the focus event.

get ( name: String ) { Object }

Gets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
Returns

The property's value.

getId ( ) { ID }

Returns the ID of the widget.

Returns

The ID of the widget

getValue ( ) { Object }

Returns the widget's value.

Returns

The widget's value.

hide ( )

Hides the widget.

isEnabled ( ) { Boolean }

Returns true if the widget is enabled.

Returns

True if enabled, otherwise false.

isHidden ( ) { Boolean }

Returns true if the widget is hidden.

Returns

True if hidden, otherwise false.

set ( name: String , value: Object )

Sets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
value Object The new value.

setEnabled ( Enabled: Boolean )

Enables/disables the widget.

Parameters
Name Type Description
Enabled Boolean True to enable the widget, false to disable.

setStyle ( Object: Object )

Set the widget-style

Parameters
Name Type Description
Object Object properties

setValue ( value: Object )

Sets the widget's value.

Parameters
Name Type Description
value Object The new value.

show ( )

Shows the widget.