TextBox

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

TextBox is a text input component styled with Bootstrap. It allows users to enter single-line text values. The component supports various input types (e.g. text, password, email, etc.) and includes features such as autocomplete and error messaging.

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

Properties

autocomplete

Html autocomplete property of the input field. Type: String Default Value: "off"

---

dataProviderID

Bound data provider identifier for the text field value. Type: Dataprovider

---

editable

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

---

enabled

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

---

format

Format string used to display and parse the text box value. Type: Format

---

inputType

The type of input for the text field (e.g. text, password, email, tel, etc.). Type: String Default Value: "text"

---

placeholderText

Placeholder text displayed when the text box is empty. Type: Tagstring

---

selectOnEnter

Indicates whether the text box content should be automatically selected when the field gains focus. Type: Boolean

---

styleClass

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

---

styleClassForEye

Set the styleclasses for the eye when inputType on this component is password-with-eye, you need to add main(not manadatory), eye and eye-slash classes in this order, default value for NG is 'glyphicon glyphicon-eye-open glyphicon-eye-close' and for TiNG 'fa fa-eye fa-eye-slash' Type: Styleclass

---

tabSeq

Tab sequence order for keyboard navigation. Type: Tabseq

---

toolTipText

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

---

visible

Whether the button is visible or not Type: Visible

---

Events

onActionMethodID(event)

Fired when the text box action is triggered (for example, when the Enter key is pressed).

Parameters:

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

---

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:

• {${dataproviderType}} oldValue The previous value from the data provider

• {${dataproviderType}} newValue The new value to be set in the data provider

• {JSEvent} event The event object associated with the data change

Returns: {Boolean}

---

onFocusGainedMethodID(event)

Fired when the text box 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 text box 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 text box 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 text field.

Example:

myElement.requestFocus();

Parameters:

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

---

setInputType(inputType)

Reset the dataProvider to null and change the inputType of the textbox. Note: the value of the dataProvider bound to this field will be automatically set to null

Example:

myElement.inputType("tel");

Parameters:

• {String} inputType Allowed values for inputType are text, password, email, tel, date, time, datetime-local, month, week, number, color

Returns: Boolean True if the inputType was successfully changed and the dataProvider was reset to null; false otherwise.

---

---