Package org.opencms.ui.shared.rpc

Interface I_CmsSitemapClientRpc

  • All Superinterfaces:
    com.vaadin.shared.communication.ClientRpc, java.io.Serializable
    public interface I_CmsSitemapClientRpc
extends com.vaadin.shared.communication.ClientRpc
    Interface for the server-to-client RPC calls used by the sitemap extension.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void finishPageCopyDialog​(java.lang.String callId, java.lang.String response)
      Signals to the client that the page copy dialog has finished.
      void openPropertyDialog​(java.lang.String structureId, java.lang.String rootId)
      Opens the property dialog in the locale comparison view.
      void showInfoHeader​(java.lang.String title, java.lang.String description, java.lang.String path, java.lang.String locale, java.lang.String icon)
      Displays the header for a sub-sitemap in the locale comparison view.

    • Method Detail

      • finishPageCopyDialog

        void finishPageCopyDialog​(java.lang.String callId,
                          java.lang.String response)
        Signals to the client that the page copy dialog has finished.

        Parameters:
        callId - the call id which was initially used to open the dialog
        response - a string representing the result code of the page copy dialog

      • openPropertyDialog

        void openPropertyDialog​(java.lang.String structureId,
                        java.lang.String rootId)
        Opens the property dialog in the locale comparison view.

        Parameters:
        structureId - the structure id of the resource for which to open the property dialog
        rootId - the root structure id of the locale comparison tree

      • showInfoHeader

        void showInfoHeader​(java.lang.String title,
                    java.lang.String description,
                    java.lang.String path,
                    java.lang.String locale,
                    java.lang.String icon)
        Displays the header for a sub-sitemap in the locale comparison view.

        Parameters:
        title - the title
        description - the description
        path - the path
        locale - the locale
        icon - the CSS classes for the icon