Choice Group

(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

alignment

Alignment of the choice group options; for example, 'vertical' or 'horizontal'. Type: String Default Value: "vertical"

---

dataProviderID

A choice group input component shows a group of checkboxes, each one for one of the values from a provided value list; it will have in it's attached dataprovider the selected values as a carriage return-separated string. Type: Dataprovider

---

enabled

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

---

inputType

Type of input for the choice group; typically 'checkbox' or 'radio'. Type: String Default Value: "checkbox"

---

showAs

Option whether choice text is shown as plain text, sanitized html or trusted html (as is). Type: String

---

styleClass

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

---

tabSeq

Tab sequence order for keyboard navigation. Type: Tabseq

---

toolTipText

Tooltip text displayed when hovering over the choice group. 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 an action occurs in the choice group such as when the selection changes.

Parameters:

• {JSEvent} event The event object containing details about the action event (e.g. target element, event type)

---

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 choice group 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 choice group loses focus.

Parameters:

• {JSEvent} event The event object containing details about the focus lost event (e.g. target element, timestamp)

---

API

requestFocus(mustExecuteOnFocusGainedMethod)

Request the focus to this choicegroup.

Example:

myElement.requestFocus();

Parameters:

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

---

---