Package org.opencms.ade.containerpage.shared

Class CmsCntPageData

java.lang.Object
org.opencms.ade.containerpage.shared.CmsCntPageData
All Implemented Interfaces:
com.google.gwt.user.client.rpc.IsSerializable
public final class CmsCntPageData extends Object implements com.google.gwt.user.client.rpc.IsSerializable
Convenience class to provide server-side information to the client.

Since:
8.0.0

  • Field Details

  • Constructor Details

    • CmsCntPageData

      public CmsCntPageData(String onlineLink, String noEditReason, String requestParams, String sitemapUri, boolean sitemapManager, CmsUUID detailId, String detailContainerPage, CmsUUID detailContainerPageId, Set<String> detailTypes, long lastModified, String lockInfo, CmsListInfoBean pageInfo, String locale, boolean useClassicEditor, CmsTemplateContextInfo contextInfo, boolean showSmallElementsInitially, List<CmsElementViewInfo> elementViews, CmsElementViewInfo elementView, CmsCntPageData.ElementReuseMode reuseMode, CmsCntPageData.ElementDeleteMode deleteMode, boolean isModelPage, boolean isModelGroup, String modelGroupEmenetId, String mainLocale, Map<String,CmsLocaleLinkBean> localeLinkBeans, String appTitle, long loadTime)
      Constructor.

      Parameters:
      onlineLink - the online link to the current page
      noEditReason - the reason why the current user is not allowed to edit the current container page
      requestParams - the original request parameters
      sitemapUri - the current sitemap URI
      sitemapManager - if the user has the sitemap manager role
      detailId - the detail resource id, if available
      detailContainerPage - the detail view container resource path
      detailContainerPageId - the detail view container page structure id
      detailTypes - the set of names of types for which this page is registered as detail page
      lastModified - the last modification date of the page
      lockInfo - lock information, if the page is locked by another user
      pageInfo - the current page info
      locale - the content locale
      useClassicEditor - true to use the classic XmlContent editor
      contextInfo - the template context information
      showSmallElementsInitially - flag which controls whether small elements should be shown initially
      elementViews - the element views
      elementView - the current element view
      reuseMode - the element reuse mode
      deleteMode - the element delete mode
      isModelPage - true if this is a model page
      isModelGroup - true if the page is used for model groups
      modelGroupEmenetId - the model group base element id
      mainLocale - the main locale to this page in case it is part of a locale group
      localeLinkBeans - beans for links to other pages in the locale group
      appTitle - the title to display in the toolbar
      loadTime - the current time

    • CmsCntPageData

      protected CmsCntPageData()
      Serialization constructor.

  • Method Details

    • allowSettingsInEditor

      public boolean allowSettingsInEditor()
      Returns whether editing settings in the content editor is allowed.

      Returns:
      true in case editing settings in the content editor is allowed

    • getAppTitle

      public String getAppTitle()
      Gets the title to display in the toolbar.

      Returns:
      the title for the toolbar

    • getBacklinkUri

      public String getBacklinkUri()
      Returns the xml-content editor back-link URI.

      Returns:
      the back-link URI

    • getDateLastModified

      public long getDateLastModified()
      Gets the date at which the page was last modified.

      Returns:
      the date at which the page was last modified

    • getDeleteMode

      public CmsCntPageData.ElementDeleteMode getDeleteMode()
      Returns the element delete mode.

      Returns:
      the element delete mode

    • getDetailContainerPage

      public String getDetailContainerPage()
      Returns the detail view container resource path.

      Returns:
      the detail view container resource path

    • getDetailContainerPageId

      public CmsUUID getDetailContainerPageId()
      Gets the structure id of the detail container page (or null if we are not on on a detail page, or there is no detail container page).
      Returns:
      the structure id of the detail container page

    • getDetailId

      public CmsUUID getDetailId()
      Returns the detail structure id, if available.

      Returns:
      the detail structure id

    • getDetailTypes

      public Set<String> getDetailTypes()
      Gets the set of names of types for which the container page is registered as a detail page.
      Returns:
      the set of names of detail types

    • getElementReuseMode

      public CmsCntPageData.ElementReuseMode getElementReuseMode()
      Gets the element reuse mode.

      Returns:
      the element reuse mode

    • getElementView

      public CmsElementViewInfo getElementView()
      Returns the current element view.

      Returns:
      the current element view

    • getElementViews

      public List<CmsElementViewInfo> getElementViews()
      Returns the available element views.

      Returns:
      the element views

    • getLoadTime

      public long getLoadTime()
      Returns the time off page load.

      Returns:
      the time stamp

    • getLocale

      public String getLocale()
      Returns the content locale.

      Returns:
      the locale

    • getLocaleLinkBeans

      public Map<String,CmsLocaleLinkBean> getLocaleLinkBeans()
      Gets the locale link beans, with localized language names as keys.

      The beans represent links to different locale variants of this page.

      Returns:
      the locale link bean map for this

    • getLockInfo

      public String getLockInfo()
      Returns the lock information, if the page is locked by another user.

      Returns:
      the lock infomation

    • getMainLocale

      public String getMainLocale()
      Returns the main locale to this page in case it is part of a locale group.

      Returns:
      the main locale to this page in case it is part of a locale group

    • getModelGroupElementId

      public String getModelGroupElementId()
      Returns the model group base element id.

      Returns:
      the model group base element id

    • getNoEditReason

      public String getNoEditReason()
      Returns the no-edit reason.

      Returns:
      the no-edit reason, if empty editing is allowed

    • getOnlineLink

      public String getOnlineLink()
      Returns the online link to the current page.

      Returns:
      the online link to the current page

    • getPageInfo

      public CmsListInfoBean getPageInfo()
      Returns the current page info.

      Returns:
      the current page info

    • getRequestParams

      public String getRequestParams()
      Returns the request parameters.

      Returns:
      the request parameters

    • getRpcContext

      public CmsContainerPageRpcContext getRpcContext()
      Gets the RPC context.

      Returns:
      the RPC context

    • getSessionStorageData

      public Map<String,String> getSessionStorageData()
      Gets the key-value pairs to store in the session storage of the browser.
      Returns:
      the map of entries to store in the session storage

    • getSitemapUri

      public String getSitemapUri()
      Returns the sitemap URI.

      Returns:
      the sitemap URI

    • getTemplateContextInfo

      public CmsTemplateContextInfo getTemplateContextInfo()
      Gets the template context information.

      Returns:
      the template context information

    • isEditSmallElementsInitially

      public boolean isEditSmallElementsInitially()
      Returns true if small elements should be editable initially.

      Returns:
      true if small elements should be editable initially

    • isModelGroup

      public boolean isModelGroup()
      Returns if the page is used for model groups.

      Returns:
      true if the page is used for model groups

    • isModelPage

      public boolean isModelPage()
      True if the container page is a model page.

      Returns:
      true if this is a model page

    • isPlacementModeEnabled

      public boolean isPlacementModeEnabled()
      Returns true if placement mode is enabled.
      Returns:
      true if placement mode is enabled

    • isSitemapManager

      public boolean isSitemapManager()
      Returns if the current user has the sitemap manager role.

      Returns:
      if the current user has the sitemap manager role

    • isUseClassicEditor

      public boolean isUseClassicEditor()
      Returns if the classic XmlContent editor should be used.

      Returns:
      true if the classic XmlContent editor should be used

    • setAllowSettingsInEditor

      public void setAllowSettingsInEditor(boolean allowSettingsInEditor)
      Sets whether editing settings in the content editor is allowed.

      Parameters:
      allowSettingsInEditor - true to set editing settings in the content editor is allowed

    • setDetailContainerPageId

      public void setDetailContainerPageId(CmsUUID pageId)
      Sets the detail container page id.
      Parameters:
      pageId - the detail container page id

    • setPlacementModeEnabled

      public void setPlacementModeEnabled(boolean placementModeEnabled)
      Sets the 'placement mode enabled' flag.
      Parameters:
      placementModeEnabled - the new value for the 'placement mode enabled' flag

    • setRpcContext

      public void setRpcContext(CmsContainerPageRpcContext context)
      Sets the RPC context.

      Parameters:
      context - the RPC context

    • setSessionStorageData

      public void setSessionStorageData(Map<String,String> sessionStorageData)
      Sets the entries to store in the browser's session storage.
      Parameters:
      sessionStorageData - the entries to store in the browser's session storage