Uses of Interface
org.opencms.xml.I_CmsXmlDocument

Packages that use I_CmsXmlDocument

Package	Description
org.opencms.ade.contenteditor	Contains server side classes for the XML content editor.
org.opencms.i18n	Classes to handle internalization (i18n) and locale selection in OpenCms.
org.opencms.jsp	The implementation of the OpenCms JSP tag library, with some additional utility classes to help in JSP scriplet code and navigation building.
org.opencms.jsp.util	Utility classes to be used for JSP pages.
org.opencms.loader	Low-level functions to manage the loading of resources from the OpenCms VFS.
org.opencms.xml	Basic XML functionality and utilities used by OpenCms to maintain XML documents and content.
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.
org.opencms.xml.page	Contains functions for unstructured content storage using XML, commonly called "XML pages" in OpenCms.
org.opencms.xml.types	Contains the basic XML content type definitions, used for XML content and XML pages.

Uses of I_CmsXmlDocument in org.opencms.ade.contenteditor

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

Modifier and Type	Method	Description
static String	CmsContentService.getRdfaAttributes(I_CmsXmlDocument document, Locale contentLocale, String elementPath)	Returns the RDF annotations required for in line editing.

Uses of I_CmsXmlDocument in org.opencms.i18n

Methods in org.opencms.i18n with parameters of type I_CmsXmlDocument

Modifier and Type	Method	Description
Locale	CmsLocaleManager.getBestAvailableLocaleForXmlContent(CmsObject cms, CmsResource resource, I_CmsXmlDocument content)	Returns the best available locale present in the given XML content, or the default locale.

Uses of I_CmsXmlDocument in org.opencms.jsp

Methods in org.opencms.jsp that return I_CmsXmlDocument

Modifier and Type	Method	Description
I_CmsXmlDocument	CmsJspTagContentLoad.getXmlDocument()
I_CmsXmlDocument	CmsJspTagContentLoop.getXmlDocument()
I_CmsXmlDocument	I_CmsXmlContentContainer.getXmlDocument()	Returns the currently loaded OpenCms XML content document.

Methods in org.opencms.jsp with parameters of type I_CmsXmlDocument

Modifier and Type	Method	Description
static boolean	CmsJspTagContentCheck.contentCheckTagAction(String elementList, String prefix, boolean checkall, boolean checknone, I_CmsXmlDocument content, Locale locale)	Internal action method to check the elements from the provided XML content item.

Uses of I_CmsXmlDocument in org.opencms.jsp.util

Methods in org.opencms.jsp.util that return I_CmsXmlDocument

Modifier and Type	Method	Description
I_CmsXmlDocument	CmsJspContentAccessValueWrapper.NullValueInfo.getContent()	Returns the content.
I_CmsXmlDocument	CmsJspContentAccessBean.getRawContent()	Returns the raw XML content object that is accessed by this bean.
protected I_CmsXmlDocument	A_CmsJspCustomContextBean.toXml(Object input)	Converts the input (typically a specification of an XML file) to an XML document.

Methods in org.opencms.jsp.util with parameters of type I_CmsXmlDocument

Modifier and Type	Method	Description
static CmsJspContentAccessValueWrapper	CmsJspContentAccessValueWrapper.createWrapper(CmsObject cms, I_CmsXmlContentValue value, I_CmsXmlDocument content, String valueName, Locale locale)	Factory method to create a new XML content value wrapper.
void	CmsJspContentAccessBean.init(CmsObject cms, Locale locale, I_CmsXmlDocument content, CmsResource resource)	Initialize this instance.

Constructors in org.opencms.jsp.util with parameters of type I_CmsXmlDocument

Modifier	Constructor	Description
	CmsJspContentAccessBean(CmsObject cms, Locale locale, I_CmsXmlDocument content)	Creates a content access bean based on an XML content object.
protected	NullValueInfo(I_CmsXmlDocument content, String valueName, Locale locale)

Uses of I_CmsXmlDocument in org.opencms.loader

Methods in org.opencms.loader that return I_CmsXmlDocument

Modifier and Type	Method	Description
protected I_CmsXmlDocument	CmsSeoFileLoader.unmarshalXmlDocument(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)
protected I_CmsXmlDocument	CmsXmlContentLoader.unmarshalXmlDocument(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)
protected I_CmsXmlDocument	CmsXmlPageLoader.unmarshalXmlDocument(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)

Uses of I_CmsXmlDocument in org.opencms.xml

Classes in org.opencms.xml that implement I_CmsXmlDocument

Modifier and Type	Class	Description
class	A_CmsXmlDocument	Provides basic XML document handling functions useful when dealing with XML documents that are stored in the OpenCms VFS.

Methods in org.opencms.xml with parameters of type I_CmsXmlDocument

Modifier and Type	Method	Description
org.dom4j.Element	CmsXmlContentDefinition.addDefaultXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, Locale locale)	Adds the missing default XML according to this content definition to the given document element.
org.dom4j.Element	CmsXmlContentDefinition.createDefaultXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, Locale locale)	Generates the default XML content for this content definition, and append it to the given root element.
org.dom4j.Document	CmsXmlContentDefinition.createDocument(CmsObject cms, I_CmsXmlDocument document, Locale locale)	Generates a valid XML document according to the XML schema of this content definition.
org.dom4j.Element	CmsXmlContentDefinition.createLocale(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, Locale locale)	Generates a valid locale (language) element for the XML schema of this content definition.

Uses of I_CmsXmlDocument in org.opencms.xml.containerpage

Classes in org.opencms.xml.containerpage that implement I_CmsXmlDocument

Modifier and Type	Class	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.

Uses of I_CmsXmlDocument in org.opencms.xml.content

Classes in org.opencms.xml.content that implement I_CmsXmlDocument

Modifier and Type	Class	Description
class	CmsXmlContent	Implementation of a XML content object, used to access and manage structured content.

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

Modifier and Type	Method	Description
I_CmsXmlDocument	CmsXmlContentRootLocation.getDocument()
I_CmsXmlDocument	CmsXmlContentValueLocation.getDocument()
I_CmsXmlDocument	I_CmsXmlContentLocation.getDocument()	Returns the XML document.

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

Modifier	Constructor	Description
	CmsXmlContentRootLocation(I_CmsXmlDocument doc, Locale locale)	Creates a new root location for a given locale.

Uses of I_CmsXmlDocument in org.opencms.xml.page

Classes in org.opencms.xml.page that implement I_CmsXmlDocument

Modifier and Type	Class	Description
class	CmsXmlPage	Implementation of a page object used to access and manage xml data.

Methods in org.opencms.xml.page that return I_CmsXmlDocument

Modifier and Type	Method	Description
static I_CmsXmlDocument	CmsXmlPageFactory.unmarshal(CmsObject cms, String filename, javax.servlet.ServletRequest req)	Factory method to unmarshal (read) a XML document instance from a filename in the VFS, using the request attributes as cache.

Uses of I_CmsXmlDocument in org.opencms.xml.types

Fields in org.opencms.xml.types declared as I_CmsXmlDocument

Modifier and Type	Field	Description
protected I_CmsXmlDocument	A_CmsXmlContentValue.m_document	The XML content instance this value belongs to.

Methods in org.opencms.xml.types that return I_CmsXmlDocument

Modifier and Type	Method	Description
I_CmsXmlDocument	A_CmsXmlContentValue.getDocument()
I_CmsXmlDocument	I_CmsXmlContentValue.getDocument()	Returns the XML content instance this value belongs to.

Methods in org.opencms.xml.types with parameters of type I_CmsXmlDocument

Modifier and Type	Method	Description
I_CmsXmlContentValue	CmsXmlAccessRestrictionValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	CmsXmlBooleanValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	CmsXmlCategoryValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	CmsXmlColorValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	CmsXmlDateTimeValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	CmsXmlDisplayFormatterValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	CmsXmlDynamicCategoryValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	CmsXmlHtmlValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	CmsXmlLocaleValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	CmsXmlNestedContentDefinition.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	CmsXmlPlainTextStringValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	CmsXmlSerialDateValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	CmsXmlStringValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	CmsXmlVarLinkValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	CmsXmlVfsFileValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	CmsXmlVfsImageValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)
I_CmsXmlContentValue	I_CmsXmlSchemaType.createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)	Creates a XML content value object for this type.
org.dom4j.Element	A_CmsXmlContentValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, Locale locale)
org.dom4j.Element	CmsXmlAccessRestrictionValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, Locale locale)
org.dom4j.Element	CmsXmlCategoryValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, Locale locale)
org.dom4j.Element	CmsXmlDynamicCategoryValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, Locale locale)
org.dom4j.Element	CmsXmlHtmlValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, Locale locale)
org.dom4j.Element	CmsXmlNestedContentDefinition.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, Locale locale)
org.dom4j.Element	CmsXmlVarLinkValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, Locale locale)
org.dom4j.Element	CmsXmlVfsFileValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, Locale locale)
org.dom4j.Element	I_CmsXmlSchemaType.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, Locale locale)	Appends an XML for a new, empty node of this schema type to the given root element.

Constructors in org.opencms.xml.types with parameters of type I_CmsXmlDocument

Modifier	Constructor	Description
protected	A_CmsXmlContentValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Initializes the required members for this XML content value.
protected	A_CmsXmlValueCdataBase(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Initializes the required members for this XML content value.
protected	A_CmsXmlValueTextBase(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Initializes the required members for this XML content value.
	CmsXmlAccessRestrictionValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsCategoryValue".
	CmsXmlBooleanValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsBoolean".
	CmsXmlCategoryValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsCategoryValue".
	CmsXmlColorValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsColor".
	CmsXmlDateTimeValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsDateTime".
	CmsXmlDisplayFormatterValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsDisplayFormatter".
	CmsXmlDynamicCategoryValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsCategoryValue".
	CmsXmlHtmlValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)	Creates a new XML content value of type "OpenCmsHtml".
	CmsXmlHtmlValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsHtml".
	CmsXmlLocaleValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsLocale".
	CmsXmlNestedContentDefinition(CmsXmlContentDefinition contentDefinition, I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value for the nested content definition.
	CmsXmlPlainTextStringValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsString".
	CmsXmlSerialDateValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsSerialDate".
	CmsXmlStringValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsString".
	CmsXmlVarLinkValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsVfsFile".
	CmsXmlVfsFileValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsVfsFile".
	CmsXmlVfsImageValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsVfsImage".