Options
All
  • Public
  • Public/Protected
  • All
Menu

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

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.

Optional formId

formId?: string

ID of the form to use for AJAX requests.

id

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.

inputRegEx

inputRegEx: RegExp

Defines the regular expression which should be used to test the complete input text content. The options testFunction, regEx, inputRegEx, and mask are mutually exclusive.

mask

mask: keyof DefaultMasks

Defines the predefined mask which should be used. The options testFunction, regEx, inputRegEx, and mask are mutually exclusive.

postConstruct

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

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

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.

preventPaste

preventPaste: boolean

Whether the component also should prevent paste.

regEx

regEx: RegExp

Defines the regular expression which should be used for filtering the input. The options testFunction, regEx, inputRegEx, and mask are mutually exclusive.

target

target: string

The target input expression, defaults to the parent of this component.

testFunction

testFunction: TestFunction

An optional function which should be used for filtering. The options testFunction, regEx, inputRegEx, and mask are mutually exclusive.

widgetVar

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