Options
All
  • Public
  • Public/Protected
  • All
Menu

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

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.

disabled: boolean

Whether this pick list is initially disabled.

effect: string

Name of the animation to display.

effectSpeed: string

Speed of the animation.

escapeValue: boolean

Whether the item values are escaped for HTML.

filterDelay: number

Delay to wait in milliseconds before sending each filter query. Default is 300.

filterEvent: string

Client side event to invoke picklist filtering for input fields. Default is keyup.

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.

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.

onTransfer: OnTransferCallback

Callback that is invoked when items are transferred from one list to the other.

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.

showCheckbox: boolean

When true, a checkbox is displayed next to each item.

showSourceControls: boolean

Specifies visibility of reorder buttons of source list.

showTargetControls: boolean

Specifies visibility of reorder buttons of target list.

tabindex: string

Position of the element in the tabbing order.

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