Combobox

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

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

Properties

appendToBody

If true, the combobox is appended to the document body. Type: Boolean Default Value: true

---

dataProviderID

Combobox is a standard input component that allows the user to pick one of the options in it's drop-down list. Type: Dataprovider

---

enabled

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

---

format

Format string used for displaying the combobox value. Type: Format

---

placeholderText

Placeholder text displayed when no value is selected. Type: Tagstring

---

showAs

Defines how the combobox text is rendered (e.g. plain text, sanitized html or trusted html). Type: String

---

styleClass

Set the styleclasses that should be applied at to this component Type: Styleclass

---

tabSeq

Tab sequence order for keyboard navigation. Type: Tabseq

---

toolTipText

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

---

valuelistID

Identifier for the value list that provides the available options. Type: Valuelist

---

visible

Whether the button is visible or not Type: Visible

---

Events

onActionMethodID(event)

Fired when the combobox action is triggered (for example, when an option is selected).

Parameters:

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

---

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 combobox 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 combobox 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 combobox 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 combobox.

Example:

myElement.requestFocus();

Parameters:

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

---

---