Package org.opencms.xml.containerpage

Class CmsXmlDynamicFunctionHandler

java.lang.Object

org.opencms.xml.content.CmsDefaultXmlContentHandler

org.opencms.xml.containerpage.CmsXmlDynamicFunctionHandler

All Implemented Interfaces:

I_CmsXmlContentHandler, I_CmsXmlContentVisibilityHandler

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.

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.xml.content.CmsDefaultXmlContentHandler

CmsDefaultXmlContentHandler.InvalidRelationAction, CmsDefaultXmlContentHandler.VisibilityConfiguration

Nested classes/interfaces inherited from interface org.opencms.xml.content.I_CmsXmlContentHandler

I_CmsXmlContentHandler.DisplayType, I_CmsXmlContentHandler.JsonRendererSettings, I_CmsXmlContentHandler.MappingType, I_CmsXmlContentHandler.SynchronizationMode

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	N_CONTAINER_SETTINGS	The node name for the formatter settings.
static java.lang.String	TYPE_FUNCTION	The resource type for dynamic functions.

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

A_CONFIGURATION, APPINFO_APPINFO, APPINFO_ATTR_ADD_TO, APPINFO_ATTR_BOOST, APPINFO_ATTR_CLASS, APPINFO_ATTR_COLLAPSE, APPINFO_ATTR_CONFIGURATION, APPINFO_ATTR_CONTAINER_PAGE_ONLY, APPINFO_ATTR_COPY_FIELDS, APPINFO_ATTR_DEFAULT, APPINFO_ATTR_DESCRIPTION, APPINFO_ATTR_DISPLAY, APPINFO_ATTR_ELEMENT, APPINFO_ATTR_ERROR, APPINFO_ATTR_INVALIDATE, APPINFO_ATTR_KEY, APPINFO_ATTR_LOCALE, APPINFO_ATTR_MAPPING, APPINFO_ATTR_MAPTO, APPINFO_ATTR_MAXWIDTH, APPINFO_ATTR_MESSAGE, APPINFO_ATTR_MINWIDTH, APPINFO_ATTR_NAME, APPINFO_ATTR_NICE_NAME, APPINFO_ATTR_PARAMS, APPINFO_ATTR_PREVIEW, APPINFO_ATTR_REGEX, APPINFO_ATTR_RESOLVE_MACROS, APPINFO_ATTR_RULE_REGEX, APPINFO_ATTR_RULE_TYPE, APPINFO_ATTR_SCOPE, APPINFO_ATTR_SEARCHCONTENT, APPINFO_ATTR_SELECT_INHERIT, APPINFO_ATTR_SOURCE_FIELD, APPINFO_ATTR_TARGET_FIELD, 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_EDIT_HANDLER, APPINFO_EDITOR_CHANGE_HANDLER, APPINFO_EDITOR_CHANGE_HANDLERS, APPINFO_FORBIDDEN_CONTEXTS, APPINFO_FORMATTER, APPINFO_FORMATTERS, APPINFO_GEOMAPPING, APPINFO_HEAD_INCLUDE, APPINFO_HEAD_INCLUDES, APPINFO_LAYOUT, APPINFO_LAYOUTS, APPINFO_MAPPING, APPINFO_MAPPINGS, APPINFO_MESSAGEKEYHANDLER, APPINFO_MODELFOLDER, APPINFO_NESTED_FORMATTER, APPINFO_NESTED_FORMATTERS, APPINFO_PARAM, APPINFO_PARAMETERS, APPINFO_PREVIEW, APPINFO_PROPERTYBUNDLE, APPINFO_RELATION, APPINFO_RELATIONS, APPINFO_RESOURCE, APPINFO_RESOURCEBUNDLE, APPINFO_RESOURCEBUNDLES, APPINFO_REVERSE_MAPPING_ENABLED, 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_SOLR_FIELD, APPINFO_SYNCHRONIZATION, APPINFO_SYNCHRONIZATIONS, APPINFO_TAB, APPINFO_TABS, APPINFO_TEMPLATE, APPINFO_TEMPLATES, APPINFO_VALIDATIONRULE, APPINFO_VALIDATIONRULES, APPINFO_VALUE_ADD_TO_CONTENT, APPINFO_VALUE_ADD_TO_PAGE, APPINFO_VERSION_TRANSFORMATION, APPINFO_VISIBILITIES, APPINFO_VISIBILITY, APPINFO_XMLBUNDLE, ATTR_ENABLED, ATTR_ENABLED_BY_DEFAULT, ATTR_USE_ACACIA, ATTRIBUTE_INCLUDE_TYPE_CSS, ATTRIBUTE_INCLUDE_TYPE_JAVASCRIPT, GEOMAPPING_FIELD, m_allowedTemplates, m_combinedSynchronizations, m_configurationValues, m_cssHeadIncludes, m_defaultValues, m_elementMappings, m_formatterConfiguration, m_formatters, m_geomappingEntries, m_invalidRelationActions, m_jsHeadIncludes, m_messageBundleNames, m_modelFolder, m_previewLocation, m_primaryGeomappingField, m_relationChecks, m_relations, m_searchFields, m_searchFieldsPage, m_searchSettings, m_searchTemplateGroup, m_settings, m_synchronizations, m_tabs, m_titleMappings, m_useAcacia, m_validationErrorMessages, m_validationErrorRules, m_validationWarningMessages, m_validationWarningRules, m_versionTransformation, MACRO_PREVIEW_TEMPFILE, MESSAGE_VALIDATION_DEFAULT_ERROR, MESSAGE_VALIDATION_DEFAULT_WARNING, N_CHANGEHANDLER, N_SETTING

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

ATTRIBUTE_DATEEXPIRED, ATTRIBUTE_DATERELEASED, 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

Constructors

Constructor	Description
CmsXmlDynamicFunctionHandler()	Default constructor.

Method Summary

Modifier and Type	Method	Description
CmsFormatterConfiguration	getFormatterConfiguration(CmsObject cms, CmsResource resource)	Returns the container page element formatter configuration for a given resource.
java.util.Map<java.lang.String,CmsXmlContentProperty>	getSettings(CmsObject cms, CmsResource res)	Returns the element settings defined for the container page formatters.
boolean	hasModifiableFormatters()	Returns true if the contents for this content handler have schema-based formatters which can be disabled or enabled.

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

addCheckRule, addConfiguration, addDefault, addDefaultCheckRules, addDisplayType, addGeoMappingField, addMapping, addNestedFormatter, addSearchField, addSearchField, addSearchSetting, addSimpleSearchSetting, addValidationRule, addWidget, applyReverseAvailabilityMapping, canUseReverseAvailabilityMapping, createRootCms, createVisibilityConfiguration, getAllowedTemplates, getAttributeMapping, getChangeHandlerConfigs, getComplexWidget, getConfiguration, getConfiguration, getConfiguredDisplayType, getCSSHeadIncludes, getCSSHeadIncludes, getDefault, getDefault, getDefaultComplexWidget, getDefaultComplexWidgetClass, getDefaultComplexWidgetConfiguration, getDisplayType, getEditHandler, getEditorChangeHandlers, getFieldHelp, getFieldLabels, getGeoMappingConfiguration, getInvalidRelationAction, getJSHeadIncludes, getJSHeadIncludes, getJsonRendererSettings, getLocalesForResource, getMappings, getMappings, getMessageKeyHandler, getMessages, getModelFolder, getNestedEditorChangeHandlers, getNestedFormatters, getParameter, getParameters, getPreview, getReferencePath, getRelationType, getRelationType, getRelationType, getSearchContentType, getSearchFields, getSearchFieldsForPage, getSearchSettings, getSynchronizations, getTabs, getTitleMapping, getValidationError, getValidationMessage, getValidationWarning, getValidationWarningOrErrorMessage, getVersionTransformation, getWidget, getWidget, hasNestedFormatters, hasSynchronizedElements, hasVisibilityHandlers, init, initDefaultValues, initDefaultWidget, initEditHandler, initEditorChangeHandlers, initField, initFields, initFormatters, initHeadIncludes, initialize, initJsonRenderer, initLayouts, initMappings, initModelFolder, initNestedFormatters, initParameters, initPreview, initRelations, initResourceBundle, initSearchSettings, initSettings, initSynchronizations, initTabs, initTemplates, initValidationRules, initVisibilities, invalidateBrokenLinks, isAcaciaEditorDisabled, isContainerPageOnly, isInvalidateParent, isValueVisible, isVisible, key, parseSearchMappingTypes, prepareForUse, prepareForWrite, removeEmptyMappings, resolveDefaultMappings, 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

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

isSearchable

Field Detail

N_CONTAINER_SETTINGS

public static final java.lang.String N_CONTAINER_SETTINGS

The node name for the formatter settings.

See Also:

Constant Field Values

TYPE_FUNCTION

public static final java.lang.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 java.util.Map<java.lang.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)

hasModifiableFormatters

public boolean hasModifiableFormatters()

Description copied from interface: I_CmsXmlContentHandler

Returns true if the contents for this content handler have schema-based formatters which can be disabled or enabled.

Specified by:

hasModifiableFormatters in interface I_CmsXmlContentHandler

Overrides:

hasModifiableFormatters in class CmsDefaultXmlContentHandler

Returns:

true if the contents for this content handler have schema-based formatters which can be disabled or enabled

See Also:

CmsDefaultXmlContentHandler.hasModifiableFormatters()