类 org.opencms.xml.content.CmsXmlContent
的使用

使用CmsXmlContent的程序包

程序包	说明
org.opencms.ade.configuration
org.opencms.ade.configuration.formatters
org.opencms.ade.containerpage.inherited
org.opencms.ade.contenteditor
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.notification	Contains classes for the automatical notification of outdated, expiring or released content.
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.workplace.tools.content.check	This package contains the tool classes for the content check tools administration view.
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.ade.configuration中CmsXmlContent的使用

参数类型为CmsXmlContent的org.opencms.ade.configuration中的方法

限定符和类型	方法和说明
CmsADEConfigData	CmsConfigurationReader.parseConfiguration(java.lang.String basePath, CmsXmlContent content) Parses a configuration XML content and creates a configuration object from it.

org.opencms.ade.configuration.formatters中CmsXmlContent的使用

参数类型为CmsXmlContent的org.opencms.ade.configuration.formatters中的方法

限定符和类型	方法和说明
CmsFormatterBean	CmsFormatterBeanParser.parse(CmsXmlContent content, java.lang.String location, java.lang.String id) Reads the formatter bean from the given XML content.

org.opencms.ade.containerpage.inherited中CmsXmlContent的使用

返回CmsXmlContent的org.opencms.ade.containerpage.inherited中的方法

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

参数类型为CmsXmlContent的org.opencms.ade.containerpage.inherited中的方法

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

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

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

限定符和类型	方法和说明
protected com.alkacon.acacia.shared.Entity	CmsContentService.readEntity(CmsXmlContent content, org.dom4j.Element element, java.util.Locale locale, java.lang.String entityId, java.lang.String parentPath, java.lang.String typeName, java.util.Map<java.lang.String,com.alkacon.vie.shared.I_Type> registeredTypes) Parses the element into an entity.

org.opencms.file.types中CmsXmlContent的使用

参数类型为CmsXmlContent的org.opencms.file.types中的方法

限定符和类型	方法和说明
protected CmsLink	CmsResourceTypeXmlContent.getXsdLink(CmsObject cms, CmsXmlContent xmlContent) Creates a new link object for the schema definition.

org.opencms.jsp.decorator中CmsXmlContent的使用

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

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

org.opencms.notification中CmsXmlContent的使用

声明为CmsXmlContent的org.opencms.notification中的字段

限定符和类型	字段和说明
protected CmsXmlContent	A_CmsNotification.m_mailContent The xml-content to read subject, header and footer of the notification.

org.opencms.widgets中CmsXmlContent的使用

参数类型为CmsXmlContent的org.opencms.widgets中的方法

限定符和类型	方法和说明
protected java.util.Set<java.lang.String>	CmsRemoveFormatterWidget.getSelectedInFile(CmsConfigurationReader reader, CmsXmlContent content)
protected java.util.Set<java.lang.String>	CmsAddFormatterWidget.getSelectedInFile(CmsConfigurationReader reader, CmsXmlContent content)
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.

org.opencms.workplace中CmsXmlContent的使用

返回CmsXmlContent的org.opencms.workplace中的方法

限定符和类型	方法和说明
protected CmsXmlContent	CmsLoginUserAgreement.getConfigurationContent() Returns the user agreement configuration content.

org.opencms.workplace.editors中CmsXmlContent的使用

参数类型为CmsXmlContent的org.opencms.workplace.editors中的方法

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

org.opencms.workplace.tools.content.check中CmsXmlContent的使用

返回CmsXmlContent的org.opencms.workplace.tools.content.check中的方法

限定符和类型	方法和说明
CmsXmlContent	CmsContentCheckResource.getXmlContent() Gets the encapuslated and unmarshalled xml content.

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

org.opencms.xml.containerpage中CmsXmlContent的子类

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

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

限定符和类型	方法和说明
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.
protected void	CmsXmlContainerPageHandler.validateNames(CmsObject cms, I_CmsXmlContentValue value, CmsXmlContent content) Validates container names, so that they are unique in the page.

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

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

限定符和类型	方法和说明
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_CmsXmlContentHandler.prepareForUse(CmsObject cms, CmsXmlContent content) Prepares the given XML content to be used after it was read from the OpenCms VFS.
CmsXmlContent	CmsDefaultXmlContentHandler.prepareForUse(CmsObject cms, CmsXmlContent content)
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.

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

限定符和类型	方法和说明
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.getPreview(CmsObject cms, CmsXmlContent content, java.lang.String resourcename)
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.
java.lang.String	CmsDefaultXmlContentHandler.getTitleMapping(CmsObject cms, CmsXmlContent document, java.util.Locale locale)
void	I_CmsXmlContentHandler.invalidateBrokenLinks(CmsObject cms, CmsXmlContent document) Performs a check of the given XML document.
void	CmsDefaultXmlContentHandler.invalidateBrokenLinks(CmsObject cms, CmsXmlContent document)
CmsXmlContent	I_CmsXmlContentHandler.prepareForUse(CmsObject cms, CmsXmlContent content) Prepares the given XML content to be used after it was read from the OpenCms VFS.
CmsXmlContent	CmsDefaultXmlContentHandler.prepareForUse(CmsObject cms, CmsXmlContent content)
CmsFile	I_CmsXmlContentHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file) Prepares the given XML content to be written to the OpenCms VFS.
CmsFile	CmsDefaultXmlContentHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file)
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.
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.
void	CmsDefaultXmlContentHandler.resolveMapping(CmsObject cms, CmsXmlContent content, I_CmsXmlContentValue value)
protected CmsFile	CmsDefaultXmlContentHandler.writeCategories(CmsObject cms, CmsFile file, CmsXmlContent content) Writes the categories if a category widget is present.

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

构造器和说明
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.