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 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

Field Summary

static java.lang.String

DICT_NAME Name of the used JS variable.

Constructor Summary

CmsGalleryDataBean()

Method Summary

java.util.List<CmsCategoryTreeEntry>	getCategories() Returns the categories.
java.lang.String	getCurrentElement() Returns the current element.
java.util.List<CmsGalleryFolderBean>	getGalleries() Returns the galleries map.
java.lang.String	getLocale() Returns the locale.
java.util.Map<java.lang.String,java.lang.String>	getLocales() Returns the locales map.
I_CmsGalleryProviderConstants.GalleryMode	getMode() Returns the gallery mode.
java.lang.String	getReferenceSitePath() Returns the gallery reference site-path.
CmsGallerySearchScope	getScope() Returns the search scope.
java.lang.String	getStartGallery() Returns the start gallery folder.
I_CmsGalleryProviderConstants.GalleryTabId	getStartTab() Returns the start tab.
java.util.List<CmsResourceTypeBean>	getTypes() Returns the types map.
java.util.List<CmsVfsEntryBean>	getVfsRootFolders() Returns the list of root folders to display in the VFS tab.
void	setCategories(java.util.List<CmsCategoryTreeEntry> categories) Sets the categories.
void	setCurrentElement(java.lang.String currentElement) Sets the current element.
void	setGalleries(java.util.List<CmsGalleryFolderBean> galleries) Sets the galleries map.
void	setLocale(java.lang.String locale) Sets the locale.
void	setLocales(java.util.Map<java.lang.String,java.lang.String> locales) Sets the locales map.
void	setMode(I_CmsGalleryProviderConstants.GalleryMode mode) Sets the gallery mode.
void	setReferenceSitePath(java.lang.String referenceSitePath) Sets the gallery reference site-path.
void	setScope(CmsGallerySearchScope scope) Sets the search scope.
void	setStartGallery(java.lang.String startGallery) Sets the start gallery folder.
void	setStartTab(I_CmsGalleryProviderConstants.GalleryTabId startTab) Sets the start tab.
void	setTypes(java.util.List<CmsResourceTypeBean> types) Sets the types map.
void	setVfsRootFolders(java.util.List<CmsVfsEntryBean> rootFolders) Sets the root folders to be displayed in the VFS folder tab.

Methods inherited from class java.lang.Object

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

Field Detail

DICT_NAME

public static final java.lang.String DICT_NAME

Name of the used JS variable.

See Also:

Constant Field Values

Constructor Detail

CmsGalleryDataBean

public CmsGalleryDataBean()

Method Detail

getCategories

public java.util.List<CmsCategoryTreeEntry> getCategories()

Returns the categories.

Returns:

the categories

getCurrentElement

public java.lang.String getCurrentElement()

Returns the current element.

Returns:

the current element

getGalleries

public java.util.List<CmsGalleryFolderBean> getGalleries()

Returns the galleries map.

Returns:

the galleries

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

getMode

public I_CmsGalleryProviderConstants.GalleryMode getMode()

Returns the gallery mode.

Returns:

the gallery mode

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

getScope

public CmsGallerySearchScope getScope()

Returns the search scope.

Returns:

the search scope

getStartGallery

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

getTypes

public java.util.List<CmsResourceTypeBean> getTypes()

Returns the types map.

Returns:

the types

getVfsRootFolders

public java.util.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

setCategories

public void setCategories(java.util.List<CmsCategoryTreeEntry> categories)

Sets the categories.

Parameters:

categories - the categories to set

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

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

setMode

public void setMode(I_CmsGalleryProviderConstants.GalleryMode mode)

Sets the gallery mode.

Parameters:

mode - the gallery mode 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

setScope

public void setScope(CmsGallerySearchScope scope)

Sets the search scope.

Parameters:

scope - the search scope

setStartGallery

public void setStartGallery(java.lang.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

setTypes

public void setTypes(java.util.List<CmsResourceTypeBean> types)

Sets the types map.

Parameters:

types - the types 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