Package org.opencms.ade.galleries.shared

Class CmsGalleryConfiguration

java.lang.Object

org.opencms.ade.galleries.shared.CmsGalleryConfiguration

All Implemented Interfaces:

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

public class CmsGalleryConfiguration
extends Object
implements I_CmsGalleryConfiguration, com.google.gwt.user.client.rpc.IsSerializable

The gallery configuration.

Constructor Summary

Constructors

Constructor	Description
CmsGalleryConfiguration()	Constructor.
CmsGalleryConfiguration(I_CmsGalleryConfiguration configuration)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getCurrentElement()	Returns the currently selected element.
I_CmsGalleryProviderConstants.GalleryMode	getGalleryMode()	Returns the gallery mode.
String	getGalleryPath()	Returns the start gallery path.
String	getGalleryStoragePrefix()	Gets the prefix for the key used to store the last selected gallery.
String	getGalleryTypeName()	Returns the gallery type name.
String[]	getGalleryTypes()	Returns the available gallery types.
String	getImageFormatNames()	Returns the image format names.
String	getImageFormats()	Returns the image formats.
String	getLocale()	Returns the content locale.
String	getPageId()	Gets the page id.
String	getReferencePath()	Returns the path of the edited resource.
List<String>	getResourceTypes()	Returns the available resource types.
List<String>	getSearchTypes()	Returns the searchable types.
String	getStartFolder()	Returns the start folder.
String	getStartSite()	Returns the start site.
CmsGalleryTabConfiguration	getTabConfiguration()	Gets the tab configuration.
I_CmsGalleryProviderConstants.GalleryTabId[]	getTabIds()	Gets the array of tab ids.
String	getTreeToken()	Gets the tree token.
String	getUploadFolder()	Returns the upload folder.
boolean	isGalleriesSelectable()	Returns true if the galleries should be selectable.
boolean	isIncludeFiles()	Returns if files are selectable.
boolean	isResultsSelectable()	Returns false if the results should not be selectable.
boolean	isShowSiteSelector()	Returns if the site selector should be shown.
boolean	isUseFormats()	Returns if image formats should be used in preview.
void	setCurrentElement(String currentElement)	Sets the currentElement.
void	setGalleriesSelectable(boolean galleriesSelectable)	Enables or disables selection of galleries in the gallery tab.
void	setGalleryMode(I_CmsGalleryProviderConstants.GalleryMode galleryMode)	Sets the galleryMode.
void	setGalleryPath(String galleryPath)	Sets the galleryPath.
void	setGalleryStoragePrefix(String prefix)	Sets the prefix for the key used to store the last selected gallery.
void	setGalleryTypeName(String galleryTypeName)	Sets the gallery type name.
void	setGalleryTypes(String... galleryTypes)	Sets the galleryTypes.
void	setImageFormatNames(String imageFormatNames)	Sets the image format names.
void	setImageFormats(String imageFormats)	Sets the image formats.
void	setLocale(String locale)	Sets the locale.
void	setPageId(String pageId)	Sets the page id.
void	setReferencePath(String referencePath)	Sets the referencePath.
void	setResourceTypes(List<String> resourceTypes)	Sets the resourceTypes.
void	setResultsSelectable(boolean resultsSelectable)	Disables selection of results if the given parameter is 'false'.
void	setSearchTypes(List<String> searchTypes)	Sets the searchTypes.
void	setShowSiteSelector(boolean showSiteSelector)	Sets the showSiteSelector.
void	setStartFolder(String startFolder)	Sets the start folder.
void	setStartSite(String startSite)	Sets the startSite.
void	setTabConfiguration(CmsGalleryTabConfiguration tabConfig)	Sets the tab configuration.
void	setUploadFolder(String uploadFolder)	Sets the upload folder.
void	setUseFormats(boolean useFormats)	Sets the use formats flag.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsGalleryConfiguration

public CmsGalleryConfiguration()

Constructor.

CmsGalleryConfiguration

public CmsGalleryConfiguration(I_CmsGalleryConfiguration configuration)

Constructor.

Parameters:

configuration - the initial configuration

Method Details

getCurrentElement

public String getCurrentElement()

Description copied from interface: I_CmsGalleryConfiguration

Returns the currently selected element.

Specified by:

getCurrentElement in interface I_CmsGalleryConfiguration

Returns:

the currently selected element

See Also:

• I_CmsGalleryConfiguration.getCurrentElement()

getGalleryMode

public I_CmsGalleryProviderConstants.GalleryMode getGalleryMode()

Description copied from interface: I_CmsGalleryConfiguration

Returns the gallery mode.

Specified by:

getGalleryMode in interface I_CmsGalleryConfiguration

Returns:

the gallery mode

See Also:

• I_CmsGalleryConfiguration.getGalleryMode()

getGalleryPath

public String getGalleryPath()

Description copied from interface: I_CmsGalleryConfiguration

Returns the start gallery path.

Specified by:

getGalleryPath in interface I_CmsGalleryConfiguration

Returns:

the start gallery path

See Also:

• I_CmsGalleryConfiguration.getGalleryPath()

getGalleryStoragePrefix

public String getGalleryStoragePrefix()

Description copied from interface: I_CmsGalleryConfiguration

Gets the prefix for the key used to store the last selected gallery.

Specified by:

getGalleryStoragePrefix in interface I_CmsGalleryConfiguration

Returns:

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

See Also:

• I_CmsGalleryConfiguration.getGalleryStoragePrefix()

getGalleryTypeName

public String getGalleryTypeName()

Description copied from interface: I_CmsGalleryConfiguration

Returns the gallery type name.

Specified by:

getGalleryTypeName in interface I_CmsGalleryConfiguration

Returns:

the gallery type name

See Also:

• I_CmsGalleryConfiguration.getGalleryTypeName()

getGalleryTypes

public String[] getGalleryTypes()

Description copied from interface: I_CmsGalleryConfiguration

Returns the available gallery types.

Specified by:

getGalleryTypes in interface I_CmsGalleryConfiguration

Returns:

the available gallery types

See Also:

• I_CmsGalleryConfiguration.getGalleryTypes()

getImageFormatNames

public String getImageFormatNames()

Description copied from interface: I_CmsGalleryConfiguration

Returns the image format names.

Specified by:

getImageFormatNames in interface I_CmsGalleryConfiguration

Returns:

the image format names

See Also:

• I_CmsGalleryConfiguration.getImageFormatNames()

getImageFormats

public String getImageFormats()

Description copied from interface: I_CmsGalleryConfiguration

Returns the image formats.

Specified by:

getImageFormats in interface I_CmsGalleryConfiguration

Returns:

the image formats

See Also:

• I_CmsGalleryConfiguration.getImageFormats()

getLocale

public String getLocale()

Description copied from interface: I_CmsGalleryConfiguration

Returns the content locale.

Specified by:

getLocale in interface I_CmsGalleryConfiguration

Returns:

the content locale

See Also:

• I_CmsGalleryConfiguration.getLocale()

getPageId

public String getPageId()

Description copied from interface: I_CmsGalleryConfiguration

Gets the page id.

Specified by:

getPageId in interface I_CmsGalleryConfiguration

Returns:

the page id

See Also:

• I_CmsGalleryConfiguration.getPageId()

getReferencePath

public String getReferencePath()

Description copied from interface: I_CmsGalleryConfiguration

Returns the path of the edited resource.

Specified by:

getReferencePath in interface I_CmsGalleryConfiguration

Returns:

the path of the edited resource

See Also:

• I_CmsGalleryConfiguration.getReferencePath()

getResourceTypes

public List<String> getResourceTypes()

Description copied from interface: I_CmsGalleryConfiguration

Returns the available resource types.

Specified by:

getResourceTypes in interface I_CmsGalleryConfiguration

Returns:

the available resource types

See Also:

• I_CmsGalleryConfiguration.getResourceTypes()

getSearchTypes

public List<String> getSearchTypes()

Description copied from interface: I_CmsGalleryConfiguration

Returns the searchable types.

Specified by:

getSearchTypes in interface I_CmsGalleryConfiguration

Returns:

the searchable types

See Also:

• I_CmsGalleryConfiguration.getSearchTypes()

getStartFolder

public String getStartFolder()

Description copied from interface: I_CmsGalleryConfiguration

Returns the start folder.

Specified by:

getStartFolder in interface I_CmsGalleryConfiguration

Returns:

the start folder

See Also:

• I_CmsGalleryConfiguration.getStartFolder()

getStartSite

public String getStartSite()

Description copied from interface: I_CmsGalleryConfiguration

Returns the start site.

Specified by:

getStartSite in interface I_CmsGalleryConfiguration

Returns:

the start site

See Also:

• I_CmsGalleryConfiguration.getStartSite()

getTabConfiguration

public CmsGalleryTabConfiguration getTabConfiguration()

Description copied from interface: I_CmsGalleryConfiguration

Gets the tab configuration.

Specified by:

getTabConfiguration in interface I_CmsGalleryConfiguration

Returns:

the gallery tab configuration

See Also:

• I_CmsGalleryConfiguration.getTabConfiguration()

getTabIds

public I_CmsGalleryProviderConstants.GalleryTabId[] getTabIds()

Gets the array of tab ids.

Returns:

the tab ids

getTreeToken

public String getTreeToken()

Description copied from interface: I_CmsGalleryConfiguration

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.

Specified by:

getTreeToken in interface I_CmsGalleryConfiguration

Returns:

the tree token

See Also:

• I_CmsGalleryConfiguration.getTreeToken()

getUploadFolder

public String getUploadFolder()

Description copied from interface: I_CmsGalleryConfiguration

Returns the upload folder.

Specified by:

getUploadFolder in interface I_CmsGalleryConfiguration

Returns:

the upload folder

See Also:

• I_CmsGalleryConfiguration.getUploadFolder()

isGalleriesSelectable

public boolean isGalleriesSelectable()

Description copied from interface: I_CmsGalleryConfiguration

Returns true if the galleries should be selectable.

Specified by:

isGalleriesSelectable in interface I_CmsGalleryConfiguration

Returns:

true if the galleries should be selectable

See Also:

• I_CmsGalleryConfiguration.isGalleriesSelectable()

isIncludeFiles

public boolean isIncludeFiles()

Description copied from interface: I_CmsGalleryConfiguration

Returns if files are selectable.

Specified by:

isIncludeFiles in interface I_CmsGalleryConfiguration

Returns:

true if files are selectable

See Also:

• I_CmsGalleryConfiguration.isIncludeFiles()

isResultsSelectable

public boolean isResultsSelectable()

Description copied from interface: I_CmsGalleryConfiguration

Returns false if the results should not be selectable.

Specified by:

isResultsSelectable in interface I_CmsGalleryConfiguration

Returns:

false if the results should not be selectable

See Also:

• I_CmsGalleryConfiguration.isResultsSelectable()

isShowSiteSelector

public boolean isShowSiteSelector()

Description copied from interface: I_CmsGalleryConfiguration

Returns if the site selector should be shown.

Specified by:

isShowSiteSelector in interface I_CmsGalleryConfiguration

Returns:

true if the site selector should be shown

See Also:

• I_CmsGalleryConfiguration.isShowSiteSelector()

isUseFormats

public boolean isUseFormats()

Description copied from interface: I_CmsGalleryConfiguration

Returns if image formats should be used in preview.

Specified by:

isUseFormats in interface I_CmsGalleryConfiguration

Returns:

true if image format should be used in preview

See Also:

• I_CmsGalleryConfiguration.isUseFormats()

setCurrentElement

public void setCurrentElement(String currentElement)

Description copied from interface: I_CmsGalleryConfiguration

Sets the currentElement.

Specified by:

setCurrentElement in interface I_CmsGalleryConfiguration

Parameters:

currentElement - the currentElement to set

See Also:

• I_CmsGalleryConfiguration.setCurrentElement(java.lang.String)

setGalleriesSelectable

public void setGalleriesSelectable(boolean galleriesSelectable)

Enables or disables selection of galleries in the gallery tab.

Parameters:

galleriesSelectable - true if the galleries should be made selectable

setGalleryMode

public void setGalleryMode(I_CmsGalleryProviderConstants.GalleryMode galleryMode)

Sets the galleryMode.

Parameters:

galleryMode - the galleryMode to set

setGalleryPath

public void setGalleryPath(String galleryPath)

Sets the galleryPath.

Parameters:

galleryPath - the galleryPath to set

setGalleryStoragePrefix

public void setGalleryStoragePrefix(String prefix)

Sets the prefix for the key used to store the last selected gallery.

Parameters:

prefix - the new prefix

setGalleryTypeName

public void setGalleryTypeName(String galleryTypeName)

Sets the gallery type name.

Parameters:

galleryTypeName - the gallery type name

setGalleryTypes

public void setGalleryTypes(String... galleryTypes)

Sets the galleryTypes.

Parameters:

galleryTypes - the galleryTypes to set

setImageFormatNames

public void setImageFormatNames(String imageFormatNames)

Sets the image format names.

Parameters:

imageFormatNames - the imageFormatNames to set

setImageFormats

public void setImageFormats(String imageFormats)

Sets the image formats.

Parameters:

imageFormats - the image formats to set

setLocale

public void setLocale(String locale)

Sets the locale.

Parameters:

locale - the locale to set

setPageId

public void setPageId(String pageId)

Sets the page id.

Parameters:

pageId - the page id

setReferencePath

public void setReferencePath(String referencePath)

Sets the referencePath.

Parameters:

referencePath - the referencePath to set

setResourceTypes

public void setResourceTypes(List<String> resourceTypes)

Sets the resourceTypes.

Parameters:

resourceTypes - the resourceTypes to set

setResultsSelectable

public void setResultsSelectable(boolean resultsSelectable)

Disables selection of results if the given parameter is 'false'.

Parameters:

resultsSelectable - false if result selection should be disabled

setSearchTypes

public void setSearchTypes(List<String> searchTypes)

Sets the searchTypes.

Parameters:

searchTypes - the searchTypes to set

setShowSiteSelector

public void setShowSiteSelector(boolean showSiteSelector)

Sets the showSiteSelector.

Parameters:

showSiteSelector - the showSiteSelector to set

setStartFolder

public void setStartFolder(String startFolder)

Sets the start folder.

Specified by:

setStartFolder in interface I_CmsGalleryConfiguration

Parameters:

startFolder - the start folder

setStartSite

public void setStartSite(String startSite)

Sets the startSite.

Parameters:

startSite - the startSite to set

setTabConfiguration

public void setTabConfiguration(CmsGalleryTabConfiguration tabConfig)

Sets the tab configuration.

Parameters:

tabConfig - the gallery tab configuration

setUploadFolder

public void setUploadFolder(String uploadFolder)

Sets the upload folder.

Parameters:

uploadFolder - the upload folder

setUseFormats

public void setUseFormats(boolean useFormats)

Sets the use formats flag.

Parameters:

useFormats - the use formats flag to set