org.opencms.xml.containerpage
Class CmsXmlDynamicFunctionHandler

java.lang.Object
  org.opencms.xml.content.CmsDefaultXmlContentHandler
      org.opencms.xml.containerpage.CmsXmlDynamicFunctionHandler

All Implemented Interfaces:

I_CmsXmlContentHandler

public class CmsXmlDynamicFunctionHandler
extends CmsDefaultXmlContentHandler

This is the XML content handler class for the "dynamic functionality" resource type.

This resource type needs special handling of formatters and element settings: They are read from each content of this type rather than from the XSD.

Field Summary

static String	FORMATTER_PATH The path of the formatter which calls the JSP.
static String	N_CONTAINER_SETTINGS The node name for the formatter settings.
static String	TYPE_FUNCTION The resource type for dynamic functions.

Fields inherited from class org.opencms.xml.content.CmsDefaultXmlContentHandler

APPINFO_APPINFO, APPINFO_ATTR_COLLAPSE, APPINFO_ATTR_CONFIGURATION, APPINFO_ATTR_DEFAULT, APPINFO_ATTR_DESCRIPTION, APPINFO_ATTR_ELEMENT, APPINFO_ATTR_ERROR, APPINFO_ATTR_INVALIDATE, APPINFO_ATTR_KEY, APPINFO_ATTR_LOCALE, APPINFO_ATTR_MAPTO, APPINFO_ATTR_MAXWIDTH, APPINFO_ATTR_MESSAGE, APPINFO_ATTR_MINWIDTH, APPINFO_ATTR_NAME, APPINFO_ATTR_NICE_NAME, APPINFO_ATTR_PREVIEW, APPINFO_ATTR_REGEX, APPINFO_ATTR_RULE_REGEX, APPINFO_ATTR_RULE_TYPE, APPINFO_ATTR_SEARCHCONTENT, APPINFO_ATTR_SELECT_INHERIT, APPINFO_ATTR_TYPE, APPINFO_ATTR_TYPE_NODE, APPINFO_ATTR_TYPE_PARENT, APPINFO_ATTR_TYPE_WARNING, APPINFO_ATTR_URI, APPINFO_ATTR_USEALL, APPINFO_ATTR_VALUE, APPINFO_ATTR_WIDGET, APPINFO_ATTR_WIDGET_CONFIG, APPINFO_ATTRIBUTE_TYPE_CSS, APPINFO_ATTRIBUTE_TYPE_JAVASCRIPT, APPINFO_BUNDLE, APPINFO_DEFAULT, APPINFO_DEFAULTS, APPINFO_FORMATTER, APPINFO_FORMATTERS, APPINFO_HEAD_INCLUDE, APPINFO_HEAD_INCLUDES, APPINFO_LAYOUT, APPINFO_LAYOUTS, APPINFO_MAPPING, APPINFO_MAPPINGS, APPINFO_MODELFOLDER, APPINFO_PREVIEW, APPINFO_PROPERTYBUNDLE, APPINFO_RELATION, APPINFO_RELATIONS, APPINFO_RESOURCE, APPINFO_RESOURCEBUNDLE, APPINFO_RESOURCEBUNDLES, APPINFO_RULE, APPINFO_SCHEMA_FILE, APPINFO_SCHEMA_FILE_TYPES, APPINFO_SCHEMA_SYSTEM_ID, APPINFO_SCHEMA_TYPES_SYSTEM_ID, APPINFO_SEARCHSETTING, APPINFO_SEARCHSETTINGS, APPINFO_SETTING, APPINFO_SETTINGS, APPINFO_TAB, APPINFO_TABS, APPINFO_VALIDATIONRULE, APPINFO_VALIDATIONRULES, APPINFO_XMLBUNDLE, ATTRIBUTE_INCLUDE_TYPE_CSS, ATTRIBUTE_INCLUDE_TYPE_JAVASCRIPT, m_configurationValues, m_cssHeadIncludes, m_defaultValues, m_elementMappings, m_elementWidgets, m_formatterConfiguration, m_formatters, m_jsHeadIncludes, m_messageBundleNames, m_modelFolder, m_previewLocation, m_relationChecks, m_relations, m_searchSettings, m_settings, m_tabs, m_titleMappings, m_validationErrorMessages, m_validationErrorRules, m_validationWarningMessages, m_validationWarningRules, MACRO_PREVIEW_TEMPFILE, MESSAGE_VALIDATION_DEFAULT_ERROR, MESSAGE_VALIDATION_DEFAULT_WARNING

Fields inherited from interface org.opencms.xml.content.I_CmsXmlContentHandler

ATTRIBUTES, MAPTO_ATTRIBUTE, MAPTO_PERMISSION, MAPTO_PROPERTY, MAPTO_PROPERTY_INDIVIDUAL, MAPTO_PROPERTY_LIST, MAPTO_PROPERTY_LIST_INDIVIDUAL, MAPTO_PROPERTY_LIST_SHARED, MAPTO_PROPERTY_SHARED, MAPTO_URLNAME

Constructor Summary

CmsXmlDynamicFunctionHandler()
Default constructor.

Method Summary

CmsFormatterConfiguration	getFormatterConfiguration(CmsObject cms, CmsResource resource) Returns the container page element formatter configuration for a given resource.
Map<String,CmsXmlContentProperty>	getSettings(CmsObject cms, CmsResource res) Returns the element settings defined for the container page formatters.

Methods inherited from class org.opencms.xml.content.CmsDefaultXmlContentHandler

addCheckRule, addConfiguration, addDefault, addDefaultCheckRules, addMapping, addSearchSetting, addValidationRule, addWidget, getConfiguration, getCSSHeadIncludes, getCSSHeadIncludes, getDefault, getJSHeadIncludes, getJSHeadIncludes, getLocaleForResource, getMappings, getMessages, getModelFolder, getPreview, getReferencePath, getRelationType, getRelationType, getTabs, getTitleMapping, getValidationMessage, getWidget, init, initDefaultValues, initFormatters, initHeadIncludes, initialize, initLayouts, initMappings, initModelFolder, initPreview, initRelations, initResourceBundle, initSearchSettings, initSettings, initTabs, initValidationRules, invalidateBrokenLinks, isInvalidateParent, isSearchable, key, prepareForUse, prepareForWrite, removeEmptyMappings, resolveMapping, resolveValidation, validateAppinfoElement, validateCategories, validateLink, validateValue, validateValue, writeCategories

Methods inherited from class java.lang.Object

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

Field Detail

FORMATTER_PATH

public static final String FORMATTER_PATH

The path of the formatter which calls the JSP.

See Also:

Constant Field Values

N_CONTAINER_SETTINGS

public static final String N_CONTAINER_SETTINGS

The node name for the formatter settings.

See Also:

Constant Field Values

TYPE_FUNCTION

public static final String TYPE_FUNCTION

The resource type for dynamic functions.

See Also:

Constant Field Values

Constructor Detail

CmsXmlDynamicFunctionHandler

public CmsXmlDynamicFunctionHandler()

Default constructor.

Method Detail

getFormatterConfiguration

public CmsFormatterConfiguration getFormatterConfiguration(CmsObject cms,
                                                           CmsResource resource)

Description copied from interface: I_CmsXmlContentHandler

Returns the container page element formatter configuration for a given resource.

Specified by:

getFormatterConfiguration in interface I_CmsXmlContentHandler

Overrides:

getFormatterConfiguration in class CmsDefaultXmlContentHandler

Parameters:

cms - the current users OpenCms context, used for selecting the right project

resource - the resource for which the formatter configuration should be retrieved

Returns:

the container page element formatter configuration for this handler

See Also:

CmsDefaultXmlContentHandler.getFormatterConfiguration(org.opencms.file.CmsObject, org.opencms.file.CmsResource)

getSettings

public Map<String,CmsXmlContentProperty> getSettings(CmsObject cms,
                                                     CmsResource res)

Description copied from interface: I_CmsXmlContentHandler

Returns the element settings defined for the container page formatters.

Specified by:

getSettings in interface I_CmsXmlContentHandler

Overrides:

getSettings in class CmsDefaultXmlContentHandler

Parameters:

cms - the current CMS context

res - the resource for which to get the setting definitions

Returns:

the element settings defined for the container page formatters

See Also:

CmsDefaultXmlContentHandler.getSettings(org.opencms.file.CmsObject, org.opencms.file.CmsResource)