Package org.opencms.acacia.shared

Class CmsContentDefinition

java.lang.Object

org.opencms.acacia.shared.CmsContentDefinition

All Implemented Interfaces:

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

Direct Known Subclasses:

CmsContentDefinition

public class CmsContentDefinition
extends Object
implements com.google.gwt.user.client.rpc.IsSerializable

Contains all information defining a content entity type.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FUNCTION_RENDER_FORM	The member name for the form rendering function.
static final String	FUNCTION_RENDER_INLINE	The member name for the inline rendering function.
static final String	NATIVE_RENDERER	The name of the native renderer.
static final String	PARAM_INIT_CALL	The parameter name for the initialization function.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CmsContentDefinition()	Constructor.
	CmsContentDefinition(String entityId, Map<String,CmsEntity> entities, Map<String,CmsAttributeConfiguration> configurations, Map<String,CmsType> types, List<CmsTabInfo> tabInfos, boolean groupOptionalFields, String locale)	Constructor.

Method Summary

Modifier and Type	Method	Description
static int	extractIndex(String attributeName)	Extracts the attribute index from the given attribute name where the index is appended to the name like 'attributename[1]'.
Map<String,CmsAttributeConfiguration>	getConfigurations()	Returns the attribute configurations.
Map<String,CmsEntity>	getEntities()	Returns the locale specific entities of the content.
CmsEntity	getEntity()	Returns the entity.
String	getEntityId()	Returns the entity id.
String	getEntityTypeName()	Returns the entity type name.
String	getLocale()	Returns the locale.
List<CmsTabInfo>	getTabInfos()	Returns the tab information beans.
Map<String,CmsType>	getTypes()	Returns the types.
static boolean	hasIndex(String pathComponent)	Checks if the given XPATH component has an index.
boolean	isGroupOptionalFields()	Returns if optional fields should be grouped together.
static String	removeIndex(String attributeName)	Removes an attribute index suffix from the given attribute name.

Methods inherited from class java.lang.Object

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

Field Details

NATIVE_RENDERER

public static final String NATIVE_RENDERER

The name of the native renderer.

See Also:

• Constant Field Values

FUNCTION_RENDER_FORM

public static final String FUNCTION_RENDER_FORM

The member name for the form rendering function.

See Also:

• Constant Field Values

FUNCTION_RENDER_INLINE

public static final String FUNCTION_RENDER_INLINE

The member name for the inline rendering function.

See Also:

• Constant Field Values

PARAM_INIT_CALL

public static final String PARAM_INIT_CALL

The parameter name for the initialization function.

See Also:

• Constant Field Values

Constructor Details

CmsContentDefinition

public CmsContentDefinition(String entityId,
 Map<String,CmsEntity> entities,
 Map<String,CmsAttributeConfiguration> configurations,
 Map<String,CmsType> types,
 List<CmsTabInfo> tabInfos,
 boolean groupOptionalFields,
 String locale)

Constructor.

Parameters:

entityId - the entity id

entities - the locale specific entities

configurations - the attribute configurations

types - the types

tabInfos - the tab information beans

groupOptionalFields - true if optional fields should be grouped together

locale - the content locale

CmsContentDefinition

protected CmsContentDefinition()

Constructor. Used for serialization only.

Method Details

extractIndex

public static int extractIndex(String attributeName)

Extracts the attribute index from the given attribute name where the index is appended to the name like 'attributename[1]'.

Parameters:

attributeName - the attribute name

Returns:

the extracted index

hasIndex

public static boolean hasIndex(String pathComponent)

Checks if the given XPATH component has an index.

Parameters:

pathComponent - the path component

Returns:

true if the argument contains an index

removeIndex

public static String removeIndex(String attributeName)

Removes an attribute index suffix from the given attribute name.

Parameters:

attributeName - the attribute name

Returns:

the attribute name

getConfigurations

public Map<String,CmsAttributeConfiguration> getConfigurations()

Returns the attribute configurations.

Returns:

the attribute configurations

getEntities

public Map<String,CmsEntity> getEntities()

Returns the locale specific entities of the content.

Returns:

the locale specific entities of the content

getEntity

public CmsEntity getEntity()

Returns the entity.

Returns:

the entity

getEntityId

public String getEntityId()

Returns the entity id.

Returns:

the entity id

getEntityTypeName

public String getEntityTypeName()

Returns the entity type name.

Returns:

the entity type name

getLocale

public String getLocale()

Returns the locale.

Returns:

the locale

getTabInfos

public List<CmsTabInfo> getTabInfos()

Returns the tab information beans.

Returns:

the tab information beans

getTypes

public Map<String,CmsType> getTypes()

Returns the types.

Returns:

the types

isGroupOptionalFields

public boolean isGroupOptionalFields()

Returns if optional fields should be grouped together.

Returns:

true if optional fields should be grouped together