Package org.opencms.ade.galleries.client.preview

Interface I_CmsPreviewController<T extends org.opencms.ade.galleries.shared.CmsResourceInfoBean>

Type Parameters:
T - the resource info bean type
public interface I_CmsPreviewController<T extends org.opencms.ade.galleries.shared.CmsResourceInfoBean>
Interface for the preview controller.

Since:
8.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    closeGalleryDialog()
    Checks if further user input is required and other wise sets the selected resource via the provided integrator functions setLink and setImage.
    void
    loadResourceInfo(String resourcePath)
    Loads the resource info and displays the retrieved data.
    void
    removePreview()
    Removes the preview.
    void
    saveProperties(Map<String,String> properties)
    Saves the changed properties.
    void
    setResource(org.opencms.ade.galleries.shared.I_CmsGalleryProviderConstants.GalleryMode galleryMode)
    Sets the current resource within the editor or xml-content.
    void
    showData(T resourceInfo)
    Calls the preview handler to display the given data.

  • Method Details

    • closeGalleryDialog

      boolean closeGalleryDialog()
      Checks if further user input is required and other wise sets the selected resource via the provided integrator functions setLink and setImage. Returning true when all data has been set and the dialog should be closed.
      Returns:
      true when all data has been set and the dialog should be closed

    • loadResourceInfo

      void loadResourceInfo(String resourcePath)
      Loads the resource info and displays the retrieved data.

      Parameters:
      resourcePath - the resource path

    • removePreview

      void removePreview()
      Removes the preview.

    • saveProperties

      void saveProperties(Map<String,String> properties)
      Saves the changed properties.

      Parameters:
      properties - the changed properties

    • setResource

      void setResource(org.opencms.ade.galleries.shared.I_CmsGalleryProviderConstants.GalleryMode galleryMode)
      Sets the current resource within the editor or xml-content.

      Parameters:
      galleryMode - the gallery mode

    • showData

      void showData(T resourceInfo)
      Calls the preview handler to display the given data.

      Parameters:
      resourceInfo - the resource info data