Appends the overlayPanel to the given search expression.
Position of the target relative to the panel.
Whether to hide overlay when hovering over overlay content when using custom show/hide.
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.
true to prevent the body from being scrolled, false otherwise.
Only relevant for dynamic="true": Defines if activating the panel should load the contents from server again. For cache="true" (default) the panel content is only loaded once.
When the positioned element overflows the window in some direction, move it to an
alternative position. Similar to my and at, this accepts a single value or a pair for horizontal/vertical, e.g.,
flip, fit, fit flip, fit none.
When set true, clicking outside of the panel hides the overlay.
true to load the content via AJAX when the overlay panel is opened, false to load
the content immediately.
ID of the form to use for AJAX requests.
Event on target to hide the panel.
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.
Specifies whether the document should be shielded with a partially transparent mask to require the user to close the panel before being able to activate any elements in the document.
Position of the panel relative to the target.
Client side callback to execute when the panel is shown.
Client side callback to execute when the panel is hidden.
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.
Displays a close icon to hide the overlay, default is false.
Delay in milliseconds applied when the overlay panel is shown.
Event on target to hide the panel.
Search expression for target component to display panel next to.
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
The configuration for the OverlayPanel 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.