The <crm:selectCheckboxMenu> tag is used to display an element on the page that allows user to select multiple items from a list in an overlay.
Attributes
| Name | Required | Type | Default | Description |
|---|---|---|---|---|
| additionalLabel | false | String | null | Additional Label of the item. |
| className | false | String | null | The class name of the value of the component. |
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. 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". |
| columns | false | Integer | 1 | Number of columns of the gird layout that will be used to display the component. |
| displayValue | false | String | null | The displayed value of the component in view mode. |
| executeOnOnhide | false | String | refresh | Defines the function call triggered when overlay is hidden. |
| filter | false | Boolean | true | Renders an input field as a filter in select components. |
| id | false | String | null | Unique identifier of the component. |
| itemLabel | false | String | name | Label of the item in overlay. |
| 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. |
| mandatory | false | Boolean | false | Marks component as required. |
| 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. |
| optionsList | false | List | null | A collection of available items in overlay. |
| placeholder | false | String | key_select | A valid key defined in translation properties file. Its translation through the glossary will be used as a short hint that describes the expected value of this input element. |
| 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 | @form | Component(s) to update with ajax. |
| selectedValues | false | List | null | A collection of selected items in overlay. |
| 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. |
| type | false | String | null | The type of the value of the component. |
| value | false | Object | null | The value of the component. |
| visible | false | Boolean | true | Controls the visibility of the component. |
Getting Started
The following example shows a select checkbox menu component.