org.opencms.ade.sitemap.shared

Class CmsSitemapData

java.lang.Object

org.opencms.ade.sitemap.shared.CmsSitemapData

All Implemented Interfaces:

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

public class CmsSitemapData
extends java.lang.Object
implements com.google.gwt.user.client.rpc.IsSerializable

Sitemap initialization data bean for prefetching.

Since:

8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CmsSitemapData.EditorMode The sitemap editor modes.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DICT_NAME Name of the used js variable.

Constructor Summary

Constructors

Constructor and Description
CmsSitemapData() Constructor.
CmsSitemapData(java.util.Map<java.lang.String,CmsClientTemplateBean> templates, java.util.Map<java.lang.String,CmsXmlContentProperty> properties, CmsSitemapClipboardData clipboardData, java.util.List<CmsContextMenuEntryBean> contextMenuEntries, java.util.Map<java.lang.String,CmsClientProperty> parentProperties, java.util.List<java.lang.String> allPropNames, java.lang.String exportRfsPrefix, boolean isSecure, java.lang.String noEditReason, boolean displayToolbar, CmsNewResourceInfo defaultNewElementInfo, java.util.List<CmsNewResourceInfo> newElementInfos, CmsNewResourceInfo newRedirectElementInfo, CmsNewResourceInfo newNavigationLevelElementInfo, CmsSitemapInfo sitemapInfo, java.lang.String parentSitemap, CmsClientSitemapEntry root, java.lang.String openPath, int maxDepth, CmsDetailPageTable detailPageTable, java.util.List<CmsNewResourceInfo> resourceTypeInfos, java.lang.String returnCode, boolean canEditDetailPages, java.lang.String aliasImportUrl, boolean canEditAliases, boolean createNewFoldersForSubsitemaps, boolean galleryManager, boolean categoryManager, java.util.List<CmsListInfoBean> subsitemapTypeInfos, CmsSitemapData.EditorMode editorMode, java.lang.String defaultGalleryFolder, boolean showModelEditConfirm) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	canEditAliases() Checks whether the current user can edit the aliases.
boolean	canEditDetailPages() Returns true if the detail pages can be edited.
java.lang.String	getAliasImportUrl() Gets the URL of the JSP used to import aliases.
java.util.List<java.lang.String>	getAllPropertyNames() Returns the names of all properties.
CmsSitemapClipboardData	getClipboardData() Returns the clipboard data.
java.util.List<CmsContextMenuEntryBean>	getContextMenuEntries() Returns the sitemap context menu entries.
java.lang.String	getDefaultGalleryFolder() Returns the default gallery parent folder.
CmsNewResourceInfo	getDefaultNewElementInfo() Returns the type of the container page resource.
CmsDetailPageTable	getDetailPageTable() Gets the detail page table.
CmsSitemapData.EditorMode	getEditorMode() Returns the editor mode.
java.lang.String	getExportRfsPrefix() Returns the export RFS prefix.
int	getMaxDepth() Returns the maximum sitemap depth.
java.util.List<CmsNewResourceInfo>	getNewElementInfos() Returns the new element information.
CmsNewResourceInfo	getNewNavigationLevelElementInfo() Returns the new navigation level element info.
CmsNewResourceInfo	getNewRedirectElementInfo() Returns the new redirect element info.
CmsNewResourceInfo	getNewResourceInfoById(CmsUUID id) Gets the new resource info with a given structure id.
java.lang.String	getNoEditReason() Returns the reason why the current sitemap is not editable.
java.lang.String	getOpenPath() Gets the path at which the sitemap should be opened (may be null).
java.util.Map<java.lang.String,CmsClientProperty>	getParentProperties() Returns the properties of the sitemap root's parent.
java.lang.String	getParentSitemap() Returns the path to the parent sitemap or null.
java.util.Map<java.lang.String,CmsXmlContentProperty>	getProperties() Returns the properties.
java.util.List<CmsNewResourceInfo>	getResourceTypeInfos() Gets the resource type info beans for the detail pages.
java.lang.String	getReturnCode() Returns the return page code.
CmsClientSitemapEntry	getRoot() Returns the sitemap root.
CmsSitemapInfo	getSitemapInfo() Returns the sitemap info.
CmsUUID	getSiteRootId() Gets the structure id of the site root.
java.util.List<CmsListInfoBean>	getSubsitemapFolderTypeInfos() Returns the list info beans for the available sitemap folder types.
java.util.Map<java.lang.String,CmsClientTemplateBean>	getTemplates() Returns the available templates.
boolean	isCategoryManager() Returns if the current user has the category manager role.
boolean	isCreateNewFoldersForSubsitemaps() Returns true if new folders should be created for subsitemaps.
boolean	isDisplayToolbar() Checks if to display the toolbar.
boolean	isGalleryManager() Returns if the current user has the gallery manager role.
boolean	isLocaleComparisonEnabled() Returns true if the locale compare mode is enabled.
boolean	isSecure() Returns true if there is a secure server configured for the site which contains the sitemap.
boolean	isShowModelEditConfirm() Returns the show model edit confirm dialog flag.
void	setLocaleComparisonEnabled(boolean enabled) Sets the 'locale comparison mode enabled' flag.
void	setNewElementInfos(java.util.List<CmsNewResourceInfo> newElementInfos) Sets the new element infos.
void	setReturnCode(java.lang.String returnCode) Sets the return page code.
void	setSiteRootId(CmsUUID id) Sets the site root structure id .

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

CmsSitemapData

public CmsSitemapData()

Constructor.

CmsSitemapData

public CmsSitemapData(java.util.Map<java.lang.String,CmsClientTemplateBean> templates,
                      java.util.Map<java.lang.String,CmsXmlContentProperty> properties,
                      CmsSitemapClipboardData clipboardData,
                      java.util.List<CmsContextMenuEntryBean> contextMenuEntries,
                      java.util.Map<java.lang.String,CmsClientProperty> parentProperties,
                      java.util.List<java.lang.String> allPropNames,
                      java.lang.String exportRfsPrefix,
                      boolean isSecure,
                      java.lang.String noEditReason,
                      boolean displayToolbar,
                      CmsNewResourceInfo defaultNewElementInfo,
                      java.util.List<CmsNewResourceInfo> newElementInfos,
                      CmsNewResourceInfo newRedirectElementInfo,
                      CmsNewResourceInfo newNavigationLevelElementInfo,
                      CmsSitemapInfo sitemapInfo,
                      java.lang.String parentSitemap,
                      CmsClientSitemapEntry root,
                      java.lang.String openPath,
                      int maxDepth,
                      CmsDetailPageTable detailPageTable,
                      java.util.List<CmsNewResourceInfo> resourceTypeInfos,
                      java.lang.String returnCode,
                      boolean canEditDetailPages,
                      java.lang.String aliasImportUrl,
                      boolean canEditAliases,
                      boolean createNewFoldersForSubsitemaps,
                      boolean galleryManager,
                      boolean categoryManager,
                      java.util.List<CmsListInfoBean> subsitemapTypeInfos,
                      CmsSitemapData.EditorMode editorMode,
                      java.lang.String defaultGalleryFolder,
                      boolean showModelEditConfirm)

Constructor.

Parameters:

templates - the available templates

properties - the properties

clipboardData - the clipboard data

contextMenuEntries - the sitemap context menu entries

parentProperties - the root entry's parent's inherited properties

allPropNames - the names of all properties

exportRfsPrefix - the export RFS prefix

isSecure - true if there is a secure server configuration for the site which contains the sitemap

noEditReason - the reason why the current sitemap is not editable

displayToolbar - the flag to control the display of the toolbar

defaultNewElementInfo - the type of the container page resource

newElementInfos - the new element information

newRedirectElementInfo - the new redirect element info

newNavigationLevelElementInfo - the new navigation level element info

sitemapInfo - the sitemap info bean

parentSitemap - the path to the parent sitemap or null

root - the sitemap root

openPath - the path at which the sitemap should be opened

maxDepth - the maximum sitemap depth

detailPageTable - the detail page table

resourceTypeInfos - the resource type information for the detail pages

returnCode - return page code

canEditDetailPages - flag to indicate whether detail pages can be edited

aliasImportUrl - the URL of the JSP used to import aliases

canEditAliases - flag to indicate whether the current user can edit the alias table

createNewFoldersForSubsitemaps - flag to control whether new folders should be created for subsitemaps

galleryManager - true if the user is a gallery manager

categoryManager - true if the user is a category manager

subsitemapTypeInfos - the type information beans for the available subsitemap folder types

editorMode - the editor mode

defaultGalleryFolder - default gallery parent folder

showModelEditConfirm - the show model edit confirm dialog flag

Method Detail

canEditAliases

public boolean canEditAliases()

Checks whether the current user can edit the aliases.

Returns:

true if the current user can edit the aliases

canEditDetailPages

public boolean canEditDetailPages()

Returns true if the detail pages can be edited.

Returns:

true if the detail pages can be edited

getAliasImportUrl

public java.lang.String getAliasImportUrl()

Gets the URL of the JSP used to import aliases.

Returns:

the alias import URL

getAllPropertyNames

public java.util.List<java.lang.String> getAllPropertyNames()

Returns the names of all properties.

Returns:

the names of all properties

getClipboardData

public CmsSitemapClipboardData getClipboardData()

Returns the clipboard data.

Returns:

the clipboard data

getContextMenuEntries

public java.util.List<CmsContextMenuEntryBean> getContextMenuEntries()

Returns the sitemap context menu entries.

Returns:

the sitemap context menu entries

getDefaultGalleryFolder

public java.lang.String getDefaultGalleryFolder()

Returns the default gallery parent folder.

Returns:

the default gallery parent folder

getDefaultNewElementInfo

public CmsNewResourceInfo getDefaultNewElementInfo()

Returns the type of the container page resource.

Returns:

the type of the container page resource

getDetailPageTable

public CmsDetailPageTable getDetailPageTable()

Gets the detail page table.

Returns:

the detail page table

getEditorMode

public CmsSitemapData.EditorMode getEditorMode()

Returns the editor mode.

Returns:

the editor mode

getExportRfsPrefix

public java.lang.String getExportRfsPrefix()

Returns the export RFS prefix.

Returns:

the export RFS prefix

getMaxDepth

public int getMaxDepth()

Returns the maximum sitemap depth.

Returns:

the maximum sitemap depth

getNewElementInfos

public java.util.List<CmsNewResourceInfo> getNewElementInfos()

Returns the new element information.

Returns:

the new element information

getNewNavigationLevelElementInfo

public CmsNewResourceInfo getNewNavigationLevelElementInfo()

Returns the new navigation level element info.

Returns:

the new navigation level element info

getNewRedirectElementInfo

public CmsNewResourceInfo getNewRedirectElementInfo()

Returns the new redirect element info.

Returns:

the new redirect element info

getNewResourceInfoById

public CmsNewResourceInfo getNewResourceInfoById(CmsUUID id)

Gets the new resource info with a given structure id.

Parameters:

id - the structure id

Returns:

the new resource info with the given id

getNoEditReason

public java.lang.String getNoEditReason()

Returns the reason why the current sitemap is not editable.

Returns:

the reason why the current sitemap is not editable

getOpenPath

public java.lang.String getOpenPath()

Gets the path at which the sitemap should be opened (may be null).

Returns:

the path at which the sitemap should be opened

getParentProperties

public java.util.Map<java.lang.String,CmsClientProperty> getParentProperties()

Returns the properties of the sitemap root's parent.

Returns:

the properties of the sitemap root'S parent

getParentSitemap

public java.lang.String getParentSitemap()

Returns the path to the parent sitemap or null.

Returns:

the path to the parent sitemap or null

getProperties

public java.util.Map<java.lang.String,CmsXmlContentProperty> getProperties()

Returns the properties.

Returns:

the properties

getResourceTypeInfos

public java.util.List<CmsNewResourceInfo> getResourceTypeInfos()

Gets the resource type info beans for the detail pages.

Returns:

the resource type info beans for the detail pages

getReturnCode

public java.lang.String getReturnCode()

Returns the return page code.

Returns:

the return page code

getRoot

public CmsClientSitemapEntry getRoot()

Returns the sitemap root.

Returns:

the sitemap root

getSitemapInfo

public CmsSitemapInfo getSitemapInfo()

Returns the sitemap info.

Returns:

the sitemap info

getSiteRootId

public CmsUUID getSiteRootId()

Gets the structure id of the site root.

Returns:

the structure id of the site root

getSubsitemapFolderTypeInfos

public java.util.List<CmsListInfoBean> getSubsitemapFolderTypeInfos()

Returns the list info beans for the available sitemap folder types.

Returns:

the list info beans for the available sitemap folder types

getTemplates

public java.util.Map<java.lang.String,CmsClientTemplateBean> getTemplates()

Returns the available templates.

Returns:

the available templates

isCategoryManager

public boolean isCategoryManager()

Returns if the current user has the category manager role.

Returns:

if the current user has the category manager role

isCreateNewFoldersForSubsitemaps

public boolean isCreateNewFoldersForSubsitemaps()

Returns true if new folders should be created for subsitemaps.

Returns:

true if new folders should be created for subsitemaps

isDisplayToolbar

public boolean isDisplayToolbar()

Checks if to display the toolbar.

Returns:

true if to display the toolbar

isGalleryManager

public boolean isGalleryManager()

Returns if the current user has the gallery manager role.

Returns:

if the current user has the gallery manager role

isLocaleComparisonEnabled

public boolean isLocaleComparisonEnabled()

Returns true if the locale compare mode is enabled.

Returns:

true if the locale compare mode is enabled

isSecure

public boolean isSecure()

Returns true if there is a secure server configured for the site which contains the sitemap.

Returns:

true if there is a secure server configured for the site which contains the sitemap

isShowModelEditConfirm

public boolean isShowModelEditConfirm()

Returns the show model edit confirm dialog flag.

Returns:

the show model edit confirm dialog flag

setLocaleComparisonEnabled

public void setLocaleComparisonEnabled(boolean enabled)

Sets the 'locale comparison mode enabled' flag.

Parameters:

enabled - the new flag value

setNewElementInfos

public void setNewElementInfos(java.util.List<CmsNewResourceInfo> newElementInfos)

Sets the new element infos.

Parameters:

newElementInfos - the new element infos

setReturnCode

public void setReturnCode(java.lang.String returnCode)

Sets the return page code.

Parameters:

returnCode - the return page code to set

setSiteRootId

public void setSiteRootId(CmsUUID id)

Sets the site root structure id .

Parameters:

id - the site root id