Overview
The <crm:inputSwitch> tag is used to display an input element on the page that allows user to select a boolean value.
Attributes
Name | Required | Type | Default | Description | ||
---|---|---|---|---|---|---|
columnClasses | false | String | ui-grid-col-12 | Comma separated list of column style classes of the gird layout that will be used to display the component.
| ||
columns | false | Integer | 1 | Number of columns of the gird layout that will be used to display the component. | ||
disabled | false | Boolean | false | Flag indicating that component is disabled or not. | ||
id | true | String | Null | Unique identifier of the component. | ||
labelKey | false | String | null | A valid key defined in translation properties file. Its translation through the glossary will be used as the presentable name of the component. | ||
managedBean | true | String | null | The name of the managed bean that will be used for retrieving the component values. | ||
mode | false | String | The mode of the managed bean. | The mode of the component. Allowed values are VIEW and EDIT. | ||
onChangeFunction | false | String | null | Defines the function call triggered when input element loses focus and its value has been modified since gaining focus. | ||
parameters | false | Object | null | Defines the parameter of the function call. | ||
process | false | String | @this and the value of the refresh attribute | Component(s) to process in partial request. | ||
readonly | false | Boolean | false | Flag indicating that this component will prevent changes by the user. | ||
refresh | false | String | @this | Component(s) to update with ajax. | ||
tip | false | String | null | A valid key defined in translation properties file. Its translation through the glossary will be used as an advisory tooltip information. | ||
value | true | Object | null | The value of the component. | ||
visible | false | Boolean | true | Controls the visibility of the component. |
Getting Started
The following example shows an input switch component.