Uses of Class
org.opencms.xml.content.CmsXmlContent

Packages that use CmsXmlContent

Package	Description
org.opencms.ade.configuration	Contains the ade configuration classes.
org.opencms.ade.configuration.formatters	Classes for handling formatter configurations
org.opencms.ade.containerpage	Contains the container page editor service classes.
org.opencms.ade.containerpage.inherited	Contains classes used for reading and caching inheritance groups.
org.opencms.ade.contenteditor	Contains server side classes for the XML content editor.
org.opencms.file.types	The implementations of the core resource types for the VFS are located here.
org.opencms.jsp.decorator	HTML postprocessor, used to tag single words or phrases in the HTML output.
org.opencms.jsp.search.config.parser	API classes for the configuration parsers of the search form support provided for server-side Solr search.
org.opencms.notification	Contains classes for the automatical notification of outdated, expiring or released content.
org.opencms.ugc
org.opencms.ui.apps.resourcetypes
org.opencms.widgets	Contains the widget implementations, these are GUI elements used in editors and dialogs of the OpenCms workplace.
org.opencms.workplace	The base classes for the OpenCms Workplace (standard dialog, tab dialog, report based dialog) and the Workplace configuration classes are located here.
org.opencms.workplace.editors	Base classes for the editors (WYSIWYG, plain text, XML content) used in the OpenCms Workplace.
org.opencms.xml.containerpage	Contains functions for the ADE main pages, commonly called "Container Pages" in OpenCms.
org.opencms.xml.content	Contains functions for structured content storage using XML, commonly called "XML content" in OpenCms.

Uses of CmsXmlContent in org.opencms.ade.configuration

Methods in org.opencms.ade.configuration with parameters of type CmsXmlContent

Modifier and Type	Method and Description
CmsADEConfigDataInternal	CmsConfigurationReader.parseConfiguration(java.lang.String basePath, CmsXmlContent content) Parses a configuration XML content and creates a configuration object from it.

Uses of CmsXmlContent in org.opencms.ade.configuration.formatters

Methods in org.opencms.ade.configuration.formatters with parameters of type CmsXmlContent

Modifier and Type	Method and Description
I_CmsFormatterBean	CmsFormatterBeanParser.parse(CmsXmlContent content, java.lang.String location, java.lang.String id) Reads the formatter bean from the given XML content.

Uses of CmsXmlContent in org.opencms.ade.containerpage

Method parameters in org.opencms.ade.containerpage with type arguments of type CmsXmlContent

Modifier and Type	Method and Description
static java.util.function.Function<java.lang.String,java.lang.String>	CmsElementUtil.createStringTemplateSource(I_CmsFormatterBean formatter, com.google.common.base.Supplier<CmsXmlContent> contentSupplier) Helper method to create a string template source for a given formatter and content.

Uses of CmsXmlContent in org.opencms.ade.containerpage.inherited

Methods in org.opencms.ade.containerpage.inherited that return CmsXmlContent

Modifier and Type	Method and Description
protected CmsXmlContent	CmsContainerConfigurationWriter.saveInContentObject(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.lang.String name, CmsContainerConfiguration configuration) Saves a single container configuration in an XML content object, but doesn't write it to the VFS.

Methods in org.opencms.ade.containerpage.inherited with parameters of type CmsXmlContent

Modifier and Type	Method and Description
protected void	CmsInheritanceReferenceParser.parse(CmsXmlContent content) Parses the given XML content.
protected void	CmsContainerConfigurationWriter.removeExistingEntry(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.lang.String name) Removes an existing inheritance container entry with a given name from the configuration file.
protected CmsXmlContent	CmsContainerConfigurationWriter.saveInContentObject(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.lang.String name, CmsContainerConfiguration configuration) Saves a single container configuration in an XML content object, but doesn't write it to the VFS.

Uses of CmsXmlContent in org.opencms.ade.contenteditor

Methods in org.opencms.ade.contenteditor that return CmsXmlContent

Modifier and Type	Method and Description
CmsXmlContent	CmsDelayedDefaultChangeHandler.handleChange(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.util.Collection<java.lang.String> changedPaths)
CmsXmlContent	CmsEditorChangeHandlerProperty.handleChange(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.util.Collection<java.lang.String> changedPaths)
CmsXmlContent	CmsEditorChangeHandlerFormatterSelection.handleChange(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.util.Collection<java.lang.String> changedPaths) Adjusts the added/removed formatters if "Remove all formatters" is checked/unchecked.

Methods in org.opencms.ade.contenteditor with parameters of type CmsXmlContent

Modifier and Type	Method and Description
CmsXmlContent	CmsDelayedDefaultChangeHandler.handleChange(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.util.Collection<java.lang.String> changedPaths)
CmsXmlContent	CmsEditorChangeHandlerProperty.handleChange(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.util.Collection<java.lang.String> changedPaths)
CmsXmlContent	CmsEditorChangeHandlerFormatterSelection.handleChange(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.util.Collection<java.lang.String> changedPaths) Adjusts the added/removed formatters if "Remove all formatters" is checked/unchecked.
protected CmsEntity	CmsContentService.readEntity(CmsXmlContent content, org.dom4j.Element element, java.util.Locale locale, java.lang.String entityId, java.lang.String parentPath, java.lang.String typeName, CmsContentTypeVisitor visitor, boolean includeInvisible, CmsEntity editedLocalEntity) Parses the element into an entity.
protected void	CmsContentService.synchronizeLocaleIndependentFields(CmsFile file, CmsXmlContent content, java.util.Collection<java.lang.String> skipPaths, java.util.Collection<CmsEntity> entities, java.util.Locale lastEdited) Synchronizes the locale independent fields.

Uses of CmsXmlContent in org.opencms.file.types

Methods in org.opencms.file.types with parameters of type CmsXmlContent

Modifier and Type	Method and Description
protected CmsLink	CmsResourceTypeXmlContent.getXsdLink(CmsObject cms, CmsXmlContent xmlContent) Creates a new link object for the schema definition.

Uses of CmsXmlContent in org.opencms.jsp.decorator

Methods in org.opencms.jsp.decorator with parameters of type CmsXmlContent

Modifier and Type	Method and Description
CmsDecorationDefintion	I_CmsDecoratorConfiguration.getDecorationDefinition(CmsXmlContent configuration, int i) Builds a CmsDecorationDefintion from a given configuration file.
CmsDecorationDefintion	CmsDecoratorConfiguration.getDecorationDefinition(CmsXmlContent configuration, int i) Builds a CmsDecorationDefintion from a given configuration file.

Uses of CmsXmlContent in org.opencms.jsp.search.config.parser

Constructors in org.opencms.jsp.search.config.parser with parameters of type CmsXmlContent

Constructor and Description
CmsXMLSearchConfigurationParser(CmsXmlContent xml, java.util.Locale locale) Constructor taking the XML content that should be read and the locale in which it should be read.

Uses of CmsXmlContent in org.opencms.notification

Fields in org.opencms.notification declared as CmsXmlContent

Modifier and Type	Field and Description
protected CmsXmlContent	A_CmsNotification.m_mailContent The xml-content to read subject, header and footer of the notification.

Uses of CmsXmlContent in org.opencms.ugc

Methods in org.opencms.ugc that return CmsXmlContent

Modifier and Type	Method and Description
protected CmsXmlContent	CmsUgcSession.addContentValues(CmsFile file, java.util.Map<java.lang.String,java.lang.String> contentValues) Adds the given values to the content document.

Methods in org.opencms.ugc with parameters of type CmsXmlContent

Modifier and Type	Method and Description
protected void	CmsUgcSession.addContentValue(CmsXmlContent content, java.util.Locale locale, java.lang.String path, java.lang.String value) Adds the given value to the content document.
protected void	CmsUgcSession.addContentValues(CmsXmlContent content, java.util.Locale locale, java.util.Map<java.lang.String,java.lang.String> contentValues) Adds the given values to the content document.
protected void	CmsUgcSession.deleteContentValue(CmsXmlContent content, java.util.Locale locale, java.lang.String path) Deletes the given value path from the content document.
protected java.util.Map<java.lang.String,java.lang.String>	CmsUgcSession.getContentValues(CmsXmlContent content, java.util.Locale locale) Returns the content values of the requested locale.

Uses of CmsXmlContent in org.opencms.ui.apps.resourcetypes

Methods in org.opencms.ui.apps.resourcetypes with parameters of type CmsXmlContent

Modifier and Type	Method and Description
protected void	CmsNewResourceTypeDialog.createParentXmlElements(CmsXmlContent xmlContent, java.lang.String xmlPath, java.util.Locale l) Creates the parents of nested XML elements if necessary.

Uses of CmsXmlContent in org.opencms.widgets

Methods in org.opencms.widgets with parameters of type CmsXmlContent

Modifier and Type	Method and Description
protected abstract java.util.Set<java.lang.String>	A_CmsFormatterWidget.getSelectedInFile(CmsConfigurationReader reader, CmsXmlContent content) Gets the values which have already been selected in the edited resource on the VFS.
protected java.util.Set<java.lang.String>	CmsAddFormatterWidget.getSelectedInFile(CmsConfigurationReader reader, CmsXmlContent content)
protected java.util.Set<java.lang.String>	CmsRemoveFormatterWidget.getSelectedInFile(CmsConfigurationReader reader, CmsXmlContent content)

Uses of CmsXmlContent in org.opencms.workplace

Methods in org.opencms.workplace that return CmsXmlContent

Modifier and Type	Method and Description
protected CmsXmlContent	CmsLoginUserAgreement.getConfigurationContent() Returns the user agreement configuration content.

Uses of CmsXmlContent in org.opencms.workplace.editors

Methods in org.opencms.workplace.editors with parameters of type CmsXmlContent

Modifier and Type	Method and Description
protected void	CmsDialogCopyLanguage.transferContents(CmsXmlContent content, java.util.Locale sourceLocale, java.util.List<java.util.Locale> destLocales) Copies the contents from a source locale to a number of destination locales by overwriting them.

Uses of CmsXmlContent in org.opencms.xml.containerpage

Subclasses of CmsXmlContent in org.opencms.xml.containerpage

Modifier and Type	Class and Description
class	CmsXmlContainerPage Implementation of a object used to access and manage the xml data of a container page.
class	CmsXmlGroupContainer Implementation of a object used to access and manage the xml data of a group container.

Methods in org.opencms.xml.containerpage that return CmsXmlContent

Modifier and Type	Method and Description
CmsXmlContent	CmsADESessionCache.getCacheXmlContent(CmsUUID structureId) Returns the cached XML content document.

Methods in org.opencms.xml.containerpage with parameters of type CmsXmlContent

Modifier and Type	Method and Description
protected java.util.Locale	CmsDynamicFunctionParser.getLocaleToUse(CmsObject cms, CmsXmlContent xmlContent) Gets the locale to use for parsing the dynamic function.
CmsDynamicFunctionBean	CmsDynamicFunctionParser.parseFunctionBean(CmsObject cms, CmsXmlContent content) Parses a dynamic function bean from an in-memory XML content object.
CmsFile	CmsHtmlRedirectHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file)
void	CmsADESessionCache.setCacheXmlContent(CmsUUID structureId, CmsXmlContent xmlContent) Caches the given XML content document.
protected void	CmsXmlContainerPageHandler.validateNames(CmsObject cms, I_CmsXmlContentValue value, CmsXmlContent content) Validates container names, so that they are unique in the page.

Uses of CmsXmlContent in org.opencms.xml.content

Methods in org.opencms.xml.content that return CmsXmlContent

Modifier and Type	Method and Description
CmsXmlContent	CmsXmlContent.clone()
static CmsXmlContent	CmsXmlContentFactory.createDocument(CmsObject cms, java.util.Locale locale, CmsResourceTypeXmlContent resourceType) Creates a new XML content based on a resource type.
static CmsXmlContent	CmsXmlContentFactory.createDocument(CmsObject cms, java.util.Locale locale, java.lang.String modelUri) Create a new instance of an XML content based on the given default content, hat will have all language nodes of the default content and ensures the presence of the given locale.
static CmsXmlContent	CmsXmlContentFactory.createDocument(CmsObject cms, java.util.Locale locale, java.lang.String encoding, CmsXmlContentDefinition contentDefinition) Create a new instance of an XML content based on the given content definiton, that will have one language node for the given locale all initialized with default values.
CmsXmlContent	I_CmsXmlContentEditorChangeHandler.handleChange(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.util.Collection<java.lang.String> changedPaths) Handles the content change.
CmsXmlContent	CmsDefaultXmlContentHandler.prepareForUse(CmsObject cms, CmsXmlContent content)
CmsXmlContent	I_CmsXmlContentHandler.prepareForUse(CmsObject cms, CmsXmlContent content) Prepares the given XML content to be used after it was read from the OpenCms VFS.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, byte[] xmlData, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Factory method to unmarshal (generate) a XML content instance from a byte array that contains XML data.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, CmsFile file) Factory method to unmarshal (read) a XML content instance from a OpenCms VFS file that contains XML data.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding) Factory method to unmarshal (read) a XML content instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req) Factory method to unmarshal (read) a XML content instance from a resource, using the request attributes as cache.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, org.dom4j.Document document, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Factory method to unmarshal (generate) a XML content instance from a XML document.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, java.lang.String xmlData, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Factory method to unmarshal (generate) a XML content instance from a String that contains XML data.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(java.lang.String xmlData, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Factory method to unmarshal (generate) a XML content instance from a String that contains XML data.

Methods in org.opencms.xml.content with parameters of type CmsXmlContent

Modifier and Type	Method and Description
static CmsMacroResolver	CmsXmlContentPropertyHelper.getMacroResolverForProperties(CmsObject cms, I_CmsXmlContentHandler contentHandler, CmsXmlContent content, java.util.function.Function<java.lang.String,java.lang.String> stringtemplateSource, CmsResource containerPage) Creates and configures a new macro resolver for resolving macros which occur in property definitions.
java.lang.String	CmsDefaultXmlContentHandler.getPreview(CmsObject cms, CmsXmlContent content, java.lang.String resourcename)
java.lang.String	I_CmsXmlContentHandler.getPreview(CmsObject cms, CmsXmlContent content, java.lang.String resourcename) Returns the preview URI for the given XML content value object to be displayed in the editor.
java.lang.String	CmsDefaultXmlContentHandler.getTitleMapping(CmsObject cms, CmsXmlContent document, java.util.Locale locale)
java.lang.String	I_CmsXmlContentHandler.getTitleMapping(CmsObject cms, CmsXmlContent document, java.util.Locale locale) Returns the "Title" mapping set for the given XML content document in the given Locale.
CmsXmlContent	I_CmsXmlContentEditorChangeHandler.handleChange(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.util.Collection<java.lang.String> changedPaths) Handles the content change.
void	CmsDefaultXmlContentHandler.invalidateBrokenLinks(CmsObject cms, CmsXmlContent document)
void	I_CmsXmlContentHandler.invalidateBrokenLinks(CmsObject cms, CmsXmlContent document) Performs a check of the given XML document.
CmsXmlContent	CmsDefaultXmlContentHandler.prepareForUse(CmsObject cms, CmsXmlContent content)
CmsXmlContent	I_CmsXmlContentHandler.prepareForUse(CmsObject cms, CmsXmlContent content) Prepares the given XML content to be used after it was read from the OpenCms VFS.
CmsFile	CmsDefaultXmlContentHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file)
CmsFile	I_CmsXmlContentHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file) Prepares the given XML content to be written to the OpenCms VFS.
static java.util.Map<java.lang.String,java.lang.String>	CmsXmlContentPropertyHelper.readProperties(CmsXmlContent xmlContent, java.util.Locale locale, org.dom4j.Element element, java.lang.String elemPath, CmsXmlContentDefinition elemDef) Reads the properties from property-enabled xml content values.
protected void	CmsDefaultXmlContentHandler.removeEmptyMappings(CmsObject cms, CmsFile file, CmsXmlContent content) Removes property values on resources for non-existing, optional elements.
protected void	CmsDefaultXmlContentHandler.resolveDefaultMappings(CmsObject cms, CmsFile file, CmsXmlContent content) Resolves those mappings for which no content value exists and useDefault is set to true.
void	CmsDefaultXmlContentHandler.resolveMapping(CmsObject cms, CmsXmlContent content, I_CmsXmlContentValue value)
void	I_CmsXmlContentHandler.resolveMapping(CmsObject cms, CmsXmlContent content, I_CmsXmlContentValue value) Resolves the value mappings of the given XML content value, according to the rules of this XML content handler.
protected CmsFile	CmsDefaultXmlContentHandler.writeCategories(CmsObject cms, CmsFile file, CmsXmlContent content) Writes the categories if a category widget is present.

Method parameters in org.opencms.xml.content with type arguments of type CmsXmlContent

Modifier and Type

Method and Description

static java.util.Map<java.lang.String,CmsXmlContentProperty>

CmsXmlContentPropertyHelper.resolveMacrosForPropertyInfo(CmsObject cms, CmsResource page, CmsResource resource, com.google.common.base.Supplier<CmsXmlContent> contentGetter, java.util.function.Function<java.lang.String,java.lang.String> stringtemplateSource, java.util.Map<java.lang.String,CmsXmlContentProperty> propertiesConf) Resolves macros in the given property information for the given resource (type) AND the current user.

Constructors in org.opencms.xml.content with parameters of type CmsXmlContent

Constructor and Description
CmsXmlContentValueSequence(java.lang.String path, java.util.Locale locale, CmsXmlContent content) Generates a new content sequence element from the given type, content and content definition.