Options
All
  • Public
  • Public/Protected
  • All
Menu

PrimeFaces OverlayPanel Widget

OverlayPanel is a generic panel component that can be displayed on top of other content.

Type parameters

Hierarchy

Index

Constructors

constructor

  • Creates a new instance of this widget. Please note that you should NOT override this constructor. Instead, override the init method, which is called at the end of the constructor once the instance is created.

    Type parameters

    Parameters

    • cfg: PartialWidgetCfg<TCfg>

      The widget configuration to be used for this widget instance. This widget configuration is usually created on the server by the javax.faces.render.Renderer for this component.

    Returns OverlayPanel<TCfg>

Properties

appendTo

appendTo: null | string

The search expression for the element to which the overlay panel should be appended.

cfg

cfg: PartialWidgetCfg<TCfg>

The configuration of this widget instance. Please note that no property is guaranteed to be present, you should always check for undefined before accessing a property. This is partly because the value of a property is not transmitted from the server to the client when it equals the default.

closerIcon

closerIcon: JQuery<HTMLElement>

The DOM element for the icon that closes the overlay panel.

content

The DOM element for the content of the overlay panel.

destroyListeners

Array of registered listeners invoked when this widget is destroyed. You should normally not use modify this directly, use addDestroyListener instead.

Optional hideOverlayHandler

hideOverlayHandler?: UnbindCallback

Unbind callback for the hide overlay handler.

id

id: string | string[]

The client-side ID of this 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.

jq

The jQuery instance of the container element of this widget. In case id is an array, it will contain multiple elements. Please note that some widgets have got not DOM elements at all, in this case this will be an empty jQuery instance.

jqId

jqId: string

A CSS selector for the container element (or elements, in case id is an array) of this widget, This is usually an ID selector (that is properly escaped). You can select the container element or elements like this: $(widget.jqId).

loaded

loaded: boolean

When dynamic loading is enabled, whether the content was already loaded.

modalOverlay

modalOverlay: JQuery<HTMLElement>

The DOM element that is displayed as an overlay with the appropriate z-index and position. It is usually a child of the body element.

refreshListeners

Array of registered listeners invoked when this widget is refreshed. You should normally not use modify this directly, use addRefreshListener instead.

Optional resizeHandler

resizeHandler?: UnbindCallback

Unbind callback for the resize handler.

Optional scrollHandler

scrollHandler?: UnbindCallback

Unbind callback for the scroll handler.

showTimeout

showTimeout: number

The set-timeout timer ID of the timer used for showing the overlay panel.

target

The DOM element for the target component that triggers this overlay panel.

targetElement

targetElement: JQuery<HTMLElement>

The DOM element for the resolved target component that triggers this overlay panel.

targetZindex

targetZindex: number

The z-index of the target component that triggers this overlay panel.

Optional transition

transition?: null | CssTransitionHandler

Handler for CSS transitions used by this widget.

widgetVar

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

Methods

Private _show

  • Makes the overlay panel visible.

    Parameters

    • Optional target: string | JQuery<HTMLElement>

      ID or DOM element of the target component that triggers this overlay panel.

    Returns void

addDestroyListener

  • Lets you register a listener that is called before the component is destroyed.

    When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. When the element is removed from the DOM by the update, the DOM element is detached from the DOM and all destroy listeners are called. This makes it possible to add listeners from outside the widget code.

    If you call this method twice with the same listener, it will be registered twice and later also called twice.

    Note that for this to work, you must not override the destroy method; or if you do, call super.

    Also, after this widget was detached is done, all destroy listeners will be unregistered.

    since

    7.0

    Parameters

    Returns void

addRefreshListener

  • When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. However, no new instance of the widget is created. Instead, after the DOM element was replaced, all refresh listeners are called. This makes it possible to add listeners from outside the widget code.

    If you call this method twice with the same listener, it will be registered twice and later also called twice.

    Note that for this to work, you must not override the refresh method; or if you do, call super.

    Also, after the refresh is done, all refresh listeners will be deregistered. If you added the listeners from within this widget, consider adding the refresh listeners not only in the init method, but also again in the refresh method after calling super.

    since

    7.0.0

    Parameters

    Returns void

Private align

  • Aligns the overlay panel so that it is shown at the correct position.

    Parameters

    • Optional target: string | JQuery<HTMLElement>

      ID or DOM element of the target component that triggers this overlay panel.

    Returns void

applyFocus

  • applyFocus(): void
  • Applies focus to the first focusable element of the content in the panel.

    Returns void

Private bindCommonEvents

  • bindCommonEvents(): void
  • Sets up some common event listeners always required by this widget.

    Returns void

Private bindPanelEvents

  • bindPanelEvents(): void
  • Sets up all panel event listeners

    Returns void

Private bindTargetEvents

  • bindTargetEvents(): void
  • Sets up the event listeners for the target component that triggers this overlay panel.

    Returns void

callBehavior

  • Each widget may have one or several behaviors attached to it. This method calls all attached behaviors for the given event name. In case no such behavior exists, this method does nothing and returns immediately.

    A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.

    Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server and processes the response once it is received. This enables several features such as updating or replacing elements dynamically. You can add an AJAX behavior via <p:ajax event="name" actionListener="#{...}" onstart="..." />.

    since

    7.0

    Parameters

    • event: string

      The name of an event to call.

    • Optional ext: Partial<ConfigurationExtender>

      Additional configuration that is passed to the AJAX request for the server-side callback.

    Returns void

destroy

  • destroy(): void
  • Will be called after an AJAX request if the widget container will be detached.

    When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. When the element is removed from the DOM by the update, the DOM element is detached from the DOM and this method gets called.

    Please note that instead of overriding this method, you should consider adding a destroy listener instead via addDestroyListener. This has the advantage of letting you add multiple listeners, and makes it possible to add additional listeners from code outside this widget.

    By default, this method just calls all destroy listeners.

    override

    Returns void

disableModality

  • disableModality(): void
  • Disabled modality for this widget and removes the modal overlay element, but does not change whether the overlay is currently displayed.

    override

    Returns void

enableModality

  • enableModality(): void
  • Enables modality for this widget and creates the modal overlay element, but does not change whether the overlay is currently displayed.

    override

    Returns void

getBehavior

  • getBehavior(name: string): null | Behavior
  • Each widget may have one or several behaviors attached to it. This method returns the callback function for the given event.

    Note: Do not call the method directly, the recommended way to invoke a behavior is via callBehavior.

    A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.

    Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server and processes the response once it is received. This enables several features such as updating or replacing elements dynamically. You can add an AJAX behavior via <p:ajax event="name" actionListener="#{...}" onstart="..." />.

    Parameters

    • name: string

      The name of an event for which to retrieve the behavior.

    Returns null | Behavior

    The behavior with the given name, or null if no such behavior exists.

getJQ

  • Each widget has got a container element, this method returns that container. This container element is usually also the element whose ID is the client-side ID of the JSF component.

    Returns JQuery<HTMLElement>

    The jQuery instance representing the main HTML container element of this widget.

getModalTabbables

  • This class makes sure a user cannot tab out of the modal and it stops events from targets outside of the overlay element. This requires that we switch back to the modal in case a user tabs out of it. What must be returned by this method are the elements to which the user may switch via tabbing.

    override

    Returns JQuery<HTMLElement>

    The DOM elements which are allowed to be focused via tabbing. May be an empty jQuery instance when the modal contains no tabbable elements, but must not be undefined.

getParentForm

  • Gets the closest parent form for this widget.

    since

    10.0.0

    Returns JQuery<HTMLElement>

    A JQuery instance that either contains the form when found, or an empty JQuery instance when the form could not be found.

getParentFormId

  • getParentFormId(): undefined | string
  • Gets the closest parent form ID for this widget lazily so it can be used in AJAX requests.

    since

    10.0.0

    Returns undefined | string

    Either the form ID or undefined if no form can be found.

Private getTarget

  • Get new target element using selector param.

    Parameters

    • Optional target: string | JQuery<HTMLElement>

      ID or DOM element of the target component that triggers this overlay panel.

    Returns null | JQuery<HTMLElement>

    DOM Element or null

Private handleViewportChange

  • handleViewportChange(): void
  • Fired when the browser viewport is resized or scrolled. In Mobile environment we don't want to hider the overlay we want to re-align it. This is because on some mobile browser the popup may force the browser to trigger a resize immediately and close the overlay. See GitHub #7075.

    Returns void

hasBehavior

  • hasBehavior(event: string): boolean
  • Each widget may have one or several behaviors attached to it. This method checks whether this widget has got at least one behavior associated with given event name.

    A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.

    Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server and processes the response once it is received. This enables several features such as updating or replacing elements dynamically. You can add an AJAX behavior via <p:ajax event="name" actionListener="#{...}" onstart="..." />.

    Parameters

    • event: string

      The name of an event to check.

    Returns boolean

    true if this widget has the given behavior, false otherwise.

hide

  • hide(callback?: () => void): void
  • Hides this overlay panel so that it is not displayed anymore.

    Parameters

    • Optional callback: () => void

      Custom callback that is invoked after this overlay panel was closed.

        • (): void
        • Returns void

    Returns void

init

  • A widget class should not declare an explicit constructor, the default constructor provided by this base widget should be used. Instead, override this initialize method which is called after the widget instance was constructed. You can use this method to perform any initialization that is required. For widgets that need to create custom HTML on the client-side this is also the place where you should call your render method.

    Please make sure to call the super method first before adding your own custom logic to the init method:

    PrimeFaces.widget.MyWidget = PrimeFaces.widget.BaseWidget.extend({
    init: function(cfg) {
    this._super(cfg);
    // custom initialization
    }
    });
    override

    Parameters

    • cfg: PartialWidgetCfg<TCfg>

      The widget configuration to be used for this widget instance. This widget configuration is usually created on the server by the javax.faces.render.Renderer for this component.

    Returns void

isDetached

  • isDetached(): boolean
  • Checks if this widget is detached, ie whether the HTML element of this widget is currently contained within the DOM (the HTML body element). A widget may become detached during an AJAX update, and it may remain detached in case the update removed this component from the component tree.

    Returns boolean

    true if this widget is currently detached, or false otherwise.

isVisible

  • isVisible(): boolean
  • Checks whether this overlay panel is currently visible.

    Returns boolean

    true if this overlay panel is currently displayed, or false otherwise.

Private loadContents

  • Loads the contents of this overlay panel dynamically via AJAX, if dynamic loading is enabled.

    Parameters

    • Optional target: string | JQuery<HTMLElement>

      ID or DOM element of the target component that triggers this overlay panel.

    Returns void

Private postHide

  • postHide(): void
  • Callback that is invoked after this overlay panel was closed.

    Returns void

Private postShow

  • postShow(): void
  • Callback that is invoked after this overlay panel was opened.

    Returns void

refresh

  • Used in ajax updates, reloads the widget configuration.

    When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. However, no new instance of the widget is created. Instead, after the DOM element was replaced, this method is called with the new widget configuration from the server. This makes it possible to persist client-side state during an update, such as the currently selected tab.

    Please note that instead of overriding this method, you should consider adding a refresh listener instead via addRefreshListener. This has the advantage of letting you add multiple listeners, and makes it possible to add additional listeners from code outside this widget.

    By default, this method calls all refresh listeners, then reinitializes the widget by calling the init method.

    override

    Parameters

    Returns void

    The value as returned by the init method, which is often undefined.

removeScriptElement

  • removeScriptElement(clientId: string | string[]): void
  • Removes the widget's script block from the DOM. Currently, the ID of this script block consists of the client-side ID of this widget with the prefix _s, but this is subject to change.

    Parameters

    • clientId: string | string[]

      The client-side ID of the widget.

    Returns void

Private setupDialogSupport

  • setupDialogSupport(): void
  • In case this overlay panel is inside a dialog widget, applies some CSS fixes so that this overlay panel is above the dialog-

    Returns void

show

  • Brings up the overlay panel so that is displayed and visible.

    Parameters

    • Optional target: string | JQuery<HTMLElement>

      ID or DOM element of the target component that triggers this overlay panel.

    Returns void

toggle

  • toggle(): void
  • Brings up the overlay panel if it is currently hidden, or hides it if it is currently displayed.

    Returns void

Private unbindPanelEvents

  • unbindPanelEvents(): void
  • Unbind all panel event listeners

    Returns void

Generated using TypeDoc