Package org.opencms.ade.galleries.shared

Class CmsGalleryDataBean

java.lang.Object

org.opencms.ade.galleries.shared.CmsGalleryDataBean

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable

public class CmsGalleryDataBean
extends 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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DICT_NAME	Name of the used JS variable.

Constructor Summary

Constructors

Constructor	Description
CmsGalleryDataBean()	Default constructor.

Method Summary

Modifier and Type	Method	Description
List<CmsCategoryTreeEntry>	getCategories()	Returns the categories.
Map<String,String>	getContextParameters()	Gets the context parameters.
String	getCurrentElement()	Returns the current element.
CmsGallerySearchScope	getDefaultScope()	Gets the default search scope.
List<CmsGalleryFolderBean>	getGalleries()	Returns the galleries map.
String	getGalleryStoragePrefix()	Gets the prefix for the key used to store the last selected gallery.
boolean	getIncludeExpiredDefault()	Gets the default value for the "include expired" option.
String	getLocale()	Returns the locale.
Map<String,String>	getLocales()	Returns the locales map.
I_CmsGalleryProviderConstants.GalleryMode	getMode()	Returns the gallery mode.
String	getReferenceSitePath()	Returns the gallery reference site-path.
String	getResultViewType()	Returns the result view type.
CmsGallerySearchScope	getScope()	Returns the search scope.
List<CmsSiteSelectorOption>	getSitemapSiteSelectorOptions()	Returns the site selector options for the sitemap.
I_CmsGalleryProviderConstants.SortParams	getSortOrder()	Gets the result sort order.
String	getStartFolder()	Returns the start folder.
Set<String>	getStartFolderFilter()	Returns the start folder filter.
String	getStartGallery()	Returns the start gallery folder.
I_CmsGalleryProviderConstants.GalleryTabId	getStartTab()	Returns the start tab.
CmsGalleryTabConfiguration	getTabConfiguration()	Gets the tab configuration.
I_CmsGalleryProviderConstants.GalleryTabId[]	getTabIds()	Returns the configured tabs.
String	getTreeToken()	Gets the tree token, which is used to determine which tree state is loaded from the session.
List<CmsResourceTypeBean>	getTypes()	Returns the types map.
CmsVfsEntryBean	getVfsPreloadData()	Returns the vfsPreloadData.
List<CmsVfsEntryBean>	getVfsRootFolders()	Returns the list of root folders to display in the VFS tab.
List<CmsSiteSelectorOption>	getVfsSiteSelectorOptions()	Gets the list of site selector options for the VFS tab.
void	setCategories(List<CmsCategoryTreeEntry> categories)	Sets the categories.
void	setCurrentElement(String currentElement)	Sets the current element.
void	setDefaultScope(CmsGallerySearchScope scope)	Sets the default search scope.
void	setGalleries(List<CmsGalleryFolderBean> galleries)	Sets the galleries map.
void	setGalleryStoragePrefix(String prefix)	Sets the prefix for the key used to store the last selected gallery.
void	setIncludeExpiredDefault(boolean includeExpiredDefault)	Sets the default value for the 'include expired' option.
void	setLocale(String locale)	Sets the locale.
void	setLocales(Map<String,String> locales)	Sets the locales map.
void	setMode(I_CmsGalleryProviderConstants.GalleryMode mode)	Sets the gallery mode.
void	setReferenceSitePath(String referenceSitePath)	Sets the gallery reference site-path.
void	setResultViewType(String resultViewType)	Sets the result view type.
void	setScope(CmsGallerySearchScope scope)	Sets the search scope.
void	setSitemapSiteSelectorOptions(List<CmsSiteSelectorOption> options)	Sets the site selector options for the sitemap tab.
void	setSortOrder(I_CmsGalleryProviderConstants.SortParams sortOrder)	Sets the result sort order.
void	setStartFolder(String startFolder)	Sets the start folder.
void	setStartFolderFilter(Set<String> startFolderFilter)	Sets the start folder filter.
void	setStartGallery(String startGallery)	Sets the start gallery folder.
void	setStartTab(I_CmsGalleryProviderConstants.GalleryTabId startTab)	Sets the start tab.
void	setTabConfiguration(CmsGalleryTabConfiguration tabConfiguration)	Sets the tab configuration.
void	setTabIds(I_CmsGalleryProviderConstants.GalleryTabId[] tabIds)	Sets the tab id's.
void	setTreeToken(String treeToken)	Sets the tree token.
void	setTypes(List<CmsResourceTypeBean> types)	Sets the types map.
void	setVfsPreloadData(CmsVfsEntryBean vfsPreloadData)	Sets the vfsPreloadData.
void	setVfsRootFolders(List<CmsVfsEntryBean> rootFolders)	Sets the root folders to be displayed in the VFS folder tab.
void	setVfsSiteSelectorOptions(List<CmsSiteSelectorOption> siteSelectorOptions)	Sets the available site selector options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DICT_NAME

public static final String DICT_NAME

Name of the used JS variable.

See Also:

• Constant Field Values

Constructor Details

CmsGalleryDataBean

public CmsGalleryDataBean()

Default constructor.

Method Details

getCategories

public List<CmsCategoryTreeEntry> getCategories()

Returns the categories.

Returns:

the categories

getContextParameters

public Map<String,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 String getCurrentElement()

Returns the current element.

Returns:

the current element

getDefaultScope

public CmsGallerySearchScope getDefaultScope()

Gets the default search scope.

Returns:

the default search scope

getGalleries

public List<CmsGalleryFolderBean> getGalleries()

Returns the galleries map.

Returns:

the galleries

getGalleryStoragePrefix

public 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 String getLocale()

Returns the locale.

Returns:

the locale

getLocales

public Map<String,String> getLocales()

Returns the locales map.

Returns:

the locales

getMode

public I_CmsGalleryProviderConstants.GalleryMode getMode()

Returns the gallery mode.

Returns:

the gallery mode

getReferenceSitePath

public 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 String getResultViewType()

Returns the result view type.

Returns:

the result view type

getScope

public CmsGallerySearchScope getScope()

Returns the search scope.

Returns:

the search scope

getSitemapSiteSelectorOptions

public List<CmsSiteSelectorOption> getSitemapSiteSelectorOptions()

Returns the site selector options for the sitemap.

Returns:

the site selector options for the sitemap

getSortOrder

public I_CmsGalleryProviderConstants.SortParams getSortOrder()

Gets the result sort order.

Returns:

the result sort order

getStartFolder

public String getStartFolder()

Returns the start folder.

Returns:

the start folder

getStartFolderFilter

public Set<String> getStartFolderFilter()

Returns the start folder filter.

Returns:

the start folder filter

getStartGallery

public String getStartGallery()

Returns the start gallery folder.

Returns:

the start gallery folder

getStartTab

public I_CmsGalleryProviderConstants.GalleryTabId getStartTab()

Returns the start tab.

Returns:

the startTab

getTabConfiguration

public CmsGalleryTabConfiguration getTabConfiguration()

Gets the tab configuration.

Returns:

the tab configuration

getTabIds

public I_CmsGalleryProviderConstants.GalleryTabId[] getTabIds()

Returns the configured tabs.

Returns:

the configured tabs

getTreeToken

public String getTreeToken()

Gets the tree token, which is used to determine which tree state is loaded from the session.

Returns:

the tree token

getTypes

public List<CmsResourceTypeBean> getTypes()

Returns the types map.

Returns:

the types

getVfsPreloadData

public CmsVfsEntryBean getVfsPreloadData()

Returns the vfsPreloadData.

Returns:

the vfsPreloadData

getVfsRootFolders

public List<CmsVfsEntryBean> getVfsRootFolders()

Returns the list of root folders to display in the VFS tab.

Returns:

the list root folders to display in the VFS tab

getVfsSiteSelectorOptions

public List<CmsSiteSelectorOption> getVfsSiteSelectorOptions()

Gets the list of site selector options for the VFS tab.

Returns:

the list of site selector options for the VFS tab

setCategories

public void setCategories(List<CmsCategoryTreeEntry> categories)

Sets the categories.

Parameters:

categories - the categories to set

setCurrentElement

public void setCurrentElement(String currentElement)

Sets the current element.

Parameters:

currentElement - the current element to set

setDefaultScope

public void setDefaultScope(CmsGallerySearchScope scope)

Sets the default search scope.

Parameters:

scope - the default search scope

setGalleries

public void setGalleries(List<CmsGalleryFolderBean> galleries)

Sets the galleries map.

Parameters:

galleries - the galleries to set

setGalleryStoragePrefix

public void setGalleryStoragePrefix(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(String locale)

Sets the locale.

Parameters:

locale - the locale to set

setLocales

public void setLocales(Map<String,String> locales)

Sets the locales map.

Parameters:

locales - the locales to set

setMode

public void setMode(I_CmsGalleryProviderConstants.GalleryMode mode)

Sets the gallery mode.

Parameters:

mode - the gallery mode to set

setReferenceSitePath

public void setReferenceSitePath(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(String resultViewType)

Sets the result view type.

Parameters:

resultViewType - the result view type to set

setScope

public void setScope(CmsGallerySearchScope scope)

Sets the search scope.

Parameters:

scope - the search scope

setSitemapSiteSelectorOptions

public void setSitemapSiteSelectorOptions(List<CmsSiteSelectorOption> options)

Sets the site selector options for the sitemap tab.

Parameters:

options - the site selector options for the sitemap tab

setSortOrder

public void setSortOrder(I_CmsGalleryProviderConstants.SortParams sortOrder)

Sets the result sort order.

Parameters:

sortOrder - the result sort order

setStartFolder

public void setStartFolder(String startFolder)

Sets the start folder.

Parameters:

startFolder - the start folder to set

setStartFolderFilter

public void setStartFolderFilter(Set<String> startFolderFilter)

Sets the start folder filter.

Parameters:

startFolderFilter - the start folder filter to set

setStartGallery

public void setStartGallery(String startGallery)

Sets the start gallery folder.

Parameters:

startGallery - the start gallery folder to set

setStartTab

public void setStartTab(I_CmsGalleryProviderConstants.GalleryTabId startTab)

Sets the start tab.

Parameters:

startTab - the start tab to set

setTabConfiguration

public void setTabConfiguration(CmsGalleryTabConfiguration tabConfiguration)

Sets the tab configuration.

Parameters:

tabConfiguration - the tab configuration

setTabIds

public void setTabIds(I_CmsGalleryProviderConstants.GalleryTabId[] tabIds)

Sets the tab id's.

Parameters:

tabIds - the tab id's to set

setTreeToken

public void setTreeToken(String treeToken)

Sets the tree token.

Parameters:

treeToken - the new tree token

setTypes

public void setTypes(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(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(List<CmsSiteSelectorOption> siteSelectorOptions)

Sets the available site selector options.

Parameters:

siteSelectorOptions - the available site selector options