Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The <crm:inputSwitch> tag is used to display an input element on the page that allows user to select a boolean value.

Attributes

NameRequiredTypeDefaultDescription

columnClasses

falseStringui-grid-col-12

Comma separated list of column style classes of the gird layout that will be used to display the component.

Note

Column style class should be prefixed with ui-grid-col- and suffixed with the number of columns that content will take (out of 12).

For example, for two columns with the same size the columnClasses should be "ui-grid-col-6,ui-grid-col-6".


columnsfalseInteger1

Number of columns of the gird layout that will be used to display the component.


disabledfalseBooleanfalseFlag indicating that component is disabled or not.
idtrueStringNullUnique identifier of the component.
labelKeyfalseStringnull

A valid key defined in translation properties file. Its translation through the glossary will be used as the presentable name of the component.

managedBeantrueStringnull

The name of the managed bean that will be used for retrieving the component values.

modefalseString The mode of the managed bean.

The mode of the component. 

Note

Allowed values

are VIEW and 

are VIEW and EDIT.


onChangeFunctionfalseString null 

Defines the function call triggered when input element loses focus and its value has been modified since gaining focus.

parametersfalseObject null Defines the parameter of the function call.
processfalseString @this and the value of the refresh attributeComponent(s) to process in partial request.
readonlyfalseBoolean falseFlag indicating that this component will prevent changes by the user.
refreshfalseString@thisComponent(s) to update with ajax.
tipfalseStringnull

A valid key defined in translation properties file. Its translation through the glossary will be used as an advisory tooltip information.

valuetrueObjectnullThe value of the component.
visiblefalseBooleantrue

Controls the visibility of the component.


Getting Started

The following example shows an input switch component.