Package org.opencms.ade.contenteditor

Class CmsContentTypeVisitor

java.lang.Object

org.opencms.ade.contenteditor.CmsContentTypeVisitor

public class CmsContentTypeVisitor
extends Object

Visitor to read all types and attribute configurations within a content definition.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CmsContentTypeVisitor.DisplayTypeEvaluator	Helper class to evaluate the widget display type.
protected static enum	CmsContentTypeVisitor.EvaluationRule	Widget display type evaluation rules.

Constructor Summary

Constructors

Constructor	Description
CmsContentTypeVisitor(CmsObject cms, CmsFile file, Locale locale)	Constructor.

Method Summary

Modifier and Type	Method	Description
static List<CmsTabInfo>	collectTabInfos(CmsObject cms, CmsXmlContentDefinition definition, CmsMessages messages)	Returns the tab informations for the given content definition.
protected Map<String,CmsAttributeConfiguration>	getAttributeConfigurations()	Returns the attribute configurations.
CmsObject	getCmsObject()	Gets the CMS context.
List<I_CmsWidget>	getCollectedWidgets()	Gets the list of widgets which have been processed by this visitor.
Map<String,CmsComplexWidgetData>	getComplexWidgetData()	Gets the map of complex widget configurations.
String	getLabel(I_CmsXmlSchemaType value, String defaultValue)	Returns the label for this value.
protected List<String>	getLocaleSynchronizations()	Returns the locale synchronized attribute names.
CmsDynamicCategoryFieldList	getOptionalDynamicCategoryFields()	Gets the optional dynamic category fields collected so far.
List<CmsTabInfo>	getTabInfos()	Returns the tabInfos.
protected Map<String,CmsType>	getTypes()	Returns the types of the visited content definition.
protected Collection<CmsExternalWidgetConfiguration>	getWidgetConfigurations()	Returns the external widget configurations.
boolean	hasInvisibleFields()	Returns if the visited content has invisible fields.
boolean	isDynamicallyLoaded(String attributeName)	Returns true if the value of the attribute is dynamically loaded.
boolean	isEditorCompatible(CmsXmlContentDefinition xmlContentDefinition)	Checks if the content type widgets are compatible with the new content editor.
void	visitTypes(CmsXmlContentDefinition xmlContentDefinition, Locale messageLocale)	Visits all types within the XML content definition.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsContentTypeVisitor

public CmsContentTypeVisitor(CmsObject cms,
 CmsFile file,
 Locale locale)

Constructor.

Parameters:

cms - the CMS context

file - the content file

locale - the content locale

Method Details

collectTabInfos

public static List<CmsTabInfo> collectTabInfos(CmsObject cms,
 CmsXmlContentDefinition definition,
 CmsMessages messages)

Returns the tab informations for the given content definition.

Parameters:

cms - the CMS context

definition - the content definition

messages - the localization messages

Returns:

the tab informations

getCmsObject

public CmsObject getCmsObject()

Gets the CMS context.

Returns:

the CMS context

getCollectedWidgets

public List<I_CmsWidget> getCollectedWidgets()

Gets the list of widgets which have been processed by this visitor.

Returns:

the list of widget

getComplexWidgetData

public Map<String,CmsComplexWidgetData> getComplexWidgetData()

Gets the map of complex widget configurations.

Returns:

a map from attribute names to complex widget configurations

getLabel

public String getLabel(I_CmsXmlSchemaType value,
 String defaultValue)

Returns the label for this value.

Parameters:

value - the value

defaultValue - the default value

Returns:

the label

getOptionalDynamicCategoryFields

public CmsDynamicCategoryFieldList getOptionalDynamicCategoryFields()

Gets the optional dynamic category fields collected so far.

Returns:

the optional dynamic category fields

getTabInfos

public List<CmsTabInfo> getTabInfos()

Returns the tabInfos.

Returns:

the tabInfos

hasInvisibleFields

public boolean hasInvisibleFields()

Returns if the visited content has invisible fields.

Returns:

true if the visited content has invisible fields

isDynamicallyLoaded

public boolean isDynamicallyLoaded(String attributeName)

Returns true if the value of the attribute is dynamically loaded.

Parameters:

attributeName - the attribute to check

Returns:

true if the value of the attribute is dynamically loaded.

isEditorCompatible

public boolean isEditorCompatible(CmsXmlContentDefinition xmlContentDefinition)
                           throws CmsXmlException

Checks if the content type widgets are compatible with the new content editor.

Parameters:

xmlContentDefinition - the content definition

Returns:

true if the content type widgets are compatible with the new content editor

Throws:

CmsXmlException - if something goes wrong reading the type widget

visitTypes

public void visitTypes(CmsXmlContentDefinition xmlContentDefinition,
 Locale messageLocale)

Visits all types within the XML content definition.

Parameters:

xmlContentDefinition - the content definition

messageLocale - the locale

getAttributeConfigurations

protected Map<String,CmsAttributeConfiguration> getAttributeConfigurations()

Returns the attribute configurations.

Returns:

the attribute configurations

getLocaleSynchronizations

protected List<String> getLocaleSynchronizations()

Returns the locale synchronized attribute names.

Returns:

the locale synchronized attribute names

getTypes

protected Map<String,CmsType> getTypes()

Returns the types of the visited content definition.

Returns:

the types

getWidgetConfigurations

protected Collection<CmsExternalWidgetConfiguration> getWidgetConfigurations()

Returns the external widget configurations.

Returns:

the external widget configurations