org.opencms.xml.containerpage

类 CmsXmlContainerPage

java.lang.Object

org.opencms.xml.A_CmsXmlDocument

org.opencms.xml.content.CmsXmlContent

org.opencms.xml.containerpage.CmsXmlContainerPage

所有已实现的接口:

I_CmsXmlDocument

public class CmsXmlContainerPage
extends CmsXmlContent

Implementation of a object used to access and manage the xml data of a container page.

In addition to the XML content interface. It also provides access to more comfortable beans.

从以下版本开始:

7.5.2

另请参阅:

getContainerPage(CmsObject, Locale)

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CmsXmlContainerPage.XmlNode XML node name constants.

字段概要

从类继承的字段 org.opencms.xml.content.CmsXmlContent

AUTO_CORRECTION_ATTRIBUTE, m_autoCorrectionEnabled, m_contentDefinition, XERCES_SCHEMA_PROPERTY

从类继承的字段 org.opencms.xml.A_CmsXmlDocument

m_conversion, m_document, m_elementLocales, m_elementNames, m_encoding, m_file, m_locales

构造器概要

构造器

限定符	构造器和说明
protected	CmsXmlContainerPage() Hides the public constructor.
protected	CmsXmlContainerPage(CmsObject cms, org.dom4j.Document document, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Creates a new container page based on the provided XML document.
protected	CmsXmlContainerPage(CmsObject cms, java.util.Locale locale, java.lang.String modelUri) Create a new container page based on the given default content, that will have all language nodes of the default content and ensures the presence of the given locale.
protected	CmsXmlContainerPage(CmsObject cms, java.util.Locale locale, java.lang.String encoding, CmsXmlContentDefinition contentDefinition) Create a new container page based on the given content definition, that will have one language node for the given locale all initialized with default values.

方法概要

方法

限定符和类型	方法和说明
protected CmsContainerPageBean	addUnusedContainers(CmsObject cms, java.util.Locale locale, CmsContainerPageBean cntPage) Merges the containers of the current document that are not used in the given container page with it.
protected void	checkLinkConcistency(CmsObject cms, java.util.Locale locale) Checks the link consistency for a given locale and reinitializes the document afterwards.
byte[]	createContainerPageXml(CmsObject cms, java.util.Locale locale, CmsContainerPageBean cntPage) Saves a container page bean to the in-memory XML structure and returns the changed content.
protected CmsResource	fillResource(CmsObject cms, org.dom4j.Element element, CmsUUID resourceId) Fills a CmsXmlVfsFileValue with the resource identified by the given id.
CmsContainerPageBean	getContainerPage(CmsObject cms, java.util.Locale locale) Returns the container page bean for the given locale.
protected void	initDocument(org.dom4j.Document document, java.lang.String encoding, CmsXmlContentDefinition definition) Initializes an XML document based on the provided document, encoding and content definition.
boolean	isAutoCorrectionEnabled() Returns true if the auto correction feature is enabled for saving this XML content.
void	save(CmsObject cms, java.util.Locale locale, CmsContainerPageBean cntPage) Saves given container page in the current locale, and not only in memory but also to VFS.
protected void	saveContainerPage(CmsObject cms, org.dom4j.Element parent, CmsContainerPageBean cntPage) Adds the given container page to the given element.
protected void	setFile(CmsFile file) Sets the file this XML content is written to.
void	writeContainerPage(CmsObject cms, java.util.Locale locale, CmsContainerPageBean cntPage) Saves a container page in in-memory XML structure.

从类继承的方法 org.opencms.xml.content.CmsXmlContent

addBookmarkForElement, addBookmarkForValue, addLocale, addValue, addValue, copyLocale, getBookmark, getBookmarks, getChoiceOptions, getContentDefinition, getContentDefinition, getHandler, getLinkProcessor, getLocaleNode, getSubValues, getValueSequence, hasChoiceOptions, initDocument, processSchemaNode, removeValue, resolveMappings, setAutoCorrectionEnabled, validate, visitAllValuesWith

从类继承的方法 org.opencms.xml.A_CmsXmlDocument

addBookmark, addLocale, clearBookmarks, copyLocale, copyLocale, correctXmlStructure, createDeepElementCopy, getBestMatchingLocale, getBookmark, getBookmarkName, getConversion, getEncoding, getFile, getIndexCount, getLocales, getLocales, getNames, getStringValue, getStringValue, getValue, getValue, getValueInternal, getValues, getValues, hasLocale, hasValue, hasValue, initDocument, isEnabled, isEnabled, marshal, marshal, moveLocale, removeBookmark, removeLocale, setConversion, toString, validateXmlStructure

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造器详细资料

CmsXmlContainerPage

protected CmsXmlContainerPage()

Hides the public constructor.

CmsXmlContainerPage

protected CmsXmlContainerPage(CmsObject cms,
                   org.dom4j.Document document,
                   java.lang.String encoding,
                   org.xml.sax.EntityResolver resolver)

Creates a new container page based on the provided XML document.

The given encoding is used when marshalling the XML again later.

参数:

cms - the cms context, if null no link validation is performed

document - the document to create the container page from

encoding - the encoding of the container page

resolver - the XML entity resolver to use

CmsXmlContainerPage

protected CmsXmlContainerPage(CmsObject cms,
                   java.util.Locale locale,
                   java.lang.String modelUri)
                       throws CmsException

Create a new container page based on the given default content, that will have all language nodes of the default content and ensures the presence of the given locale.

The given encoding is used when marshalling the XML again later.

参数:

cms - the current users OpenCms content

locale - the locale to generate the default content for

modelUri - the absolute path to the container page file acting as model

抛出:

CmsException - in case the model file is not found or not valid

CmsXmlContainerPage

protected CmsXmlContainerPage(CmsObject cms,
                   java.util.Locale locale,
                   java.lang.String encoding,
                   CmsXmlContentDefinition contentDefinition)

Create a new container page based on the given content definition, that will have one language node for the given locale all initialized with default values.

The given encoding is used when marshalling the XML again later.

参数:

cms - the current users OpenCms content

locale - the locale to generate the default content for

encoding - the encoding to use when marshalling the container page later

contentDefinition - the content definition to create the content for

方法详细资料

createContainerPageXml

public byte[] createContainerPageXml(CmsObject cms,
                            java.util.Locale locale,
                            CmsContainerPageBean cntPage)
                              throws CmsException

Saves a container page bean to the in-memory XML structure and returns the changed content.

参数:

cms - the current CMS context

locale - the locale for which the content should be replaced

cntPage - the container page bean

返回:

the new content for the container page

抛出:

CmsException - if something goes wrong

getContainerPage

public CmsContainerPageBean getContainerPage(CmsObject cms,
                                    java.util.Locale locale)

Returns the container page bean for the given locale.

参数:

cms - the cms context

locale - the locale to use

返回:

the container page bean

isAutoCorrectionEnabled

public boolean isAutoCorrectionEnabled()

从类复制的说明: A_CmsXmlDocument

Returns true if the auto correction feature is enabled for saving this XML content.

覆盖:

isAutoCorrectionEnabled 在类中 CmsXmlContent

返回:

true if the auto correction feature is enabled for saving this XML content

另请参阅:

CmsXmlContent.isAutoCorrectionEnabled()

save

public void save(CmsObject cms,
        java.util.Locale locale,
        CmsContainerPageBean cntPage)
          throws CmsException

Saves given container page in the current locale, and not only in memory but also to VFS.

参数:

cms - the current cms context

locale - the content locale

cntPage - the container page to save

抛出:

CmsException - if something goes wrong

writeContainerPage

public void writeContainerPage(CmsObject cms,
                      java.util.Locale locale,
                      CmsContainerPageBean cntPage)
                        throws CmsException

Saves a container page in in-memory XML structure.

参数:

cms - the current CMS context

locale - the locale for which the content should be replaced

cntPage - the container page bean to save

抛出:

CmsException - if something goes wrong

addUnusedContainers

protected CmsContainerPageBean addUnusedContainers(CmsObject cms,
                                       java.util.Locale locale,
                                       CmsContainerPageBean cntPage)

Merges the containers of the current document that are not used in the given container page with it.

参数:

cms - the current CMS context

locale - the content locale

cntPage - the container page to merge

返回:

a new container page with the additional unused containers

checkLinkConcistency

protected void checkLinkConcistency(CmsObject cms,
                        java.util.Locale locale)

Checks the link consistency for a given locale and reinitializes the document afterwards.

参数:

cms - the cms context

locale - the locale

fillResource

protected CmsResource fillResource(CmsObject cms,
                       org.dom4j.Element element,
                       CmsUUID resourceId)
                            throws CmsException

Fills a CmsXmlVfsFileValue with the resource identified by the given id.

参数:

cms - the current CMS context

element - the XML element to fill

resourceId - the ID identifying the resource to use

返回:

the resource

抛出:

CmsException - if the resource can not be read

initDocument

protected void initDocument(org.dom4j.Document document,
                java.lang.String encoding,
                CmsXmlContentDefinition definition)

从类复制的说明: A_CmsXmlDocument

Initializes an XML document based on the provided document, encoding and content definition.

覆盖:

initDocument 在类中 CmsXmlContent

参数:

document - the base XML document to use for initializing

encoding - the encoding to use when marshalling the document later

definition - the content definition to use

另请参阅:

A_CmsXmlDocument.initDocument(org.dom4j.Document, java.lang.String, org.opencms.xml.CmsXmlContentDefinition)

saveContainerPage

protected void saveContainerPage(CmsObject cms,
                     org.dom4j.Element parent,
                     CmsContainerPageBean cntPage)
                          throws CmsException

Adds the given container page to the given element.

参数:

cms - the current CMS object

parent - the element to add it

cntPage - the container page to add

抛出:

CmsException - if something goes wrong

setFile

protected void setFile(CmsFile file)

从类复制的说明: CmsXmlContent

Sets the file this XML content is written to.

覆盖:

setFile 在类中 CmsXmlContent

参数:

file - the file this XML content content is written to

另请参阅:

CmsXmlContent.setFile(org.opencms.file.CmsFile)