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 java.lang.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
getGalleryStoragePrefix()
Gets the prefix for the key used to store the last selected gallery.java.lang.String
getGalleryTypeName()
Returns the gallery type name.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.CmsGalleryTabConfiguration
getTabConfiguration()
Gets the tab configuration.I_CmsGalleryProviderConstants.GalleryTabId[]
getTabIds()
Gets the array of tab ids.java.lang.String
getTreeToken()
Gets the tree token.java.lang.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(java.lang.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(java.lang.String galleryPath)
Sets the galleryPath.void
setGalleryStoragePrefix(java.lang.String prefix)
Sets the prefix for the key used to store the last selected gallery.void
setGalleryTypeName(java.lang.String galleryTypeName)
Sets the gallery type name.void
setGalleryTypes(java.lang.String... galleryTypes)
Sets the galleryTypes.void
setImageFormatNames(java.lang.String imageFormatNames)
Sets the image format names.void
setImageFormats(java.lang.String imageFormats)
Sets the image formats.void
setLocale(java.lang.String locale)
Sets the locale.void
setReferencePath(java.lang.String referencePath)
Sets the referencePath.void
setResourceTypes(java.util.List<java.lang.String> resourceTypes)
Sets the resourceTypes.void
setResultsSelectable(boolean resultsSelectable)
Disables selection of results if the given parameter is 'false'.void
setSearchTypes(java.util.List<java.lang.String> searchTypes)
Sets the searchTypes.void
setShowSiteSelector(boolean showSiteSelector)
Sets the showSiteSelector.void
setStartFolder(java.lang.String startFolder)
Sets the start folder.void
setStartSite(java.lang.String startSite)
Sets the startSite.void
setTabConfiguration(CmsGalleryTabConfiguration tabConfig)
Sets the tab configuration.void
setUploadFolder(java.lang.String uploadFolder)
Sets the upload folder.void
setUseFormats(boolean useFormats)
Sets the use formats flag.
-
-
-
Constructor Detail
-
CmsGalleryConfiguration
public CmsGalleryConfiguration()
Constructor.
-
CmsGalleryConfiguration
public CmsGalleryConfiguration(I_CmsGalleryConfiguration configuration)
Constructor.- Parameters:
configuration
- the initial configuration
-
-
Method Detail
-
getCurrentElement
public java.lang.String getCurrentElement()
Description copied from interface:I_CmsGalleryConfiguration
Returns the currently selected element.- Specified by:
getCurrentElement
in interfaceI_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 interfaceI_CmsGalleryConfiguration
- Returns:
- the gallery mode
- See Also:
I_CmsGalleryConfiguration.getGalleryMode()
-
getGalleryPath
public java.lang.String getGalleryPath()
Description copied from interface:I_CmsGalleryConfiguration
Returns the start gallery path.- Specified by:
getGalleryPath
in interfaceI_CmsGalleryConfiguration
- Returns:
- the start gallery path
- See Also:
I_CmsGalleryConfiguration.getGalleryPath()
-
getGalleryStoragePrefix
public java.lang.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 interfaceI_CmsGalleryConfiguration
- Returns:
- the prefix for the key used to store the last selected gallery
- See Also:
I_CmsGalleryConfiguration.getGalleryStoragePrefix()
-
getGalleryTypeName
public java.lang.String getGalleryTypeName()
Description copied from interface:I_CmsGalleryConfiguration
Returns the gallery type name.- Specified by:
getGalleryTypeName
in interfaceI_CmsGalleryConfiguration
- Returns:
- the gallery type name
- See Also:
I_CmsGalleryConfiguration.getGalleryTypeName()
-
getGalleryTypes
public java.lang.String[] getGalleryTypes()
Description copied from interface:I_CmsGalleryConfiguration
Returns the available gallery types.- Specified by:
getGalleryTypes
in interfaceI_CmsGalleryConfiguration
- Returns:
- the available gallery types
- See Also:
I_CmsGalleryConfiguration.getGalleryTypes()
-
getImageFormatNames
public java.lang.String getImageFormatNames()
Description copied from interface:I_CmsGalleryConfiguration
Returns the image format names.- Specified by:
getImageFormatNames
in interfaceI_CmsGalleryConfiguration
- Returns:
- the image format names
- See Also:
I_CmsGalleryConfiguration.getImageFormatNames()
-
getImageFormats
public java.lang.String getImageFormats()
Description copied from interface:I_CmsGalleryConfiguration
Returns the image formats.- Specified by:
getImageFormats
in interfaceI_CmsGalleryConfiguration
- Returns:
- the image formats
- See Also:
I_CmsGalleryConfiguration.getImageFormats()
-
getLocale
public java.lang.String getLocale()
Description copied from interface:I_CmsGalleryConfiguration
Returns the content locale.- Specified by:
getLocale
in interfaceI_CmsGalleryConfiguration
- Returns:
- the content locale
- See Also:
I_CmsGalleryConfiguration.getLocale()
-
getReferencePath
public java.lang.String getReferencePath()
Description copied from interface:I_CmsGalleryConfiguration
Returns the path of the edited resource.- Specified by:
getReferencePath
in interfaceI_CmsGalleryConfiguration
- Returns:
- the path of the edited resource
- See Also:
I_CmsGalleryConfiguration.getReferencePath()
-
getResourceTypes
public java.util.List<java.lang.String> getResourceTypes()
Description copied from interface:I_CmsGalleryConfiguration
Returns the available resource types.- Specified by:
getResourceTypes
in interfaceI_CmsGalleryConfiguration
- Returns:
- the available resource types
- See Also:
I_CmsGalleryConfiguration.getResourceTypes()
-
getSearchTypes
public java.util.List<java.lang.String> getSearchTypes()
Description copied from interface:I_CmsGalleryConfiguration
Returns the searchable types.- Specified by:
getSearchTypes
in interfaceI_CmsGalleryConfiguration
- Returns:
- the searchable types
- See Also:
I_CmsGalleryConfiguration.getSearchTypes()
-
getStartFolder
public java.lang.String getStartFolder()
Description copied from interface:I_CmsGalleryConfiguration
Returns the start folder.- Specified by:
getStartFolder
in interfaceI_CmsGalleryConfiguration
- Returns:
- the start folder
- See Also:
I_CmsGalleryConfiguration.getStartFolder()
-
getStartSite
public java.lang.String getStartSite()
Description copied from interface:I_CmsGalleryConfiguration
Returns the start site.- Specified by:
getStartSite
in interfaceI_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 interfaceI_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 java.lang.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 interfaceI_CmsGalleryConfiguration
- Returns:
- the tree token
- See Also:
I_CmsGalleryConfiguration.getTreeToken()
-
getUploadFolder
public java.lang.String getUploadFolder()
Description copied from interface:I_CmsGalleryConfiguration
Returns the upload folder.- Specified by:
getUploadFolder
in interfaceI_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 interfaceI_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 interfaceI_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 interfaceI_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 interfaceI_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 interfaceI_CmsGalleryConfiguration
- Returns:
true
if image format should be used in preview- See Also:
I_CmsGalleryConfiguration.isUseFormats()
-
setCurrentElement
public void setCurrentElement(java.lang.String currentElement)
Description copied from interface:I_CmsGalleryConfiguration
Sets the currentElement.- Specified by:
setCurrentElement
in interfaceI_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(java.lang.String galleryPath)
Sets the galleryPath.- Parameters:
galleryPath
- the galleryPath 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 new prefix
-
setGalleryTypeName
public void setGalleryTypeName(java.lang.String galleryTypeName)
Sets the gallery type name.- Parameters:
galleryTypeName
- the gallery type name
-
setGalleryTypes
public void setGalleryTypes(java.lang.String... galleryTypes)
Sets the galleryTypes.- Parameters:
galleryTypes
- the galleryTypes to set
-
setImageFormatNames
public void setImageFormatNames(java.lang.String imageFormatNames)
Sets the image format names.- Parameters:
imageFormatNames
- the imageFormatNames to set
-
setImageFormats
public void setImageFormats(java.lang.String imageFormats)
Sets the image formats.- Parameters:
imageFormats
- the image formats to set
-
setLocale
public void setLocale(java.lang.String locale)
Sets the locale.- Parameters:
locale
- the locale to set
-
setReferencePath
public void setReferencePath(java.lang.String referencePath)
Sets the referencePath.- Parameters:
referencePath
- the referencePath to set
-
setResourceTypes
public void setResourceTypes(java.util.List<java.lang.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(java.util.List<java.lang.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(java.lang.String startFolder)
Sets the start folder.- Specified by:
setStartFolder
in interfaceI_CmsGalleryConfiguration
- Parameters:
startFolder
- the start folder
-
setStartSite
public void setStartSite(java.lang.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(java.lang.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
-
-