org.opencms.ade.galleries.shared
Interface I_CmsGalleryConfiguration

All Known Implementing Classes:

CmsGalleryConfiguration

public interface I_CmsGalleryConfiguration

The gallery configuration interface.

Method Summary

java.lang.String	getCurrentElement() Returns the currently selected element.
I_CmsGalleryProviderConstants.GalleryMode	getGalleryMode() Returns the gallery mode.
java.lang.String	getGalleryPath() Returns the start gallery path.
java.lang.String[]	getGalleryTypes() Returns the available gallery types.
java.lang.String	getImageFormatNames() Returns the image format names.
java.lang.String	getImageFormats() Returns the image formats.
java.lang.String	getLocale() Returns the content locale.
java.lang.String	getReferencePath() Returns the path of the edited resource.
java.util.List<java.lang.String>	getResourceTypes() Returns the available resource types.
java.util.List<java.lang.String>	getSearchTypes() Returns the searchable types.
java.lang.String	getStartFolder() Returns the start folder.
java.lang.String	getStartSite() Returns the start site.
I_CmsGalleryProviderConstants.GalleryTabId[]	getTabIds() Returns the tab id's.
java.lang.String	getTreeToken() Gets the tree token.
boolean	isIncludeFiles() Returns if files are selectable.
boolean	isShowSiteSelector() Returns if the site selector should be shown.
boolean	isUseFormats() Returns if image formats should be used in preview.
void	setCurrentElement(java.lang.String currentElement) Sets the currentElement.

Method Detail

getCurrentElement

java.lang.String getCurrentElement()

Returns the currently selected element.

Returns:

the currently selected element

getGalleryMode

I_CmsGalleryProviderConstants.GalleryMode getGalleryMode()

Returns the gallery mode.

Returns:

the gallery mode

getGalleryPath

java.lang.String getGalleryPath()

Returns the start gallery path.

Returns:

the start gallery path

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

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

getTabIds

I_CmsGalleryProviderConstants.GalleryTabId[] getTabIds()

Returns the tab id's.

Returns:

the tab id's

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

isIncludeFiles

boolean isIncludeFiles()

Returns if files are selectable.

Returns:

true if files are 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