org.opencms.ade.containerpage.shared

类 CmsCntPageData

java.lang.Object

org.opencms.ade.containerpage.shared.CmsCntPageData

所有已实现的接口:

com.google.gwt.user.client.rpc.IsSerializable

public final class CmsCntPageData
extends java.lang.Object
implements com.google.gwt.user.client.rpc.IsSerializable

Convenience class to provide server-side information to the client.

从以下版本开始:

8.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DICT_NAME Name of the used dictionary.
static java.lang.String	JSONKEY_DETAIL_ELEMENT_ID Key 'detailElementId' for the detail content id.
static java.lang.String	JSONKEY_DETAILONLY Key 'isDetailOnly' used within the JSON representation of a container object.
static java.lang.String	JSONKEY_DETAILVIEW Key 'isDetailView' used within the JSON representation of a container object.
static java.lang.String	JSONKEY_ELEMENT_ID Key 'elementId' for the element id.
static java.lang.String	JSONKEY_ELEMENTS Key 'elements' used within the JSON representation of a container object.
static java.lang.String	JSONKEY_MAXELEMENTS Key 'maxElements' used within the JSON representation of a container object.
static java.lang.String	JSONKEY_NAME Key 'name' used within the JSON representation of a container object.
static java.lang.String	JSONKEY_TYPE Key 'type' used within the JSON representation of a container object.
static java.lang.String	JSONKEY_WIDTH Key 'width' used within the JSON representation of a container object.
static java.lang.String	KEY_CONTAINER_DATA Key for container data.

构造器概要

构造器

限定符	构造器和说明
protected	CmsCntPageData() Serialization constructor.
	CmsCntPageData(java.lang.String noEditReason, java.lang.String requestParams, java.lang.String sitemapUri, CmsUUID detailId, java.lang.String detailContainerPage, java.util.Map<java.lang.String,java.lang.String> newTypes, long lastModified, java.lang.String lockInfo, java.lang.String locale, boolean useClassicEditor, CmsTemplateContextInfo contextInfo, boolean showSmallElementsInitially) Constructor.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getBacklinkUri() Returns the xml-content editor back-link URI.
long	getDateLastModified() Gets the date at which the page was last modified.
java.lang.String	getDetailContainerPage() Returns the detail view container resource path.
CmsUUID	getDetailId() Returns the detail structure id, if available.
java.lang.String	getEditorUri() Returns the xml-content editor URI.
java.lang.String	getLocale() Returns the content locale.
java.lang.String	getLockInfo() Returns the lock information, if the page is locked by another user.
java.util.Map<java.lang.String,java.lang.String>	getNewTypes() Returns the map of available types and their new resource id's.
java.lang.String	getNoEditReason() Returns the no-edit reason.
java.lang.String	getRequestParams() Returns the request parameters.
java.lang.String	getSitemapUri() Returns the sitemap URI.
CmsTemplateContextInfo	getTemplateContextInfo() Gets the template context information.
boolean	isEditSmallElementsInitially() Returns true if small elements should be editable initially.
boolean	isUseClassicEditor() Returns if the classic XmlContent editor should be used.

从类继承的方法 java.lang.Object

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

字段详细资料

DICT_NAME

public static final java.lang.String DICT_NAME

Name of the used dictionary.

另请参阅:

常量字段值

JSONKEY_DETAILONLY

public static final java.lang.String JSONKEY_DETAILONLY

Key 'isDetailOnly' used within the JSON representation of a container object.

另请参阅:

常量字段值

JSONKEY_DETAILVIEW

public static final java.lang.String JSONKEY_DETAILVIEW

Key 'isDetailView' used within the JSON representation of a container object.

另请参阅:

常量字段值

JSONKEY_ELEMENTS

public static final java.lang.String JSONKEY_ELEMENTS

Key 'elements' used within the JSON representation of a container object.

另请参阅:

常量字段值

JSONKEY_MAXELEMENTS

public static final java.lang.String JSONKEY_MAXELEMENTS

Key 'maxElements' used within the JSON representation of a container object.

另请参阅:

常量字段值

JSONKEY_NAME

public static final java.lang.String JSONKEY_NAME

Key 'name' used within the JSON representation of a container object.

另请参阅:

常量字段值

JSONKEY_TYPE

public static final java.lang.String JSONKEY_TYPE

Key 'type' used within the JSON representation of a container object.

另请参阅:

常量字段值

JSONKEY_WIDTH

public static final java.lang.String JSONKEY_WIDTH

Key 'width' used within the JSON representation of a container object.

另请参阅:

常量字段值

JSONKEY_ELEMENT_ID

public static final java.lang.String JSONKEY_ELEMENT_ID

Key 'elementId' for the element id.

另请参阅:

常量字段值

JSONKEY_DETAIL_ELEMENT_ID

public static final java.lang.String JSONKEY_DETAIL_ELEMENT_ID

Key 'detailElementId' for the detail content id.

另请参阅:

常量字段值

KEY_CONTAINER_DATA

public static final java.lang.String KEY_CONTAINER_DATA

Key for container data. This has to be identical with CmsJspTagContainer.KEY_CONTAINER_DATA.

另请参阅:

常量字段值

构造器详细资料

CmsCntPageData

public CmsCntPageData(java.lang.String noEditReason,
              java.lang.String requestParams,
              java.lang.String sitemapUri,
              CmsUUID detailId,
              java.lang.String detailContainerPage,
              java.util.Map<java.lang.String,java.lang.String> newTypes,
              long lastModified,
              java.lang.String lockInfo,
              java.lang.String locale,
              boolean useClassicEditor,
              CmsTemplateContextInfo contextInfo,
              boolean showSmallElementsInitially)

Constructor.

参数:

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

detailId - the detail resource id, if available

detailContainerPage - the detail view container resource path

newTypes - the map of available types and their new resource id's

lastModified - the last modification date of the page

lockInfo - lock information, if the page is locked by another user

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

CmsCntPageData

protected CmsCntPageData()

Serialization constructor.

方法详细资料

getBacklinkUri

public java.lang.String getBacklinkUri()

Returns the xml-content editor back-link URI.

返回:

the back-link URI

getDateLastModified

public long getDateLastModified()

Gets the date at which the page was last modified.

返回:

the date at which the page was last modified

getDetailContainerPage

public java.lang.String getDetailContainerPage()

Returns the detail view container resource path.

返回:

the detail view container resource path

getDetailId

public CmsUUID getDetailId()

Returns the detail structure id, if available.

返回:

the detail structure id

getEditorUri

public java.lang.String getEditorUri()

Returns the xml-content editor URI.

返回:

the xml-content editor URI

getLocale

public java.lang.String getLocale()

Returns the content locale.

返回:

the locale

getLockInfo

public java.lang.String getLockInfo()

Returns the lock information, if the page is locked by another user.

返回:

the lock infomation

getNewTypes

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

Returns the map of available types and their new resource id's.

返回:

the map of available types and their new resource id's

getNoEditReason

public java.lang.String getNoEditReason()

Returns the no-edit reason.

返回:

the no-edit reason, if empty editing is allowed

getRequestParams

public java.lang.String getRequestParams()

Returns the request parameters.

返回:

the request parameters

getSitemapUri

public java.lang.String getSitemapUri()

Returns the sitemap URI.

返回:

the sitemap URI

getTemplateContextInfo

public CmsTemplateContextInfo getTemplateContextInfo()

Gets the template context information.

返回:

the template context information

isEditSmallElementsInitially

public boolean isEditSmallElementsInitially()

Returns true if small elements should be editable initially.

返回:

true if small elements should be editable initially

isUseClassicEditor

public boolean isUseClassicEditor()

Returns if the classic XmlContent editor should be used.

返回:

true if the classic XmlContent editor should be used