Checkbox
(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
dataProviderID
Checkbox is a standard input component that can have two states: checked and unchecked. Type: Dataprovider
enabled
Flag indicating whether the checkbox is enabled for user interaction. Type: Enabled Default Value: true
selectedValue
The value returned when the checkbox is checked (default is 1) Type: String
showAs
Option whether checkbox 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
text
The text label displayed next to the checkbox. Type: Tagstring Default Value: "Checkbox"
toolTipText
Tooltip text displayed when hovering over the checkbox. Type: Tagstring
visible
Whether the button is visible or not Type: Visible
Events
onActionMethodID(event,dataTarget)
Click event. dataTarget parameter is used to identify inner html elements (by their data-target attribute)
Parameters:
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)
@param {JSEvent} event The event object containing details about the focus gained event (e.g. target element, timestamp)
Parameters:
{JSEvent} event
onFocusLostMethodID(event)
@param {JSEvent} event The event object containing details about the focus lost event (e.g. target element, timestamp)
Parameters:
{JSEvent} event
API
requestFocus(mustExecuteOnFocusGainedMethod)
Request the focus to this checkbox.
Example:
myElement.requestFocus();
Parameters:
{Boolean} [mustExecuteOnFocusGainedMethod] If false will not execute the onFocusGained method; the default value is true
Last updated
Was this helpful?