Whether the dialog is positioned absolutely.
A search expression for the element to which the dialog is appended. Defaults to the body.
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.
Whether to prevent the document from scrolling when the dialog is visible.
Only relevant for dynamic="true": Defines if activating the dialog should load the contents from server again. For cache="true" (default) the dialog content is only loaded once.
Whether the dialog can be closed by the user.
Whether the dialog is closed when the user presses the escape button.
Whether the dialog is draggable.
Whether lazy loading of the content via AJAX is enabled.
Dialog size might exceed the viewport if the content is taller than viewport in terms
of height. When this is set to true, automatically adjust the height to fit the dialog within the viewport.
ID of the form to use for AJAX requests.
The height of the dialog in pixels.
Effect to use when hiding the dialog.
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.
One or more CSS classes for the iframe within the dialog.
The title of the iframe with the dialog.
Whether the dialog is maximizable.
The minimum height of the dialog in pixels.
The minimum width of the dialog in pixels.
Whether the dialog is minimizable.
Whether the dialog is modal and blocks the main content and other dialogs.
Position of the dialog relative to the target.
Client-side callback to invoke when the dialog is closed.
Client-side callback to invoke when the dialog is opened.
Defines where the dialog should be displayed
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).
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.
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.
Whether the dialog can be resized by the user.
Use ResizeObserver to automatically adjust dialog-height after e.g. AJAX-updates. Resizeable must be set to false to use this option. (Known limitation: Dialog does not automatically resize yet when resizing the browser-window.)
Can be used together with resizeObserver = true. Centers the dialog again after it was resized to ensure the whole dialog is visible onscreen.
Whether the dialog is responsive. In responsive mode, the dialog adjusts itself based on the screen width.
Effect to use when showing the dialog
One or more CSS classes for the dialog.
The name of the widget variables of this widget. The widget variable can be used to
access a widget instance by calling PF("myWidgetVar").
The width of the dialog in pixels.
Generated using TypeDoc
The configuration for the Dialog 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.