Package org.opencms.ade.galleries.shared

Interface I_CmsGalleryConfiguration

    • Method Detail

      • getCurrentElement

        java.lang.String getCurrentElement()
        Returns the currently selected element.

        Returns:
        the currently selected element

      • getGalleryPath

        java.lang.String getGalleryPath()
        Returns the start gallery path.

        Returns:
        the start gallery path

      • getGalleryStoragePrefix

        java.lang.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

        java.lang.String getGalleryTypeName()
        Returns the gallery type name.

        Returns:
        the gallery type name

      • getGalleryTypes

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

        Returns:
        the available gallery types

      • getImageFormatNames

        java.lang.String getImageFormatNames()
        Returns the image format names.

        Returns:
        the image format names

      • getImageFormats

        java.lang.String getImageFormats()
        Returns the image formats.

        Returns:
        the image formats

      • getLocale

        java.lang.String getLocale()
        Returns the content locale.

        Returns:
        the content locale

      • getPageId

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

      • getReferencePath

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

        Returns:
        the path of the edited resource

      • getResourceTypes

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

        Returns:
        the available resource types

      • getSearchTypes

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

        Returns:
        the searchable types

      • getStartFolder

        java.lang.String getStartFolder()
        Returns the start folder.

        Returns:
        the start folder

      • getStartSite

        java.lang.String getStartSite()
        Returns the start site.

        Returns:
        the start site

      • getTreeToken

        java.lang.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

        java.lang.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​(java.lang.String currentElement)
        Sets the currentElement.

        Parameters:
        currentElement - the currentElement to set

      • setStartFolder

        void setStartFolder​(java.lang.String startFolder)
        Sets the start folder.

        Parameters:
        startFolder - the start folder