Package org.opencms.ui.shared.rpc

Interface I_CmsEmbeddedDialogClientRPC

All Superinterfaces:
com.vaadin.shared.communication.ClientRpc, Serializable
public interface I_CmsEmbeddedDialogClientRPC extends com.vaadin.shared.communication.ClientRpc
Client RPC to handle embedded dialogs.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    finish(String resourceIds)
    Removes the dialog iFrame and refreshes the given resources.
    void
    finishForProjectOrSiteChange(String sitePath, String serverLink)
    Removes the dialog iFrame and reloads the app for the given site path and server link.
    void
    initServerRpc()
    Tells the client to initialize the client-to-server RPC.
    void
    leavePage(String targetUri)
    Leaves the current page calling the given URI.
    void
    reloadParent()
    Reloads the parent window.
    void
    selectString(String str)
    Sets the selected string.
    void
    sendNotification(boolean error, String notification)
    Send a notification to the client to display.

  • Method Details

    • finish

      void finish(String resourceIds)
      Removes the dialog iFrame and refreshes the given resources.

      Parameters:
      resourceIds - the resources to refresh

    • finishForProjectOrSiteChange

      void finishForProjectOrSiteChange(String sitePath, String serverLink)
      Removes the dialog iFrame and reloads the app for the given site path and server link.

      Parameters:
      sitePath - the site path
      serverLink - the server link

    • initServerRpc

      void initServerRpc()
      Tells the client to initialize the client-to-server RPC.

    • leavePage

      void leavePage(String targetUri)
      Leaves the current page calling the given URI.

      Parameters:
      targetUri - the target URI

    • reloadParent

      void reloadParent()
      Reloads the parent window.

    • selectString

      void selectString(String str)
      Sets the selected string.

      Parameters:
      str - the string

    • sendNotification

      void sendNotification(boolean error, String notification)
      Send a notification to the client to display.
      Parameters:
      error - true if this is an error notification
      notification - the notification HTML