Package 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 Object implements com.google.gwt.user.client.rpc.IsSerializable
Sitemap initialization data bean for prefetching.

Since:
8.0

  • Field Details

  • Constructor Details

    • CmsSitemapData

      public CmsSitemapData()
      Constructor.

    • CmsSitemapData

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

    • 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 String getAliasImportUrl()
      Gets the URL of the JSP used to import aliases.

      Returns:
      the alias import URL

    • getAllPropertyNames

      public List<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 List<CmsContextMenuEntryBean> getContextMenuEntries()
      Returns the sitemap context menu entries.

      Returns:
      the sitemap context menu entries

    • getDefaultGalleryFolder

      public 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 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 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 String getNoEditReason()
      Returns the reason why the current sitemap is not editable.

      Returns:
      the reason why the current sitemap is not editable

    • getOpenPath

      public 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 Map<String,CmsClientProperty> getParentProperties()
      Returns the properties of the sitemap root's parent.

      Returns:
      the properties of the sitemap root'S parent

    • getParentSitemap

      public String getParentSitemap()
      Returns the path to the parent sitemap or null.

      Returns:
      the path to the parent sitemap or null

    • getProperties

      public Map<String,CmsXmlContentProperty> getProperties()
      Returns the properties.

      Returns:
      the properties

    • getResourceTypeInfos

      public 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 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 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 Map<String,CmsClientTemplateBean> getTemplates()
      Returns the available templates.

      Returns:
      the available templates

    • isAllowCreateNestedGalleries

      public boolean isAllowCreateNestedGalleries()
      Checks if creation of nested galleries is allowed.
      Returns:
      true if creation of nested galleries is allowed

    • 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

    • setAllowCreateNestedGalleries

      public void setAllowCreateNestedGalleries(boolean allowCreateNestedGalleries)
      Enable or disable option for creating nested galleries.
      Parameters:
      allowCreateNestedGalleries - true if nested galleries are allowed

    • setLocaleComparisonEnabled

      public void setLocaleComparisonEnabled(boolean enabled)
      Sets the 'locale comparison mode enabled' flag.

      Parameters:
      enabled - the new flag value

    • setNewElementInfos

      public void setNewElementInfos(List<CmsNewResourceInfo> newElementInfos)
      Sets the new element infos.

      Parameters:
      newElementInfos - the new element infos

    • setReturnCode

      public void setReturnCode(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