Interface I_CmsGwtDialogClientRpc

  • All Superinterfaces:
    com.vaadin.shared.communication.ClientRpc, java.io.Serializable

    public interface I_CmsGwtDialogClientRpc
    extends com.vaadin.shared.communication.ClientRpc
    Server-to-client Interface for the GWT dialog extension.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void editPointer​(java.lang.String structureId)
      Opens the 'external link' editor dialog for a pointer resource.
      void editProperties​(java.lang.String structureId, boolean editName)
      Tells the client to open the property editing dialog for the resource with the given structure id.
      void openCategoriesDialog​(java.lang.String structureId, boolean collapsed)
      Opens the categories dialog.
      void openContentEditor​(java.lang.String structureId, java.lang.String fileName)
      Opens the XML content editor for the resource with the given structure id.
      void openGalleryDialog​(java.lang.String galleryConfiguration)
      Opens the gallery dialog with the given JSON configuration.
      void openInfoDialog​(java.lang.String structureId, java.lang.String startTab)
      Opens the resource info dialog for the resource with the given structure id.
      void openLockReport​(java.lang.String dialogTitle, java.lang.String structureId)
      Opens the lock report dialog.
      void openPublishDialog​(java.lang.String serializedPublishData)
      Opens the publish dialog with the given publish data.
      void openReplaceDialog​(java.lang.String structureId)
      Opens the 'replace' dialog for the resource with the given structure id.
      void showAbout()
      Shows the OpenCms about dialog.
      void showPreview​(java.lang.String uuid, java.lang.String historyVersion)
      Shows the preview dialog for resource with the given structure id and version string.
      void showUserPreferences()
      Shows the user preferences.
    • Method Detail

      • editPointer

        void editPointer​(java.lang.String structureId)
        Opens the 'external link' editor dialog for a pointer resource.

        Parameters:
        structureId - the structure id of the resource
      • editProperties

        void editProperties​(java.lang.String structureId,
                            boolean editName)
        Tells the client to open the property editing dialog for the resource with the given structure id.

        Parameters:
        structureId - the structure id of a resource, as a string
        editName - if true, makes the file name editable
      • openCategoriesDialog

        void openCategoriesDialog​(java.lang.String structureId,
                                  boolean collapsed)
        Opens the categories dialog.

        Parameters:
        structureId - the structure id of the resource to open the dialog for
        collapsed - flag, indicating if all categories should be collapsed when the dialog opens
      • openContentEditor

        void openContentEditor​(java.lang.String structureId,
                               java.lang.String fileName)
        Opens the XML content editor for the resource with the given structure id.

        Parameters:
        structureId - the structure id of a resource
        fileName - the site path to the resource to edit
      • openGalleryDialog

        void openGalleryDialog​(java.lang.String galleryConfiguration)
        Opens the gallery dialog with the given JSON configuration.

        Parameters:
        galleryConfiguration - the gallery configuration
      • openInfoDialog

        void openInfoDialog​(java.lang.String structureId,
                            java.lang.String startTab)
        Opens the resource info dialog for the resource with the given structure id.

        Parameters:
        structureId - the structure id of a resource, as a string
        startTab - the start tab id
      • openLockReport

        void openLockReport​(java.lang.String dialogTitle,
                            java.lang.String structureId)
        Opens the lock report dialog.

        Parameters:
        dialogTitle - the dialog title
        structureId - the structure id of the resource to open the dialog for
      • openPublishDialog

        void openPublishDialog​(java.lang.String serializedPublishData)
        Opens the publish dialog with the given publish data.

        Parameters:
        serializedPublishData - the publish data, an instance of CmsPublishData serialized with the GWT serialization mechanism
      • openReplaceDialog

        void openReplaceDialog​(java.lang.String structureId)
        Opens the 'replace' dialog for the resource with the given structure id.

        Parameters:
        structureId - the structure id of a resource
      • showAbout

        void showAbout()
        Shows the OpenCms about dialog.

      • showPreview

        void showPreview​(java.lang.String uuid,
                         java.lang.String historyVersion)
        Shows the preview dialog for resource with the given structure id and version string.

        The version string format is defined by the toString() method of org.opencms.gwt.shared.CmsHistoryVersion.

        Parameters:
        uuid - the UUID
        historyVersion - the history version string