org.opencms.gwt.shared
Class CmsCoreData

java.lang.Object
  org.opencms.gwt.shared.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

Nested Class Summary

static class	CmsCoreData.AdeContext A enumeration for the ADE context.
static class	CmsCoreData.UserInfo Bean class containing info about the current user.

Field Summary

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	PARAM_PATH The parameter name for path.
static java.lang.String	PARAM_RETURNCODE The parameter name for the return code.

Constructor Summary

CmsCoreData()
Constructor.

CmsCoreData(CmsCoreData clone)
Clone constructor.

CmsCoreData(java.lang.String contentEditorUrl, java.lang.String contentEditorBacklinkUrl, java.lang.String contentEditorDeleteLinkUrl, java.lang.String loginUrl, java.lang.String vfsPrefix, java.lang.String siteRoot, 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, long serverTime, boolean isShowEditorHelp, boolean toolbarVisible, java.lang.String defaultWorkplaceLink, CmsCoreData.UserInfo userInfo, long uploadFileSizeLimit)
Constructor.

Method Summary

java.lang.String	getContentEditorBacklinkUrl() Returns the XML content editor back-link URL.
java.lang.String	getContentEditorDeleteLinkUrl() Returns the XML content editor delete-link URL.
java.lang.String	getContentEditorUrl() Returns the XML content editor URL.
java.lang.String	getDefaultWorkplaceLink() Gets the default link to use for opening the workplace.
java.util.Map<java.lang.String,java.lang.String>	getExtensionMapping() Returns the extensionMapping.
java.lang.String	getLocale() Returns the current request locale.
java.lang.String	getLoginURL() Returns the login URL.
java.lang.String	getNavigationUri() Returns the current navigation (sitemap) URI.
long	getServerTime() Returns the time of the server when the data was loaded.
java.lang.String	getSiteRoot() Returns the current site root.
CmsUUID	getStructureId() Gets the structure id of the current resource.
long	getUploadFileSizeLimit() Returns the upload file size limit.
java.lang.String	getUri() Returns the current uri.
CmsCoreData.UserInfo	getUserInfo() Gets the information about the current user.
java.lang.String	getVfsPrefix() Returns the OpenCms VFS prefix.
java.lang.String	getWpLocale() Returns the current workplace locale.
boolean	isShowEditorHelp() Returns the show editor help flag.
boolean	isToolbarVisible() Returns true if the toolbar should be visible initially.

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

KEY_GWT_BUILDID

public static final java.lang.String KEY_GWT_BUILDID

The key for the GWT build id property.

See Also:

Constant Field Values

PARAM_PATH

public static final java.lang.String PARAM_PATH

The parameter name for path.

See Also:

Constant Field Values

PARAM_RETURNCODE

public static final java.lang.String PARAM_RETURNCODE

The parameter name for the return code.

See Also:

Constant Field Values

m_serverTime

protected long m_serverTime

The time sent from the server when loading the data.

m_userInfo

protected CmsCoreData.UserInfo m_userInfo

A bean with information about the current user.

Constructor Detail

CmsCoreData

public CmsCoreData()

Constructor.

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 contentEditorDeleteLinkUrl,
                   java.lang.String loginUrl,
                   java.lang.String vfsPrefix,
                   java.lang.String siteRoot,
                   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,
                   long serverTime,
                   boolean isShowEditorHelp,
                   boolean toolbarVisible,
                   java.lang.String defaultWorkplaceLink,
                   CmsCoreData.UserInfo userInfo,
                   long uploadFileSizeLimit)

Constructor.

Parameters:

contentEditorUrl - the XML content editor URL

contentEditorBacklinkUrl - the XML content editor back-link URL

contentEditorDeleteLinkUrl - the XML content editor delete-link URL

loginUrl - the login JSP URL

vfsPrefix - the OpenCms VFS prefix

siteRoot - the current site root

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

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

userInfo - information about the current user

uploadFileSizeLimit - the upload file size limit

Method Detail

getContentEditorBacklinkUrl

public java.lang.String getContentEditorBacklinkUrl()

Returns the XML content editor back-link URL.

Returns:

the XML content editor back-link URL

getContentEditorDeleteLinkUrl

public java.lang.String getContentEditorDeleteLinkUrl()

Returns the XML content editor delete-link URL.

Returns:

the XML content editor delete-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

getExtensionMapping

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

Returns the extensionMapping.

Returns:

the extensionMapping

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 upload file size limit.

Returns:

the upload file size limit

getUri

public java.lang.String getUri()

Returns the current uri.

Returns:

the current uri

getUserInfo

public CmsCoreData.UserInfo getUserInfo()

Gets the information about the current user.

Returns:

the information about the current user

getVfsPrefix

public java.lang.String getVfsPrefix()

Returns the OpenCms VFS prefix.

Returns:

the OpenCms VFS prefix

getWpLocale

public java.lang.String getWpLocale()

Returns the current workplace locale.

Returns:

the current workplace locale

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