org.opencms.ade.galleries.shared.CmsGalleryDataBean Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.ade.galleries.shared;
import org.opencms.ade.galleries.shared.I_CmsGalleryProviderConstants.GalleryMode;
import org.opencms.ade.galleries.shared.I_CmsGalleryProviderConstants.GalleryTabId;
import org.opencms.ade.galleries.shared.I_CmsGalleryProviderConstants.SortParams;
import org.opencms.gwt.shared.CmsCategoryTreeEntry;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import 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
*/
public class CmsGalleryDataBean implements IsSerializable {
/** Name of the used JS variable. */
public static final String DICT_NAME = "cms_gallery_data_bean";
/** The category tree entry to display as tree. */
private List m_categoryTreeEntry;
/** Additional data about the context from which the gallery dialog was started. */
private Map m_contextParameters = new HashMap();
/** The current element. */
private String m_currentElement;
/** The default search scope. */
private CmsGallerySearchScope m_defaultScope = CmsGallerySearchScope.everything;
/** The galleries to display in the list with available galleries. */
private List m_galleries;
/** The prefix for the key used to store the last selected gallery. */
private String m_galleryStoragePrefix;
/** The default value for the 'include expired' option. */
private boolean m_includeExpiredDefault;
/** The content locale. */
private String m_locale;
/** The available workplace locales. */
private Map m_locales;
/** The gallery mode. */
private GalleryMode m_mode;
/**
* The gallery reference site-path.
* In widget, editor and containerpage mode this will be the edited resource, otherwise the opened gallery folder.
*/
private String m_referenceSitePath;
/** The result view type. */
private String m_resultViewType;
/** The search scope. */
private CmsGallerySearchScope m_scope;
/** The site selector options for the sitemap tab. */
private List m_sitemapSiteSelectorOptions;
/** The result sort order. */
private SortParams m_sortOrder;
/** The start folder. */
private String m_startFolder;
/** The folder filter for the initial search. */
private Set m_startFolderFilter;
/** The start gallery folder. */
private String m_startGallery;
/** The start up tab id. */
private GalleryTabId m_startTab;
/** The tab configuration. */
private CmsGalleryTabConfiguration m_tabConfiguration;
/** The configured tabs. */
private GalleryTabId[] m_tabIds;
/** A token used to determine which tree state is loaded/saved . */
private String m_treeToken;
/** The types to display in the list of available categories. */
private List m_types;
/** Preloaded contents for the VFS tree tab. */
private CmsVfsEntryBean m_vfsPreloadData;
/** A list of beans representing the root folders to display in the VFS tab. */
private List m_vfsRootFolders;
/** List of site selector options. */
private List m_vfsSiteSelectorOptions;
/**
* Default constructor.
*/
public CmsGalleryDataBean() {
}
/**
* Returns the categories.
*
* @return the categories
*/
public List getCategories() {
return m_categoryTreeEntry;
}
/**
* Gets the context parameters.
*
* These are additional parameters to store information about the context from which the gallery dialog was
* opened.
*
* @return the context parameters
*/
public Map getContextParameters() {
return m_contextParameters;
}
/**
* Returns the current element.
*
* @return the current element
*/
public String getCurrentElement() {
return m_currentElement;
}
/**
* Gets the default search scope.
*
* @return the default search scope
*/
public CmsGallerySearchScope getDefaultScope() {
return m_defaultScope;
}
/**
* Returns the galleries map.
*
* @return the galleries
*/
public List getGalleries() {
return m_galleries;
}
/**
* Gets the prefix for the key used to store the last selected gallery.
*
* @return the gallery key prefix
*/
public String getGalleryStoragePrefix() {
return m_galleryStoragePrefix;
}
/**
* Gets the default value for the "include expired" option.
*
* @return the default value
*/
public boolean getIncludeExpiredDefault() {
return m_includeExpiredDefault;
}
/**
* Returns the locale.
*
* @return the locale
*/
public String getLocale() {
return m_locale;
}
/**
* Returns the locales map.
*
* @return the locales
*/
public Map getLocales() {
return m_locales;
}
/**
* Returns the gallery mode.
*
* @return the gallery mode
*/
public GalleryMode getMode() {
return m_mode;
}
/**
* Returns the gallery reference site-path.
* In widget, editor and containerpage mode this will be the edited resource, otherwise the opened gallery folder.
*
* @return the gallery reference site-path
*/
public String getReferenceSitePath() {
return m_referenceSitePath;
}
/**
* Returns the result view type.
*
* @return the result view type
*/
public String getResultViewType() {
return m_resultViewType;
}
/**
* Returns the search scope.
*
* @return the search scope
*/
public CmsGallerySearchScope getScope() {
return m_scope;
}
/**
* Returns the site selector options for the sitemap.
*
* @return the site selector options for the sitemap
*/
public List getSitemapSiteSelectorOptions() {
return m_sitemapSiteSelectorOptions;
}
/**
* Gets the result sort order.
*
* @return the result sort order
*/
public SortParams getSortOrder() {
return m_sortOrder;
}
/**
* Returns the start folder.
*
* @return the start folder
*/
public String getStartFolder() {
return m_startFolder;
}
/**
* Returns the start folder filter.
*
* @return the start folder filter
*/
public Set getStartFolderFilter() {
return m_startFolderFilter;
}
/**
* Returns the start gallery folder.
*
* @return the start gallery folder
*/
public String getStartGallery() {
return m_startGallery;
}
/**
* Returns the start tab.
*
* @return the startTab
*/
public GalleryTabId getStartTab() {
return m_startTab;
}
/**
* Gets the tab configuration.
*
* @return the tab configuration
*/
public CmsGalleryTabConfiguration getTabConfiguration() {
return m_tabConfiguration;
}
/**
* Returns the configured tabs.
*
* @return the configured tabs
*/
public GalleryTabId[] getTabIds() {
return m_tabIds;
}
/**
* Gets the tree token, which is used to determine which tree state is loaded from the session.
*
* @return the tree token
*/
public String getTreeToken() {
return m_treeToken;
}
/**
* Returns the types map.
*
* @return the types
*/
public List getTypes() {
return m_types;
}
/**
* Returns the vfsPreloadData.
*
* @return the vfsPreloadData
*/
public CmsVfsEntryBean getVfsPreloadData() {
return m_vfsPreloadData;
}
/**
* Returns the list of root folders to display in the VFS tab.
*
* @return the list root folders to display in the VFS tab
*/
public List getVfsRootFolders() {
return m_vfsRootFolders;
}
/**
* Gets the list of site selector options for the VFS tab.
*
* @return the list of site selector options for the VFS tab
*/
public List getVfsSiteSelectorOptions() {
return m_vfsSiteSelectorOptions;
}
/**
* Sets the categories.
*
* @param categories the categories to set
*/
public void setCategories(List categories) {
m_categoryTreeEntry = categories;
}
/**
* Sets the current element.
*
* @param currentElement the current element to set
*/
public void setCurrentElement(String currentElement) {
m_currentElement = currentElement;
}
/**
* Sets the default search scope.
*
* @param scope the default search scope
*/
public void setDefaultScope(CmsGallerySearchScope scope) {
m_defaultScope = scope;
}
/**
* Sets the galleries map.
*
* @param galleries the galleries to set
*/
public void setGalleries(List galleries) {
m_galleries = galleries;
}
/**
* Sets the prefix for the key used to store the last selected gallery.
*
* @param prefix the prefix for the gallery key
*/
public void setGalleryStoragePrefix(String prefix) {
m_galleryStoragePrefix = prefix;
}
/**
* Sets the default value for the 'include expired' option.
*
* @param includeExpiredDefault the default value to set
*/
public void setIncludeExpiredDefault(boolean includeExpiredDefault) {
m_includeExpiredDefault = includeExpiredDefault;
}
/**
* Sets the locale.
*
* @param locale the locale to set
*/
public void setLocale(String locale) {
m_locale = locale;
}
/**
* Sets the locales map.
*
* @param locales the locales to set
*/
public void setLocales(Map locales) {
m_locales = locales;
}
/**
* Sets the gallery mode.
*
* @param mode the gallery mode to set
*/
public void setMode(GalleryMode mode) {
m_mode = mode;
}
/**
* Sets the gallery reference site-path.
* In widget, editor and containerpage mode this will be the edited resource, otherwise the opened gallery folder.
*
* @param referenceSitePath the gallery reference site-path to set
*/
public void setReferenceSitePath(String referenceSitePath) {
m_referenceSitePath = referenceSitePath;
}
/**
* Sets the result view type.
*
* @param resultViewType the result view type to set
*/
public void setResultViewType(String resultViewType) {
m_resultViewType = resultViewType;
}
/**
* Sets the search scope.
*
* @param scope the search scope
*/
public void setScope(CmsGallerySearchScope scope) {
m_scope = scope;
}
/**
* Sets the site selector options for the sitemap tab.
*
* @param options the site selector options for the sitemap tab
*/
public void setSitemapSiteSelectorOptions(List options) {
m_sitemapSiteSelectorOptions = options;
}
/**
* Sets the result sort order.
*
* @param sortOrder the result sort order
*/
public void setSortOrder(SortParams sortOrder) {
m_sortOrder = sortOrder;
}
/**
* Sets the start folder.
*
* @param startFolder the start folder to set
*/
public void setStartFolder(String startFolder) {
m_startFolder = startFolder;
}
/**
* Sets the start folder filter.
*
* @param startFolderFilter the start folder filter to set
*/
public void setStartFolderFilter(Set startFolderFilter) {
m_startFolderFilter = startFolderFilter;
}
/**
* Sets the start gallery folder.
*
* @param startGallery the start gallery folder to set
*/
public void setStartGallery(String startGallery) {
m_startGallery = startGallery;
}
/**
* Sets the start tab.
*
* @param startTab the start tab to set
*/
public void setStartTab(GalleryTabId startTab) {
m_startTab = startTab;
}
/**
* Sets the tab configuration.
*
* @param tabConfiguration the tab configuration
*/
public void setTabConfiguration(CmsGalleryTabConfiguration tabConfiguration) {
m_tabConfiguration = tabConfiguration;
}
/**
* Sets the tab id's.
*
* @param tabIds the tab id's to set
*/
public void setTabIds(GalleryTabId[] tabIds) {
m_tabIds = tabIds;
}
/**
* Sets the tree token.
*
* @param treeToken the new tree token
*/
public void setTreeToken(String treeToken) {
m_treeToken = treeToken;
}
/**
* Sets the types map.
*
* @param types the types to set
*/
public void setTypes(List types) {
m_types = types;
}
/**
* Sets the vfsPreloadData.
*
* @param vfsPreloadData the vfsPreloadData to set
*/
public void setVfsPreloadData(CmsVfsEntryBean vfsPreloadData) {
m_vfsPreloadData = vfsPreloadData;
}
/**
* Sets the root folders to be displayed in the VFS folder tab.
*
* @param rootFolders beans representing the root folders
*/
public void setVfsRootFolders(List rootFolders) {
m_vfsRootFolders = rootFolders;
}
/**
* Sets the available site selector options.
*
* @param siteSelectorOptions the available site selector options
*/
public void setVfsSiteSelectorOptions(List siteSelectorOptions) {
m_vfsSiteSelectorOptions = siteSelectorOptions;
}
}