Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Client-side callback for when the AJAX behavior completes, i.e. when the request finishes, irrespective of whether it succeeded or failed.

delay: number

Delay in milliseconds before displaying the AJAX status. Default is 0, meaning immediate.

Client-side callback for when the AJAX behavior fails, i.e. when the request fails.

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.

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.

Client-side callback for when the AJAX behavior starts, i.e. the request is about to be sent.

Client-side callback for when the AJAX behavior completes successfully, i.e. when the request succeeds.

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