Input Group

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

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

Properties

addOnButtons

Type: Array<CustomType<bootstrapextracomponents-input-group.AddOnButton>>

---

addOns

Type: Array<CustomType<bootstrapextracomponents-input-group.AddOn>>

---

dataProvider

Type: Dataprovider

---

editable

Type: Protected Default Value: true

---

enabled

Type: Enabled Default Value: true

---

format

Type: Format

---

inputType

Type: String Default Value: "text"

---

placeholderText

Type: String

---

readOnly

Type: Protected Default Value: false

---

styleClass

Type: Styleclass

---

tabSeq

Type: Tabseq

---

toolTipText

Type: String

---

visible

Type: Visible

---

Events

onAction(event)

Parameters:

• {JSEvent} event

---

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) - present since 2021.06 release

Parameters:

• {${dataproviderType}} oldValue

• {${dataproviderType}} newValue

• {JSEvent} event

Returns: {Boolean}

---

onFocusGainedMethodID(event)

Parameters:

• {JSEvent} event

---

onFocusLostMethodID(event)

Parameters:

• {JSEvent} event

---

onRightClick(event)

Parameters:

• {JSEvent} event

---

API

addAddOn(addOn)

Adds an addOn to this input group

AddOn has the following properties:

text - the text of the item position - LEFT or RIGHT (defaults to LEFT)

Parameters:

• {CustomType<bootstrapextracomponents-input-group.AddOn>} addOn - object with text, position (LEFT, RIGHT)

---

addAddOnButton(addOnButton)

Adds an addOnButton to this input group

AddOnButton has the following properties:

text - the button text position - LEFT or RIGHT (defaults to RIGHT) onAction - function to be called on button click onDoubleClick - function to be called on button double click onRightClick - function to be called on button right click styleClass - the style class of the button (e.g. btn-danger) imageStyleClass - image style class of the button

Parameters:

• {CustomType<bootstrapextracomponents-input-group.AddOnButton>} addOnButton AddButtonOnToAdd

---

clearAddOnButtons()

Removes all addOnButtons from this input group

---

clearAddOns()

Removes all addOns from this input group

---

requestFocus()

Request the focus to this text field.

Example:

myElement.requestFocus();

---

setAddOnButtons(addOnButtons)

Sets all addOnButtons of this input group

AddOnButton has the following properties:

text - the button text position - LEFT or RIGHT (defaults to RIGHT) onAction - function to be called on button click onDoubleClick - function to be called on button double click onRightClick - function to be called on button right click styleClass - the style class of the button (e.g. btn-danger) imageStyleClass - image style class of the button

Parameters:

• {Array<AddOnButton>} addOnButtons An array of AddOnButton objects to configure the input group's buttons, each with properties such as text, position, event handlers, and styling.

---

setAddOns(addOns)

Sets all addOns of this input group

AddOn has the following properties:

text - the text of the item position - LEFT or RIGHT (defaults to LEFT)

Parameters:

• {Array<AddOn>} addOns AddOns - Array of objects with text, position (LEFT, RIGHT)

---

Types

AddOn

scripting type: CustomType<bootstrapextracomponents-input-group.AddOn>

• attributes

  • Type: map

• position

  • Type: string

  • Default Value: "LEFT"

• text

  • Type: tagstring

AddOnButton

scripting type: CustomType<bootstrapextracomponents-input-group.AddOnButton>

• attributes

  • Type: map

• imageStyleClass

  • Type: styleclass

• name

  • Type: string

• onAction

  • Type: function

• onDoubleClick

  • Type: function

• onRightClick

  • Type: function

• position

  • Type: string

  • Default Value: "RIGHT"

• styleClass

  • Type: styleclass

  • Default Value: "btn-default"

• text

  • Type: tagstring

---