Type Ahead

(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

Type: boolean Default Value: true

---

dataProviderID

Type: dataprovider

---

editable

Type: protected Default Value: true

---

enabled

Type: enabled Default Value: true

---

filteringDebounce

Type: int Default Value: 500

---

format

Type: format

---

placeholderText

Type: tagstring

---

selectOnEnter

Type: boolean

---

showAs

Option typeahead options are shown as plain text or sanitized html.

Type: string Default Value: "html"

---

styleClass

Set the styleclasses that should be applied at to this component

Type: styleclass Default Value: "form-control"

---

tabSeq

Type: tabseq

---

toolTipText

Type: tagstring

---

valuelistConfig

Type: valuelistConfig

---

valuelistID

Type: valuelist Default Value: "autoVL"

---

visible

Whether the button is visible or not

Type: visible

---

Events

onActionMethodID(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)

Parameters:

• {${dataproviderType}} oldValue

• {${dataproviderType}} newValue

• {JSEvent} event

Returns: {boolean}

---

onFocusGainedMethodID(event)

Parameters:

• {JSEvent} event

---

onFocusLostMethodID(event)

Parameters:

• {JSEvent} event

---

API

requestFocus(mustExecuteOnFocusGainedMethod)

Request the focus to this typeahead.

Example:

myElement.requestFocus();

Parameters:

• {boolean} [mustExecuteOnFocusGainedMethod] ** mustExecuteOnFocusGainedMethod (optional) if false will not execute the onFocusGained method; the default value is true

---

---