| Info | Value |
|---|---|
| Component Type | org.primefaces.component.SelectCheckboxMenu |
| Handler Class | None |
| Renderer Type | org.primefaces.component.SelectCheckboxMenuRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
appendTo | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Appends the overlay to the element defined by search expression. Defaults to document body. |
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
caseSensitive | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if filtering would be case sensitive. Default is false. |
collectionType | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
|
Optional
attribute that is a literal string that is the fully qualified
class name of a concrete class that implements
java.util.Collection, or an EL expression that
evaluates to either 1. such a String, or 2. the
Class object itself.
|
converter | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
| An el expression or a literal text that defines a converter for the component. When it's an EL expression, it's resolved to a converter instance. In case it's a static text, it must refer to a converter id. |
converterMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when conversion fails. |
disabled | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| No Description |
dynamic | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if dynamic loading is enabled for the element's panel. If the value is "true", the overlay is not rendered on page load to improve performance. Default is false. |
emptyLabel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Label to be shown in updateLabel mode when no item is selected. If not set the label is shown. |
filter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Renders an input field as a filter when enabled. |
filterFunction | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side function to use in custom filterMatchMode. |
filterMatchMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Match mode for filtering, valid values are startsWith (default), contains, endsWith and custom. |
filterNormalize | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if filtering would be done using normalized values (accents will be removed from characters). Default is false. |
filterPlaceholder | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Placeholder text to show when filter input is empty. |
hideNoSelectionOption | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Flag indicating that, if this component is activated by the user, The "no selection option", if any, must be hidden. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
immediate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set true, process validations logic is executed at apply request values phase for this component. Default is false. |
label | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
labelSeparator | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Separator for joining item lables if updateLabel is set to true. Default is ",". |
multiple | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| No Description |
multipleLabel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Label to be shown in updateLabel mode when one or more items are selected. If not set the label is shown. |
onchange | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
onHide | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when overlay is hidden. |
onShow | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when overlay is displayed. |
panelStyle | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the dropdown panel container element. |
panelStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the dropdown panel container element. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
required | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Marks component as required. |
requiredMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when required field validation fails. |
scrollHeight | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines the maximum height of the scrollable area. |
showHeader | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, the header of panel is displayed. Default is true. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
tabindex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the element in the tabbing order. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Advisory tooltip information. |
updateLabel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, the selected items are displayed on label. Default is false. |
validator | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.validator.Validator)
| A method expression referring to a method validating the input. |
validatorMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when validation fails. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the component. |
valueChangeListener | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.event.ValueChangeListener)
| A method binding expression referring to a method for handling a valuchangeevent. |
var | false | java.lang.String | Name of iterator to be used in custom content display. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.