crm:selectCheckboxMenuWithIcon

Overview

The <crm:selectCheckboxMenuWithIcon> tag is used to display an element on the page that allows user to select multiple items with icon from a list in an overlay.

Attributes

NameRequiredTypeDefaultDescription
classNamefalseStringnullThe class name of the value of the component.

columnClasses

falseStringui-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".

columnsfalseInteger1

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

databaseNamefalseStringnullDatabase name that will be used to load the data.
displayValuefalseStringnullThe displayed value of the component in view mode.
executeOnOnhidefalseStringrefreshDefines the function call triggered when overlay is hidden.
iconfalseStringnull

Icon of the button.

Use font awesome icon class supported by version 4.7.0.

idfalseStringnullUnique identifier of the component.
itemLabelfalseStringnameLabel of the item in overlay.
labelKeyfalseStringnull

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

managedBeantrueStringnullThe name of the Java managed bean class that will be used for retrieving the component values.
mandatoryfalseBooleanfalseMarks component as required.
modefalseStringThe mode of the managed bean.

The mode of the component. 

Allowed values are VIEW and EDIT.

onChangeFunctionfalseStringnull

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

optionsListfalseListnull

A collection of available items in overlay.


placeholderfalseStringkey_selectA 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.
processfalseString@this and the value of the refresh attributeComponent(s) to process in partial request.
readonlyfalseBooleanfalseFlag indicating that this component will prevent changes by the user.
refreshfalseString@formComponent(s) to update with ajax.
selectedValuesfalseListnullA collection of selected items in overlay.
tipfalseStringnull

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

valuefalseObjectnullThe value of the component.
visiblefalseBooleantrue

Controls the visibility of the component.


Getting Started

The following example shows a select checkbox menu with icon component.