Class CmsGalleryDataBean

  • All Implemented Interfaces:
    com.google.gwt.user.client.rpc.IsSerializable

    public class CmsGalleryDataBean
    extends java.lang.Object
    implements com.google.gwt.user.client.rpc.IsSerializable
    This bean holding the gallery dialog information required for displaying the content of the gallery tabs.

    Since:
    8.0.0
    • Method Detail

      • getContextParameters

        public java.util.Map<java.lang.String,​java.lang.String> getContextParameters()
        Gets the context parameters.

        These are additional parameters to store information about the context from which the gallery dialog was opened.

        Returns:
        the context parameters
      • getCurrentElement

        public java.lang.String getCurrentElement()
        Returns the current element.

        Returns:
        the current element
      • getGalleryStoragePrefix

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

        Returns:
        the gallery key prefix
      • getIncludeExpiredDefault

        public boolean getIncludeExpiredDefault()
        Gets the default value for the "include expired" option.

        Returns:
        the default value
      • getLocale

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

        Returns:
        the locale
      • getLocales

        public java.util.Map<java.lang.String,​java.lang.String> getLocales()
        Returns the locales map.

        Returns:
        the locales
      • getReferenceSitePath

        public java.lang.String getReferenceSitePath()
        Returns the gallery reference site-path.

        In widget, editor and containerpage mode this will be the edited resource, otherwise the opened gallery folder.

        Returns:
        the gallery reference site-path
      • getResultViewType

        public java.lang.String getResultViewType()
        Returns the result view type.

        Returns:
        the result view type
      • getStartFolder

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

        Returns:
        the start folder
      • getStartFolderFilter

        public java.util.Set<java.lang.String> getStartFolderFilter()
        Returns the start folder filter.

        Returns:
        the start folder filter
      • getStartGallery

        public java.lang.String getStartGallery()
        Returns the start gallery folder.

        Returns:
        the start gallery folder
      • getTreeToken

        public java.lang.String getTreeToken()
        Gets the tree token, which is used to determine which tree state is loaded from the session.

        Returns:
        the tree token
      • getVfsRootFolders

        public java.util.List<CmsVfsEntryBeangetVfsRootFolders()
        Returns the list of root folders to display in the VFS tab.

        Returns:
        the list root folders to display in the VFS tab
      • setCurrentElement

        public void setCurrentElement​(java.lang.String currentElement)
        Sets the current element.

        Parameters:
        currentElement - the current element to set
      • setGalleries

        public void setGalleries​(java.util.List<CmsGalleryFolderBean> galleries)
        Sets the galleries map.

        Parameters:
        galleries - the galleries to set
      • setGalleryStoragePrefix

        public void setGalleryStoragePrefix​(java.lang.String prefix)
        Sets the prefix for the key used to store the last selected gallery.

        Parameters:
        prefix - the prefix for the gallery key
      • setIncludeExpiredDefault

        public void setIncludeExpiredDefault​(boolean includeExpiredDefault)
        Sets the default value for the 'include expired' option.

        Parameters:
        includeExpiredDefault - the default value to set
      • setLocale

        public void setLocale​(java.lang.String locale)
        Sets the locale.

        Parameters:
        locale - the locale to set
      • setLocales

        public void setLocales​(java.util.Map<java.lang.String,​java.lang.String> locales)
        Sets the locales map.

        Parameters:
        locales - the locales to set
      • setReferenceSitePath

        public void setReferenceSitePath​(java.lang.String referenceSitePath)
        Sets the gallery reference site-path.

        In widget, editor and containerpage mode this will be the edited resource, otherwise the opened gallery folder.

        Parameters:
        referenceSitePath - the gallery reference site-path to set
      • setResultViewType

        public void setResultViewType​(java.lang.String resultViewType)
        Sets the result view type.

        Parameters:
        resultViewType - the result view type to set
      • setStartFolder

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

        Parameters:
        startFolder - the start folder to set
      • setStartFolderFilter

        public void setStartFolderFilter​(java.util.Set<java.lang.String> startFolderFilter)
        Sets the start folder filter.

        Parameters:
        startFolderFilter - the start folder filter to set
      • setStartGallery

        public void setStartGallery​(java.lang.String startGallery)
        Sets the start gallery folder.

        Parameters:
        startGallery - the start gallery folder to set
      • setTreeToken

        public void setTreeToken​(java.lang.String treeToken)
        Sets the tree token.

        Parameters:
        treeToken - the new tree token
      • setTypes

        public void setTypes​(java.util.List<CmsResourceTypeBean> types)
        Sets the types map.

        Parameters:
        types - the types to set
      • setVfsPreloadData

        public void setVfsPreloadData​(CmsVfsEntryBean vfsPreloadData)
        Sets the vfsPreloadData.

        Parameters:
        vfsPreloadData - the vfsPreloadData to set
      • setVfsRootFolders

        public void setVfsRootFolders​(java.util.List<CmsVfsEntryBean> rootFolders)
        Sets the root folders to be displayed in the VFS folder tab.

        Parameters:
        rootFolders - beans representing the root folders
      • setVfsSiteSelectorOptions

        public void setVfsSiteSelectorOptions​(java.util.List<CmsSiteSelectorOption> siteSelectorOptions)
        Sets the available site selector options.

        Parameters:
        siteSelectorOptions - the available site selector options