org.opencms.ade.contenteditor.shared

类 CmsContentDefinition

java.lang.Object

com.alkacon.acacia.shared.ContentDefinition

org.opencms.ade.contenteditor.shared.CmsContentDefinition

所有已实现的接口:

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

public class CmsContentDefinition
extends com.alkacon.acacia.shared.ContentDefinition

Contains all information needed for editing an XMLContent.

构造器概要

构造器

限定符	构造器和说明
protected	CmsContentDefinition() Constructor for serialization only.
	CmsContentDefinition(com.alkacon.acacia.shared.Entity entity, java.util.Map<java.lang.String,com.alkacon.acacia.shared.AttributeConfiguration> configurations, java.util.Collection<CmsExternalWidgetConfiguration> externalWidgetConfigurations, java.util.Map<java.lang.String,CmsComplexWidgetData> complexWidgetData, java.util.Map<java.lang.String,com.alkacon.vie.shared.I_Type> types, java.util.List<com.alkacon.acacia.shared.TabInfo> tabInfos, java.lang.String locale, java.util.List<java.lang.String> contentLocales, java.util.Map<java.lang.String,java.lang.String> availableLocales, java.lang.String title, java.lang.String sitePath, java.lang.String resourceType, boolean performedAutocorrection, boolean autoUnlock) Constructor.
	CmsContentDefinition(java.util.List<CmsModelResourceInfo> modelInfos, java.lang.String newLink, CmsUUID referenceId, java.lang.String locale) Constructor for model file informations object.

方法概要

方法

限定符和类型	方法和说明
static CmsUUID	entityIdToUuid(java.lang.String entityId) Returns the UUID according to the given entity id.
java.util.Map<java.lang.String,java.lang.String>	getAvailableLocales() Returns the available locales.
java.util.Map<java.lang.String,CmsComplexWidgetData>	getComplexWidgetData() Gets the complex widget configurations.
java.util.List<java.lang.String>	getContentLocales() Returns the content locales.
java.util.List<CmsExternalWidgetConfiguration>	getExternalWidgetConfigurations() Returns the external widget configurations.
static java.lang.String	getLocaleFromId(java.lang.String entityId) Extracts the locale from the entity id.
java.util.List<CmsModelResourceInfo>	getModelInfos() Returns the model file informations.
java.lang.String	getNewLink() Returns the new link.
CmsUUID	getReferenceResourceId() Returns the reference resource structure id.
java.lang.String	getResourceType() Returns the resource type.
java.lang.String	getSitePath() Returns the site path.
java.lang.String	getTitle() Returns the title.
static java.lang.String	getValueForPath(com.alkacon.vie.shared.I_Entity entity, java.lang.String path) Returns the value for the given XPath expression.
boolean	isAutoUnlock() Returns the value of the acacia-unlock configuration option.
boolean	isDeleteOnCancel() Returns if the resource needs to removed on cancel.
boolean	isDirectEdit() Returns true if the direct edit flag is set, which means that the editor was opened from the classic direct edit mode.
boolean	isModelInfo() Returns if the model file informations are present, in this case no additional data is contained.
boolean	isPerformedAutocorrection() Returns if auto correction was performed.
void	setDeleteOnCancel(boolean deleteOnCancel) Sets if the resource needs to removed on cancel.
void	setDirectEdit(boolean isDirectEdit) Sets the value of the direct edit flag.
static java.lang.String	uuidToEntityId(CmsUUID uuid, java.lang.String locale) Returns the entity id according to the given UUID.

从类继承的方法 com.alkacon.acacia.shared.ContentDefinition

extractIndex, getConfigurations, getEntity, getEntityId, getEntityTypeName, getLocale, getTabInfos, getTypes, isGroupOptionalFields, removeIndex

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

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

构造器详细资料

CmsContentDefinition

public CmsContentDefinition(com.alkacon.acacia.shared.Entity entity,
                    java.util.Map<java.lang.String,com.alkacon.acacia.shared.AttributeConfiguration> configurations,
                    java.util.Collection<CmsExternalWidgetConfiguration> externalWidgetConfigurations,
                    java.util.Map<java.lang.String,CmsComplexWidgetData> complexWidgetData,
                    java.util.Map<java.lang.String,com.alkacon.vie.shared.I_Type> types,
                    java.util.List<com.alkacon.acacia.shared.TabInfo> tabInfos,
                    java.lang.String locale,
                    java.util.List<java.lang.String> contentLocales,
                    java.util.Map<java.lang.String,java.lang.String> availableLocales,
                    java.lang.String title,
                    java.lang.String sitePath,
                    java.lang.String resourceType,
                    boolean performedAutocorrection,
                    boolean autoUnlock)

Constructor.

参数:

entity - the entity

configurations - the attribute configurations

externalWidgetConfigurations - the external widget configurations

complexWidgetData - the complex widget configurations

types - the types

tabInfos - the tab information

locale - the content locale

contentLocales - the content locales

availableLocales - the available locales

title - the content title

sitePath - the site path

resourceType - the resource type name

performedAutocorrection - flag indicating the current content has an invalid XML structure and was auto corrected

autoUnlock - false if the editor should not unlock resources automatically in standalone mode

CmsContentDefinition

public CmsContentDefinition(java.util.List<CmsModelResourceInfo> modelInfos,
                    java.lang.String newLink,
                    CmsUUID referenceId,
                    java.lang.String locale)

Constructor for model file informations object.

参数:

modelInfos - the model file informations

newLink - the new link

referenceId - the reference resource structure id

locale - the locale

CmsContentDefinition

protected CmsContentDefinition()

Constructor for serialization only.

方法详细资料

entityIdToUuid

public static CmsUUID entityIdToUuid(java.lang.String entityId)

Returns the UUID according to the given entity id.

参数:

entityId - the entity id

返回:

the entity id

getLocaleFromId

public static java.lang.String getLocaleFromId(java.lang.String entityId)

Extracts the locale from the entity id.

参数:

entityId - the entity id

返回:

the locale

getValueForPath

public static java.lang.String getValueForPath(com.alkacon.vie.shared.I_Entity entity,
                               java.lang.String path)

Returns the value for the given XPath expression.

参数:

entity - the entity

path - the path

返回:

the value

uuidToEntityId

public static java.lang.String uuidToEntityId(CmsUUID uuid,
                              java.lang.String locale)

Returns the entity id according to the given UUID.

参数:

uuid - the UUID

locale - the content locale

返回:

the entity id

getAvailableLocales

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

Returns the available locales.

返回:

the available locales

getComplexWidgetData

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

Gets the complex widget configurations.

返回:

the complex widget configurations

getContentLocales

public java.util.List<java.lang.String> getContentLocales()

Returns the content locales.

返回:

the content locales

getExternalWidgetConfigurations

public java.util.List<CmsExternalWidgetConfiguration> getExternalWidgetConfigurations()

Returns the external widget configurations.

返回:

the external widget configurations

getModelInfos

public java.util.List<CmsModelResourceInfo> getModelInfos()

Returns the model file informations.

返回:

the model file informations

getNewLink

public java.lang.String getNewLink()

Returns the new link.

返回:

the new link

getReferenceResourceId

public CmsUUID getReferenceResourceId()

Returns the reference resource structure id.

返回:

the reference resource structure id

getResourceType

public java.lang.String getResourceType()

Returns the resource type.

返回:

the resource type

getSitePath

public java.lang.String getSitePath()

Returns the site path.

返回:

the site path

getTitle

public java.lang.String getTitle()

Returns the title.

返回:

the title

isAutoUnlock

public boolean isAutoUnlock()

Returns the value of the acacia-unlock configuration option.

返回:

the value of the acacia-unlock configuration option

isDeleteOnCancel

public boolean isDeleteOnCancel()

Returns if the resource needs to removed on cancel.

返回:

true if the resource needs to removed on cancel

isDirectEdit

public boolean isDirectEdit()

Returns true if the direct edit flag is set, which means that the editor was opened from the classic direct edit mode.

返回:

true if the direct edit flag is set

isModelInfo

public boolean isModelInfo()

Returns if the model file informations are present, in this case no additional data is contained.

返回:

true if the definition contains the model file informations

isPerformedAutocorrection

public boolean isPerformedAutocorrection()

Returns if auto correction was performed.

返回:

true if auto correction was performed

setDeleteOnCancel

public void setDeleteOnCancel(boolean deleteOnCancel)

Sets if the resource needs to removed on cancel.

参数:

deleteOnCancel - true if the resource needs to removed on cancel

setDirectEdit

public void setDirectEdit(boolean isDirectEdit)

Sets the value of the direct edit flag.

参数:

isDirectEdit - the new value for the direct edit flag