Package org.opencms.ade.sitemap.shared

Class 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

    • Constructor Detail

      • 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

      • getDefaultGalleryFolder

        public java.lang.String getDefaultGalleryFolder()
        Returns the default gallery parent folder.

        Returns:
        the default gallery parent folder

      • 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

      • 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

      • 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

      • 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

      • 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