• Public
  • Public/Protected
  • All

The configuration for the SelectOneMenu 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.





alwaysDisplayLabel: boolean

true if the label of the selected item should always be set on the visible input, false otherwise.


appendTo: string

Appends the overlay to the element defined by search expression. Defaults to the document body.


autoWidth: boolean

Calculates a fixed width based on the width of the maximum option label. Set to false for custom width.


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.


editable: boolean

When true, the input field becomes editable.


filter: boolean

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


filterFunction: FilterFunction

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


filterMatchMode: FilterMatchMode

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

Optional formId

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.


label: string

Text of the label for the input.


labelTemplate: string

Displays label of the element in a custom template. Valid placeholder is {0}, which is replaced with the value of the currently selected item.


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.


syncTooltip: boolean

Updates the title of the component with the description of the selected item.


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