• Public
  • Public/Protected
  • All

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





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.


Name of JavaScript function to extend the options of the underlying FullCalendar plugin. Access the this schedule widget via the this context, and change the FullCalendar configuration stored in this.cfg.

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.


locale: string

Locale code of the locale for the FullCalendar, such as de or en.


noOpener: boolean

Whether for URL events access to the opener window from the target site should be prevented (phishing protection), default value is true.


The configuration object that is passed to the FullCalendar upon initialization.


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.


themeSystem: boolean

Theme system used for rendering the calendar.


tooltip: boolean

Whether a tooltip should be displayed on hover.


urlTarget: string

Target for events with urls. Clicking on such events in the schedule will not trigger the selectEvent but open the url using this target instead. Default is _blank.


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