Class CmsCoreData

  • All Implemented Interfaces:
    com.google.gwt.user.client.rpc.IsSerializable

    public class CmsCoreData
    extends java.lang.Object
    implements com.google.gwt.user.client.rpc.IsSerializable
    Runtime data bean for prefetching.

    Since:
    8.0.0
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DICT_NAME
      Name of the used js variable.
      static java.lang.String KEY_GWT_BUILDID
      The key for the GWT build id property.
      protected long m_serverTime
      The time sent from the server when loading the data.
      protected CmsCoreData.UserInfo m_userInfo
      A bean with information about the current user.
      static java.lang.String META_PARAM_MODULE_KEY
      The meta element name to the requested module key.
      static java.lang.String PARAM_PATH
      The parameter name for path.
      static java.lang.String PARAM_RETURNCODE
      The parameter name for the return code.
    • Constructor Summary

      Constructors 
      Constructor Description
      CmsCoreData()
      Constructor.
      CmsCoreData​(java.lang.String contentEditorUrl, java.lang.String contentEditorBacklinkUrl, java.lang.String loginUrl, java.lang.String vfsPrefix, java.lang.String fileExplorerLink, java.lang.String workplaceResourcesPrefix, java.lang.String embeddedDialogsUrl, java.lang.String siteRoot, CmsUUID projectId, java.lang.String locale, java.lang.String wpLocale, java.lang.String uri, java.lang.String navigationUri, CmsUUID structureId, java.util.Map<java.lang.String,​java.lang.String> extensionMapping, java.util.Map<java.lang.String,​java.lang.String> iconMapping, long serverTime, boolean isShowEditorHelp, boolean toolbarVisible, java.lang.String defaultWorkplaceLink, java.lang.String aboutLink, CmsCoreData.UserInfo userInfo, long uploadFileSizeLimit, boolean isKeepAlive, boolean uploadDisabled, java.util.Map<java.lang.String,​java.lang.String> adeParameters)
      Constructor.
      CmsCoreData​(CmsCoreData clone)
      Clone constructor.
    • Constructor Detail

      • CmsCoreData

        public CmsCoreData​(CmsCoreData clone)
        Clone constructor.

        Parameters:
        clone - the instance to clone
      • CmsCoreData

        public CmsCoreData​(java.lang.String contentEditorUrl,
                           java.lang.String contentEditorBacklinkUrl,
                           java.lang.String loginUrl,
                           java.lang.String vfsPrefix,
                           java.lang.String fileExplorerLink,
                           java.lang.String workplaceResourcesPrefix,
                           java.lang.String embeddedDialogsUrl,
                           java.lang.String siteRoot,
                           CmsUUID projectId,
                           java.lang.String locale,
                           java.lang.String wpLocale,
                           java.lang.String uri,
                           java.lang.String navigationUri,
                           CmsUUID structureId,
                           java.util.Map<java.lang.String,​java.lang.String> extensionMapping,
                           java.util.Map<java.lang.String,​java.lang.String> iconMapping,
                           long serverTime,
                           boolean isShowEditorHelp,
                           boolean toolbarVisible,
                           java.lang.String defaultWorkplaceLink,
                           java.lang.String aboutLink,
                           CmsCoreData.UserInfo userInfo,
                           long uploadFileSizeLimit,
                           boolean isKeepAlive,
                           boolean uploadDisabled,
                           java.util.Map<java.lang.String,​java.lang.String> adeParameters)
        Constructor.

        Parameters:
        contentEditorUrl - the XML content editor URL
        contentEditorBacklinkUrl - the XML content editor back-link URL
        loginUrl - the login JSP URL
        vfsPrefix - the OpenCms VFS prefix
        fileExplorerLink - the file explorer link
        workplaceResourcesPrefix - the workplace resources path prefix
        embeddedDialogsUrl - the embedded dialogs URL
        siteRoot - the current site root
        projectId - the project id
        locale - the current request locale
        wpLocale - the workplace locale
        uri - the current uri
        structureId - the structure id of tbe resource
        navigationUri - the current navigation URI
        extensionMapping - the mappings of file extensions to resource types
        iconMapping - the resource icon mapping
        serverTime - the current time
        isShowEditorHelp - the show editor help flag
        toolbarVisible - a flag to indicate whether the toolbar should be visible initially
        defaultWorkplaceLink - the default link to use for opening the workplace
        aboutLink - the link to the "About" page
        userInfo - information about the current user
        uploadFileSizeLimit - the file upload size limit
        isKeepAlive - the keep-alive mode
        uploadDisabled - true if upload buttons should be disabled
        adeParameters - the map of ADE configuration parameters
    • Method Detail

      • getAboutLink

        public java.lang.String getAboutLink()
        Gets the "About" link.

        Returns:
        the "about" link
      • getAdeParameters

        public java.util.Map<java.lang.String,​java.lang.String> getAdeParameters()
        Gets the map of ADE configuration parameters.

        Returns:
        the ADE configuration parameters
      • getContentEditorBacklinkUrl

        public java.lang.String getContentEditorBacklinkUrl()
        Returns the XML content editor back-link URL.

        Returns:
        the XML content editor back-link URL
      • getContentEditorUrl

        public java.lang.String getContentEditorUrl()
        Returns the XML content editor URL.

        Returns:
        the XML content editor URL
      • getDefaultWorkplaceLink

        public java.lang.String getDefaultWorkplaceLink()
        Gets the default link to use for opening the workplace.

        Returns:
        the default workplace link
      • getEmbeddedDialogsUrl

        public java.lang.String getEmbeddedDialogsUrl()
        Returns the embeddedDialogsUrl.

        Returns:
        the embeddedDialogsUrl
      • getExtensionMapping

        public java.util.Map<java.lang.String,​java.lang.String> getExtensionMapping()
        Returns the extensionMapping.

        Returns:
        the extensionMapping
      • getIconMapping

        public java.util.Map<java.lang.String,​java.lang.String> getIconMapping()
        Returns the resource icon mapping.

        Returns:
        the resource icon mapping
      • getLocale

        public java.lang.String getLocale()
        Returns the current request locale.

        Returns:
        the current request locale
      • getLoginURL

        public java.lang.String getLoginURL()
        Returns the login URL.

        Returns:
        the login URL
      • getNavigationUri

        public java.lang.String getNavigationUri()
        Returns the current navigation (sitemap) URI.

        Returns:
        the current navigation URI
      • getServerTime

        public long getServerTime()
        Returns the time of the server when the data was loaded.

        Returns:
        the time of the server when the data was loaded
      • getSiteRoot

        public java.lang.String getSiteRoot()
        Returns the current site root.

        Returns:
        the current site root
      • getStructureId

        public CmsUUID getStructureId()
        Gets the structure id of the current resource.

        Returns:
        the structure id of the current resource
      • getUploadFileSizeLimit

        public long getUploadFileSizeLimit()
        Returns the file upload size limit.

        Returns:
        the file upload size limit
      • getUri

        public java.lang.String getUri()
        Returns the current uri.

        Returns:
        the current uri
      • getVfsPrefix

        public java.lang.String getVfsPrefix()
        Returns the OpenCms VFS prefix.

        Returns:
        the OpenCms VFS prefix
      • getWorkplaceResourcesPrefix

        public java.lang.String getWorkplaceResourcesPrefix()
        Returns the workplace resources path prefix.

        Returns:
        the workplace resources path prefix
      • getWpLocale

        public java.lang.String getWpLocale()
        Returns the current workplace locale.

        Returns:
        the current workplace locale
      • isKeepAlive

        public boolean isKeepAlive()
        Returns true if the session should be kept alive even without user actions.

        Returns:
        true if keep-alive mode is active
      • isShowEditorHelp

        public boolean isShowEditorHelp()
        Returns the show editor help flag.

        Returns:
        the show editor help flag
      • isToolbarVisible

        public boolean isToolbarVisible()
        Returns true if the toolbar should be visible initially.

        Returns:
        true if the toolbar should be visible initially
      • isUploadDisabled

        public boolean isUploadDisabled()
        Checks if uploads are disabled.
        Returns:
        true if uploads are disabled
      • setTinymce

        public void setTinymce​(CmsTinyMCEData tinyMceData)
        Sets the data for the TinyMCE editor.

        Parameters:
        tinyMceData - the data for TinyMCE
      • getFileExplorerLink

        protected java.lang.String getFileExplorerLink()
        Returns the file explorer link prefix. Append resource site path for complete link.

        Returns:
        the file explorer link prefix
      • setShowEditorHelp

        protected void setShowEditorHelp​(boolean show)
        Sets the show editor help flag.

        Parameters:
        show - true to show editor help