Options
All
  • Public
  • Public/Protected
  • All
Menu

The configuration for the SelectCheckboxMenu widget. You can access this configuration via BaseWidget.cfg. Please note that this configuration is usually meant to be read-only and should not be modified.

Hierarchy

Index

Properties

appendTo: string

The search expression for the element to which the overlay panel should be appended.

behaviors: Record<string, Behavior>

A map with all behaviors that were defined for this widget. The key is the name of the behavior, the value is the callback function that is invoked when the behavior is called.

caseSensitive: boolean

Defines if filtering would be case sensitive.

dynamic: 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.

emptyLabel: string

Label to be shown in updateLabel mode when no item is selected. If not set the label is shown.

filter: boolean

true if the options can be filtered, or false otherwise.

A custom filter function that is used when filterMatchMode is set to custom.

Mode of the filter. When set to custom, a filterFunction must be specified.

filterNormalize: boolean

Defines if filtering would be done using normalized values.

filterPlaceholder: string

Placeholder text to show when filter input is empty.

formId?: string

ID of the form to use for AJAX requests.

id: string | string[]

The client-side ID of the widget, with all parent naming containers, such as myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs multiple container elements (such as Paginator), this may also be an array if IDs.

initialHeight: number

Initial height of the overlay panel in pixels.

labelSeparator: string

Separator for joining item labels if updateLabel is set to true. Default is ,.

multiple: boolean

Whether to show selected items as multiple labels.

Callback that is invoked when a checkbox option was checked or unchecked.

Callback that is invoked when the overlay panel is brought up.

Callback that is invoked when the overlay panel is hidden.

panelStyle: string

Inline style of the overlay panel.

panelStyleClass: string

Style class of the overlay panel

postConstruct: PostConstructCallback

An optional callback that is invoked after this widget was created successfully, at the end of the init method. This is usually specified via the widgetPostConstruct attribute on the JSF component. Note that this is also called during a refresh (AJAX update).

postRefresh: PostRefreshCallback

An optional callback that is invoked after this widget was refreshed after an AJAX update, at the end of the refresh method. This is usually specified via the widgetPostRefresh attribute on the JSF component.

preDestroy: PreDestroyCallback

An optional callback that is invoked before this widget is about to be destroyed, e.g., when the component was removed at the end of an AJAX update. This is called at the beginning of the destroy method. This is usually specified via the widgetPreDestroy attribute on the JSF component.

renderPanelContentOnClient: boolean

Renders panel content on client.

scrollHeight: number

Maximum height of the overlay panel.

selectedLabel: string

Label to be shown in updateLabel mode when one or more items are selected. If not set the label is shown.

showHeader: boolean

When enabled, the header of overlay panel is displayed.

updateLabel: boolean

When enabled, the selected items are displayed on the label.

widgetVar: string

The name of the widget variables of this widget. The widget variable can be used to access a widget instance by calling PF("myWidgetVar").

Generated using TypeDoc