Service for creating and displaying dialogs containing a web component

Emits

dialog.destroyed - When the dialog is beeing externally destroyed, e.g. by closing a popup window (depending on platform), a DialogDestroyedEvent will be emitted using EventDispatcher

Hierarchy

  • DialogRenderer

Methods

  • Create a new dialog and render its contents. Depending on what kind of platform the service is used on, the dialog might be rendered in the current Document or opened in a new popup window.

    Returns

    id representing the dialog

    Parameters

    • name: string

      the name of the web component representing the dialog

    • Optional properties: DialogProperties

      any properties to send to the dialog

    • Optional listeners: DialogListeners

      any event listeners to register on the dialog

    Returns number

  • Destroy a dialog

    Parameters

    • id: number

      id representing the dialog

    Returns void

  • Update an existing dialog with new properties

    Parameters

    • id: number

      the dialog identifier

    • Optional properties: DialogProperties

      any properties to send to the dialog

    Returns void