Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

Index

Properties

absolutePositioned: boolean

Whether the dialog is positioned absolutely.

appendTo: string

A search expression for the element to which the dialog is appended. Defaults to the body.

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.

blockScroll: boolean

Whether to prevent the document from scrolling when the dialog is visible.

cache: boolean

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.

closable: boolean

Whether the dialog can be closed by the user.

closeOnEscape: boolean

Whether the dialog is closed when the user presses the escape button.

draggable: boolean

Whether the dialog is draggable.

dynamic: boolean

Whether lazy loading of the content via AJAX is enabled.

fitViewport: boolean

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.

formId?: string

ID of the form to use for AJAX requests.

height: number

The height of the dialog in pixels.

hideEffect: string

Effect to use when hiding the dialog.

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.

iframeStyleClass: string

One or more CSS classes for the iframe within the dialog.

iframeTitle: string

The title of the iframe with the dialog.

maximizable: boolean

Whether the dialog is maximizable.

minHeight: number

The minimum height of the dialog in pixels.

minWidth: number

The minimum width of the dialog in pixels.

minimizable: boolean

Whether the dialog is minimizable.

modal: boolean

Whether the dialog is modal and blocks the main content and other dialogs.

my: string

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.

position: string

Defines where the dialog should be displayed

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.

resizable: boolean

Whether the dialog can be resized by the user.

resizeObserver: boolean

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.)

resizeObserverCenter: boolean

Can be used together with resizeObserver = true. Centers the dialog again after it was resized to ensure the whole dialog is visible onscreen.

responsive: boolean

Whether the dialog is responsive. In responsive mode, the dialog adjusts itself based on the screen width.

showEffect: string

Effect to use when showing the dialog

styleClass: string

One or more CSS classes for the dialog.

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").

width: number

The width of the dialog in pixels.

Generated using TypeDoc