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

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

Type Parameters:
T - the resource info bean type
All Known Implementing Classes:
A_CmsResourcePreview, CmsBinaryResourcePreview, CmsImageResourcePreview
public interface I_CmsResourcePreview<T extends org.opencms.ade.galleries.shared.CmsResourceInfoBean>
Interface for resource preview within the galleries dialog.

Since:
8.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    CmsGalleryDialog
    getGalleryDialog()
    Gets the gallery dialog in which this preview is displayed.
    org.opencms.ade.galleries.shared.I_CmsGalleryProviderConstants.GalleryMode
    getGalleryMode()
    Returns the gallery mode.
    I_CmsPreviewHandler<T>
    getHandler()
    Returns the preview handler.
    String
    getLocale()
    Returns the current locale.
    A_CmsPreviewDialog<T>
    getPreviewDialog()
    Returns the preview dialog widget.
    String
    getPreviewName()
    Returns the preview name, should return the same as in I_CmsPreviewProvider.getPreviewName().
    String
    getResourcePath()
    Returns the resource path of the current resource.
    String
    getViewLink()
    Returns the site independent perma link.
    void
    loadResourceInfo(String resourcePath)
    Loads the resource info and displays the retrieved data.
    void
    openPreview(String resourcePath, boolean disableSelection)
    Opens the preview for the given resource in the given gallery mode.
    void
    removePreview()
    Removes the preview widget.
    void
    saveProperties(Map<String,String> properties, com.google.gwt.user.client.Command afterSaveCommand)
    Saves the changed properties.
    void
    selectResource(String resourcePath, org.opencms.util.CmsUUID structureId, String title)
    Sets the selected resource in the opening editor for the given gallery mode.
    boolean
    setDataInEditor()
    Checks if further user input is required and other wise sets the selected resource via the provided integrator functions setLink and setImage.
    void
    setResource()
    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

    • getGalleryDialog

      CmsGalleryDialog getGalleryDialog()
      Gets the gallery dialog in which this preview is displayed.

      Returns:
      the gallery dialog

    • getGalleryMode

      org.opencms.ade.galleries.shared.I_CmsGalleryProviderConstants.GalleryMode getGalleryMode()
      Returns the gallery mode.

      Returns:
      the gallery mode

    • getHandler

      I_CmsPreviewHandler<T> getHandler()
      Returns the preview handler.

      Returns:
      the preview handler

    • getLocale

      String getLocale()
      Returns the current locale.

      Returns:
      the current locale

    • getPreviewDialog

      A_CmsPreviewDialog<T> getPreviewDialog()
      Returns the preview dialog widget.

      Returns:
      the preview dialog widget

    • getPreviewName

      String getPreviewName()
      Returns the preview name, should return the same as in I_CmsPreviewProvider.getPreviewName().

      Returns:
      the preview name

    • getResourcePath

      String getResourcePath()
      Returns the resource path of the current resource.

      Returns:
      the resource path

    • getViewLink

      String getViewLink()
      Returns the site independent perma link.

      Returns:
      the site independent link

    • loadResourceInfo

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

      Parameters:
      resourcePath - the resource path

    • openPreview

      void openPreview(String resourcePath, boolean disableSelection)
      Opens the preview for the given resource in the given gallery mode.

      Parameters:
      resourcePath - the resource path
      disableSelection - if the selection from the preview should be disabled

    • removePreview

      void removePreview()
      Removes the preview widget.

    • saveProperties

      void saveProperties(Map<String,String> properties, com.google.gwt.user.client.Command afterSaveCommand)
      Saves the changed properties.

      Parameters:
      properties - the changed properties
      afterSaveCommand - the command to execute after saving the properties

    • selectResource

      void selectResource(String resourcePath, org.opencms.util.CmsUUID structureId, String title)
      Sets the selected resource in the opening editor for the given gallery mode.

      Parameters:
      resourcePath - the resource path
      structureId - the structure id
      title - the resource title

    • setDataInEditor

      boolean setDataInEditor()
      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. If there are any changes, the user will be requested to save those and the editor OK function will be called again.

      Returns:
      true when all data has been set, false if there were any changes that need saving

    • setResource

      void setResource()
      Sets the current resource within the editor or xml-content.

    • showData

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

      Parameters:
      resourceInfo - the resource info data