org.opencms.ade.contenteditor
Class CmsContentTypeVisitor

java.lang.Object
  org.opencms.ade.contenteditor.CmsContentTypeVisitor

public class CmsContentTypeVisitor
extends java.lang.Object

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

Constructor Summary

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

Method Summary

protected java.util.Map<java.lang.String,com.alkacon.acacia.shared.AttributeConfiguration>	getAttributeConfigurations() Returns the attribute configurations.
CmsObject	getCmsObject() Gets the CMS context.
java.util.List<I_CmsWidget>	getCollectedWidgets() Gets the list of widgets which have been processed by this visitor.
java.util.List<com.alkacon.acacia.shared.TabInfo>	getTabInfos() Returns the tabInfos.
protected java.util.Map<java.lang.String,com.alkacon.vie.shared.I_Type>	getTypes() Returns the types of the visited content definition.
protected java.util.Collection<CmsExternalWidgetConfiguration>	getWidgetConfigurations() Returns the external widget configurations.
void	visitTypes(CmsXmlContentDefinition xmlContentDefinition, java.util.Locale messageLocale) Visits all types within the XML content definition.
void	visitTypes(CmsXmlContentDefinition xmlContentDefinition, java.util.Locale messageLocale, boolean checkWidgetsOnly) 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 Detail

CmsContentTypeVisitor

public CmsContentTypeVisitor(CmsObject cms,
                             CmsFile file,
                             java.util.Locale locale)

Constructor.

Parameters:

cms - the CMS context

file - the content file

locale - the content locale

Method Detail

getCmsObject

public CmsObject getCmsObject()

Gets the CMS context.

Returns:

the CMS context

getCollectedWidgets

public java.util.List<I_CmsWidget> getCollectedWidgets()

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

Returns:

the list of widget

getTabInfos

public java.util.List<com.alkacon.acacia.shared.TabInfo> getTabInfos()

Returns the tabInfos.

Returns:

the tabInfos

visitTypes

public void visitTypes(CmsXmlContentDefinition xmlContentDefinition,
                       java.util.Locale messageLocale)

Visits all types within the XML content definition.

Parameters:

xmlContentDefinition - the content definition

messageLocale - the locale

visitTypes

public void visitTypes(CmsXmlContentDefinition xmlContentDefinition,
                       java.util.Locale messageLocale,
                       boolean checkWidgetsOnly)

Visits all types within the XML content definition.

Parameters:

xmlContentDefinition - the content definition

messageLocale - the locale

checkWidgetsOnly - if true the availability of new editor widgets will be checked only, in this case widget configuration will NOT be read

getAttributeConfigurations

protected java.util.Map<java.lang.String,com.alkacon.acacia.shared.AttributeConfiguration> getAttributeConfigurations()

Returns the attribute configurations.

Returns:

the attribute configurations

getTypes

protected java.util.Map<java.lang.String,com.alkacon.vie.shared.I_Type> getTypes()

Returns the types of the visited content definition.

Returns:

the types

getWidgetConfigurations

protected java.util.Collection<CmsExternalWidgetConfiguration> getWidgetConfigurations()

Returns the external widget configurations.

Returns:

the external widget configurations