接口 org.opencms.xml.I_CmsXmlDocument
的使用

使用I_CmsXmlDocument的程序包

程序包	说明
org.opencms.ade.contenteditor
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.

org.opencms.ade.contenteditor中I_CmsXmlDocument的使用

参数类型为I_CmsXmlDocument的org.opencms.ade.contenteditor中的方法

限定符和类型	方法和说明
static java.lang.String	CmsContentService.getRdfaAttributes(I_CmsXmlDocument document, java.util.Locale contentLocale, java.lang.String childName) Returns the RDF annotations required for in line editing.

org.opencms.jsp中I_CmsXmlDocument的使用

返回I_CmsXmlDocument的org.opencms.jsp中的方法

限定符和类型	方法和说明
I_CmsXmlDocument	I_CmsXmlContentContainer.getXmlDocument() Returns the currently loaded OpenCms XML content document.
I_CmsXmlDocument	CmsJspTagContentLoop.getXmlDocument()
I_CmsXmlDocument	CmsJspTagContentLoad.getXmlDocument()

参数类型为I_CmsXmlDocument的org.opencms.jsp中的方法

限定符和类型	方法和说明
static boolean	CmsJspTagContentCheck.contentCheckTagAction(java.lang.String elementList, java.lang.String prefix, boolean checkall, boolean checknone, I_CmsXmlDocument content, java.util.Locale locale) Internal action method to check the elements from the provided XML content item.

org.opencms.jsp.util中I_CmsXmlDocument的使用

返回I_CmsXmlDocument的org.opencms.jsp.util中的方法

限定符和类型	方法和说明
I_CmsXmlDocument	CmsJspContentAccessBean.getRawContent() Returns the raw XML content object that is accessed by this bean.

参数类型为I_CmsXmlDocument的org.opencms.jsp.util中的方法

限定符和类型	方法和说明
void	CmsJspContentAccessBean.init(CmsObject cms, java.util.Locale locale, I_CmsXmlDocument content, CmsResource resource) Initialize this instance.

参数类型为I_CmsXmlDocument的org.opencms.jsp.util中的构造器

构造器和说明
CmsJspContentAccessBean(CmsObject cms, java.util.Locale locale, I_CmsXmlDocument content) Creates a content access bean based on an XML content object.

org.opencms.loader中I_CmsXmlDocument的使用

返回I_CmsXmlDocument的org.opencms.loader中的方法

限定符和类型	方法和说明
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)

org.opencms.xml中I_CmsXmlDocument的使用

实现I_CmsXmlDocument的org.opencms.xml中的类

限定符和类型	类和说明
class	A_CmsXmlDocument Provides basic XML document handling functions useful when dealing with XML documents that are stored in the OpenCms VFS.

参数类型为I_CmsXmlDocument的org.opencms.xml中的方法

限定符和类型	方法和说明
org.dom4j.Element	CmsXmlContentDefinition.addDefaultXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.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, java.util.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, java.util.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, java.util.Locale locale) Generates a valid locale (language) element for the XML schema of this content definition.

org.opencms.xml.containerpage中I_CmsXmlDocument的使用

实现I_CmsXmlDocument的org.opencms.xml.containerpage中的类

限定符和类型	类和说明
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.

org.opencms.xml.content中I_CmsXmlDocument的使用

实现I_CmsXmlDocument的org.opencms.xml.content中的类

限定符和类型	类和说明
class	CmsXmlContent Implementation of a XML content object, used to access and manage structured content.

返回I_CmsXmlDocument的org.opencms.xml.content中的方法

限定符和类型	方法和说明
I_CmsXmlDocument	CmsXmlContentValueLocation.getDocument()
I_CmsXmlDocument	I_CmsXmlContentLocation.getDocument() Returns the XML document.
I_CmsXmlDocument	CmsXmlContentRootLocation.getDocument()

参数类型为I_CmsXmlDocument的org.opencms.xml.content中的构造器

构造器和说明
CmsXmlContentRootLocation(I_CmsXmlDocument doc, java.util.Locale locale) Creates a new root location for a given locale.

org.opencms.xml.page中I_CmsXmlDocument的使用

实现I_CmsXmlDocument的org.opencms.xml.page中的类

限定符和类型	类和说明
class	CmsXmlPage Implementation of a page object used to access and manage xml data.

返回I_CmsXmlDocument的org.opencms.xml.page中的方法

限定符和类型	方法和说明
static I_CmsXmlDocument	CmsXmlPageFactory.unmarshal(CmsObject cms, java.lang.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.

org.opencms.xml.types中I_CmsXmlDocument的使用

声明为I_CmsXmlDocument的org.opencms.xml.types中的字段

限定符和类型	字段和说明
protected I_CmsXmlDocument	A_CmsXmlContentValue.m_document The XML content instance this value belongs to.

返回I_CmsXmlDocument的org.opencms.xml.types中的方法

限定符和类型	方法和说明
I_CmsXmlDocument	A_CmsXmlContentValue.getDocument()
I_CmsXmlDocument	I_CmsXmlContentValue.getDocument() Returns the XML content instance this value belongs to.

参数类型为I_CmsXmlDocument的org.opencms.xml.types中的方法

限定符和类型	方法和说明
I_CmsXmlContentValue	CmsXmlPlainTextStringValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale)
I_CmsXmlContentValue	CmsXmlColorValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale)
I_CmsXmlContentValue	I_CmsXmlSchemaType.createValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale) Creates a XML content value object for this type.
I_CmsXmlContentValue	CmsXmlLocaleValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale)
I_CmsXmlContentValue	CmsXmlHtmlValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale)
I_CmsXmlContentValue	CmsXmlStringValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale)
I_CmsXmlContentValue	CmsXmlBooleanValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale)
I_CmsXmlContentValue	CmsXmlVarLinkValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale)
I_CmsXmlContentValue	CmsXmlVfsImageValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale)
I_CmsXmlContentValue	CmsXmlNestedContentDefinition.createValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale)
I_CmsXmlContentValue	CmsXmlCategoryValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale)
I_CmsXmlContentValue	CmsXmlDateTimeValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale)
I_CmsXmlContentValue	CmsXmlVfsFileValue.createValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale)
org.dom4j.Element	I_CmsXmlSchemaType.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale) Appends an XML for a new, empty node of this schema type to the given root element.
org.dom4j.Element	CmsXmlHtmlValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale)
org.dom4j.Element	A_CmsXmlContentValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale)
org.dom4j.Element	CmsXmlVarLinkValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale)
org.dom4j.Element	CmsXmlNestedContentDefinition.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale)
org.dom4j.Element	CmsXmlCategoryValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale)
org.dom4j.Element	CmsXmlVfsFileValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale)

参数类型为I_CmsXmlDocument的org.opencms.xml.types中的构造器

构造器和说明
A_CmsXmlContentValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type) Initializes the required members for this XML content value.
A_CmsXmlValueCdataBase(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type) Initializes the required members for this XML content value.
A_CmsXmlValueTextBase(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type) Initializes the required members for this XML content value.
CmsXmlBooleanValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type) Creates a new XML content value of type "OpenCmsBoolean".
CmsXmlCategoryValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type) Creates a new XML content value of type "OpenCmsCategoryValue".
CmsXmlColorValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type) Creates a new XML content value of type "OpenCmsColor".
CmsXmlDateTimeValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type) Creates a new XML content value of type "OpenCmsDateTime".
CmsXmlHtmlValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale) Creates a new XML content value of type "OpenCmsHtml".
CmsXmlHtmlValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type) Creates a new XML content value of type "OpenCmsHtml".
CmsXmlLocaleValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type) Creates a new XML content value of type "OpenCmsLocale".
CmsXmlNestedContentDefinition(CmsXmlContentDefinition contentDefinition, I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type) Creates a new XML content value for the nested content definition.
CmsXmlPlainTextStringValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type) Creates a new XML content value of type "OpenCmsString".
CmsXmlStringValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type) Creates a new XML content value of type "OpenCmsString".
CmsXmlVarLinkValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type) Creates a new XML content value of type "OpenCmsVfsFile".
CmsXmlVfsFileValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type) Creates a new XML content value of type "OpenCmsVfsFile".
CmsXmlVfsImageValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type) Creates a new XML content value of type "OpenCmsVfsImage".