Package 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 Object
implements com.google.gwt.user.client.rpc.IsSerializable

Runtime data bean for prefetching.

Since:

8.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CmsCoreData.AdeContext	A enumeration for the ADE context.
static enum	CmsCoreData.ModuleKey	The available client modules.
static class	CmsCoreData.UserInfo	Bean class containing info about the current user.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DICT_NAME	Name of the used js variable.
static final 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 final String	META_PARAM_MODULE_KEY	The meta element name to the requested module key.
static final String	PARAM_PATH	The parameter name for path.
static final String	PARAM_RETURNCODE	The parameter name for the return code.

Constructor Summary

Constructors

Constructor	Description
CmsCoreData()	Constructor.
CmsCoreData(String contentEditorUrl, String contentEditorBacklinkUrl, String loginUrl, String vfsPrefix, String fileExplorerLink, String workplaceResourcesPrefix, String embeddedDialogsUrl, String siteRoot, String sharedFolder, CmsUUID projectId, String locale, String wpLocale, String uri, String navigationUri, CmsUUID structureId, Map<String,String> extensionMapping, Map<String,String> iconMapping, long serverTime, boolean isShowEditorHelp, boolean toolbarVisible, String defaultWorkplaceLink, String aboutLink, CmsCoreData.UserInfo userInfo, long uploadFileSizeLimit, boolean isKeepAlive, boolean uploadDisabled, Map<String,String> adeParameters, CmsUploadRestrictionInfo uploadRestriction, String categoryBaseFolder, boolean hideDisabledGalleryTypes, boolean warnWhenEditingReusedElement)	Constructor.
CmsCoreData(CmsCoreData clone)	Clone constructor.

Method Summary

Modifier and Type	Method	Description
String	getAboutLink()	Gets the "About" link.
Map<String,String>	getAdeParameters()	Gets the map of ADE configuration parameters.
String	getCategoryBaseFolder()	Gets the category folder name.
String	getContentEditorBacklinkUrl()	Returns the XML content editor back-link URL.
String	getContentEditorUrl()	Returns the XML content editor URL.
String	getDefaultWorkplaceLink()	Gets the default link to use for opening the workplace.
String	getEmbeddedDialogsUrl()	Returns the embeddedDialogsUrl.
Map<String,String>	getExtensionMapping()	Returns the extensionMapping.
protected String	getFileExplorerLink()	Returns the file explorer link prefix.
Map<String,String>	getIconMapping()	Returns the resource icon mapping.
String	getLocale()	Returns the current request locale.
String	getLoginURL()	Returns the login URL.
String	getNavigationUri()	Returns the current navigation (sitemap) URI.
CmsUUID	getProjectId()	Gets the project id.
long	getServerTime()	Returns the time of the server when the data was loaded.
String	getSharedFolder()	Gets the shared folder.
String	getSiteRoot()	Returns the current site root.
CmsUUID	getStructureId()	Gets the structure id of the current resource.
CmsTinyMCEData	getTinymce()	Gets the data for the TinyMCE editor.
long	getUploadFileSizeLimit()	Returns the file upload size limit.
CmsUploadRestrictionInfo	getUploadRestriction()	Gets the upload restriction data.
String	getUri()	Returns the current uri.
CmsCoreData.UserInfo	getUserInfo()	Gets the information about the current user.
String	getVfsPrefix()	Returns the OpenCms VFS prefix.
String	getWorkplaceResourcesPrefix()	Returns the workplace resources path prefix.
String	getWpLanguage()	Gets the language part of the workplace locale.
String	getWpLocale()	Returns the current workplace locale.
boolean	isHideDisabledGalleryTypes()	Returns true if deactivated types should be hidden in the gallery dialog.
boolean	isKeepAlive()	Returns true if the session should be kept alive even without user actions.
boolean	isShowEditorHelp()	Returns the show editor help flag.
boolean	isToolbarVisible()	Returns true if the toolbar should be visible initially.
boolean	isUploadDisabled()	Checks if uploads are disabled.
boolean	isWarnWhenEditingReusedElement()	Checks if a warning dialog should be shown when a reused element is edited.
protected void	setShowEditorHelp(boolean show)	Sets the show editor help flag.
void	setTinymce(CmsTinyMCEData tinyMceData)	Sets the data for the TinyMCE editor.
void	setWarnWhenEditingReusedElement(boolean warnWhenEditingReusedElement)	Enables/disables warning dialog when editing reused elements.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DICT_NAME

public static final String DICT_NAME

Name of the used js variable.

See Also:

• Constant Field Values

KEY_GWT_BUILDID

public static final String KEY_GWT_BUILDID

The key for the GWT build id property.

See Also:

• Constant Field Values

META_PARAM_MODULE_KEY

public static final String META_PARAM_MODULE_KEY

The meta element name to the requested module key.

See Also:

• Constant Field Values

PARAM_PATH

public static final String PARAM_PATH

The parameter name for path.

See Also:

• Constant Field Values

PARAM_RETURNCODE

public static final 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 Details

CmsCoreData

public CmsCoreData()

Constructor.

CmsCoreData

public CmsCoreData(CmsCoreData clone)

Clone constructor.

Parameters:

clone - the instance to clone

CmsCoreData

public CmsCoreData(String contentEditorUrl,
 String contentEditorBacklinkUrl,
 String loginUrl,
 String vfsPrefix,
 String fileExplorerLink,
 String workplaceResourcesPrefix,
 String embeddedDialogsUrl,
 String siteRoot,
 String sharedFolder,
 CmsUUID projectId,
 String locale,
 String wpLocale,
 String uri,
 String navigationUri,
 CmsUUID structureId,
 Map<String,String> extensionMapping,
 Map<String,String> iconMapping,
 long serverTime,
 boolean isShowEditorHelp,
 boolean toolbarVisible,
 String defaultWorkplaceLink,
 String aboutLink,
 CmsCoreData.UserInfo userInfo,
 long uploadFileSizeLimit,
 boolean isKeepAlive,
 boolean uploadDisabled,
 Map<String,String> adeParameters,
 CmsUploadRestrictionInfo uploadRestriction,
 String categoryBaseFolder,
 boolean hideDisabledGalleryTypes,
 boolean warnWhenEditingReusedElement)

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

sharedFolder - the shared folder

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

uploadRestriction - the upload restriction data

categoryBaseFolder - the category base folder

hideDisabledGalleryTypes - true if deactivated types should be hidden in the gallery dialog

warnWhenEditingReusedElement - true if a warning dialog should be shown when editing a reused element

Method Details

getAboutLink

public String getAboutLink()

Gets the "About" link.

Returns:

the "about" link

getAdeParameters

public Map<String,String> getAdeParameters()

Gets the map of ADE configuration parameters.

Returns:

the ADE configuration parameters

getCategoryBaseFolder

public String getCategoryBaseFolder()

Gets the category folder name.

Returns:

the category folder name

getContentEditorBacklinkUrl

public String getContentEditorBacklinkUrl()

Returns the XML content editor back-link URL.

Returns:

the XML content editor back-link URL

getContentEditorUrl

public String getContentEditorUrl()

Returns the XML content editor URL.

Returns:

the XML content editor URL

getDefaultWorkplaceLink

public String getDefaultWorkplaceLink()

Gets the default link to use for opening the workplace.

Returns:

the default workplace link

getEmbeddedDialogsUrl

public String getEmbeddedDialogsUrl()

Returns the embeddedDialogsUrl.

Returns:

the embeddedDialogsUrl

getExtensionMapping

public Map<String,String> getExtensionMapping()

Returns the extensionMapping.

Returns:

the extensionMapping

getIconMapping

public Map<String,String> getIconMapping()

Returns the resource icon mapping.

Returns:

the resource icon mapping

getLocale

public String getLocale()

Returns the current request locale.

Returns:

the current request locale

getLoginURL

public String getLoginURL()

Returns the login URL.

Returns:

the login URL

getNavigationUri

public String getNavigationUri()

Returns the current navigation (sitemap) URI.

Returns:

the current navigation URI

getProjectId

public CmsUUID getProjectId()

Gets the project id.

Returns:

the project id

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

getSharedFolder

public String getSharedFolder()

Gets the shared folder.

Returns:

the shared folder

getSiteRoot

public 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

getTinymce

public CmsTinyMCEData getTinymce()

Gets the data for the TinyMCE editor.

Returns:

the data for TinyMCE

getUploadFileSizeLimit

public long getUploadFileSizeLimit()

Returns the file upload size limit.

Returns:

the file upload size limit

getUploadRestriction

public CmsUploadRestrictionInfo getUploadRestriction()

Gets the upload restriction data.

Returns:

the upload restriction data

getUri

public 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 String getVfsPrefix()

Returns the OpenCms VFS prefix.

Returns:

the OpenCms VFS prefix

getWorkplaceResourcesPrefix

public String getWorkplaceResourcesPrefix()

Returns the workplace resources path prefix.

Returns:

the workplace resources path prefix

getWpLanguage

public String getWpLanguage()

Gets the language part of the workplace locale.

Returns:

the language part of the workplace locale

getWpLocale

public String getWpLocale()

Returns the current workplace locale.

Returns:

the current workplace locale

isHideDisabledGalleryTypes

public boolean isHideDisabledGalleryTypes()

Returns true if deactivated types should be hidden in the gallery dialog.

Returns:

true if deactivated types should be hidden

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

isWarnWhenEditingReusedElement

public boolean isWarnWhenEditingReusedElement()

Checks if a warning dialog should be shown when a reused element is edited.

Returns:

true if a warning dialog should be shown when editing reused elements

setTinymce

public void setTinymce(CmsTinyMCEData tinyMceData)

Sets the data for the TinyMCE editor.

Parameters:

tinyMceData - the data for TinyMCE

setWarnWhenEditingReusedElement

public void setWarnWhenEditingReusedElement(boolean warnWhenEditingReusedElement)

Enables/disables warning dialog when editing reused elements.

Parameters:

warnWhenEditingReusedElement - true if a warning dialog should be shown when editing reused elements

getFileExplorerLink

protected 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