Package org.opencms.ade.galleries.shared

Interface I_CmsGalleryConfiguration

All Known Implementing Classes:
CmsGalleryConfiguration
public interface I_CmsGalleryConfiguration
The gallery configuration interface.

  • Method Details

    • getCurrentElement

      String getCurrentElement()
      Returns the currently selected element.

      Returns:
      the currently selected element

    • getGalleryMode

      I_CmsGalleryProviderConstants.GalleryMode getGalleryMode()
      Returns the gallery mode.

      Returns:
      the gallery mode

    • getGalleryPath

      String getGalleryPath()
      Returns the start gallery path.

      Returns:
      the start gallery path

    • getGalleryStoragePrefix

      String getGalleryStoragePrefix()
      Gets the prefix for the key used to store the last selected gallery.

      Returns:
      the prefix for the key used to store the last selected gallery

    • getGalleryTypeName

      String getGalleryTypeName()
      Returns the gallery type name.

      Returns:
      the gallery type name

    • getGalleryTypes

      String[] getGalleryTypes()
      Returns the available gallery types.

      Returns:
      the available gallery types

    • getImageFormatNames

      String getImageFormatNames()
      Returns the image format names.

      Returns:
      the image format names

    • getImageFormats

      String getImageFormats()
      Returns the image formats.

      Returns:
      the image formats

    • getLocale

      String getLocale()
      Returns the content locale.

      Returns:
      the content locale

    • getPageId

      String getPageId()
      Gets the page id.
      Returns:
      the page id

    • getReferencePath

      String getReferencePath()
      Returns the path of the edited resource.

      Returns:
      the path of the edited resource

    • getResourceTypes

      List<String> getResourceTypes()
      Returns the available resource types.

      Returns:
      the available resource types

    • getSearchTypes

      List<String> getSearchTypes()
      Returns the searchable types.

      Returns:
      the searchable types

    • getStartFolder

      String getStartFolder()
      Returns the start folder.

      Returns:
      the start folder

    • getStartSite

      String getStartSite()
      Returns the start site.

      Returns:
      the start site

    • getTabConfiguration

      CmsGalleryTabConfiguration getTabConfiguration()
      Gets the tab configuration.

      Returns:
      the gallery tab configuration

    • getTreeToken

      String getTreeToken()
      Gets the tree token.

      The tree token is used to save/load tree opening states for tree tabs in the gallery dialog. If two widget instances use different tree tokens, opening or closing tree entries in one will not effect the tree opening state of the other.

      Returns:
      the tree token

    • getUploadFolder

      String getUploadFolder()
      Returns the upload folder.

      Returns:
      the upload folder

    • isGalleriesSelectable

      boolean isGalleriesSelectable()
      Returns true if the galleries should be selectable.

      Returns:
      true if the galleries should be selectable

    • isIncludeFiles

      boolean isIncludeFiles()
      Returns if files are selectable.

      Returns:
      true if files are selectable

    • isResultsSelectable

      boolean isResultsSelectable()
      Returns false if the results should not be selectable.

      Returns:
      false if the results should not be selectable

    • isShowSiteSelector

      boolean isShowSiteSelector()
      Returns if the site selector should be shown.

      Returns:
      true if the site selector should be shown

    • isUseFormats

      boolean isUseFormats()
      Returns if image formats should be used in preview.

      Returns:
      true if image format should be used in preview

    • setCurrentElement

      void setCurrentElement(String currentElement)
      Sets the currentElement.

      Parameters:
      currentElement - the currentElement to set

    • setStartFolder

      void setStartFolder(String startFolder)
      Sets the start folder.

      Parameters:
      startFolder - the start folder