Checkbox

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

Checkbox is a standard input component that can have two states: checked and unchecked.

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

Properties

dataProviderID

Type: dataprovider


enabled

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

Type: tabseq


text

Type: tagstring Default Value: "Checkbox"


toolTipText

Type: tagstring


visible

Whether the button is visible or not

Type: visible


Events

onActionMethodID

Click event. dataTarget parameter is used to identify inner html elements (by their data-target attribute)

Parameters:

event JSEvent dataTarget string


onDataChangeMethodID

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:

oldValue ${dataproviderType} newValue ${dataproviderType} event JSEvent

Returns: boolean


onFocusGainedMethodID

Parameters:

event JSEvent


onFocusLostMethodID

Parameters:

event JSEvent


API

requestFocus

Request the focus to this checkbox.

@example

myElement.requestFocus();

@param mustExecuteOnFocusGainedMethod (optional) if false will not execute the onFocusGained method; the default value is true

Parameters:

mustExecuteOnFocusGainedMethod boolean (optional)



Last updated