org.opencms.setup.xml.v7

类 CmsXmlAddContextMenuItems

java.lang.Object

org.opencms.setup.xml.A_CmsSetupXmlUpdate

org.opencms.setup.xml.A_CmsXmlWorkplace

org.opencms.setup.xml.v7.CmsXmlAddContextMenuItems

所有已实现的接口:

I_CmsSetupXmlUpdate

public class CmsXmlAddContextMenuItems
extends A_CmsXmlWorkplace

Adds new context menu item nodes.

从以下版本开始:

6.1.8

构造器概要

构造器

构造器和说明
CmsXmlAddContextMenuItems()

方法概要

方法

限定符和类型	方法和说明
protected boolean	checkExplorerType(org.dom4j.Document doc, java.lang.String xpath) Checks whether the explorer type referenced by an xpath exists in the document.
boolean	executeUpdate(org.dom4j.Document document, java.lang.String xpath, boolean forReal) Executes the adding/updating changes on the given document.
protected boolean	existsExplorerType(org.dom4j.Document doc, java.lang.String explorertype) Checks whether a given explorertype exists in the document.
protected java.lang.String	getCommonPath() Returns a parent path that is common for all nodes to modify.
java.lang.String	getName() Returns the nice name for the change.
java.util.List<java.lang.String>	getXPathsToUpdate() Returns a list of xpaths for the nodes to add/update.

从类继承的方法 org.opencms.setup.xml.A_CmsXmlWorkplace

createEtNewResource, createExplorerType, getXmlFilename, setAccessEntry, setMenuEntry

从类继承的方法 org.opencms.setup.xml.A_CmsSetupXmlUpdate

createElementFromXml, execute, getCodeToChange, getXPathsToRemove, prepareDoc, updateDoc, validate

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

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

构造器详细资料

CmsXmlAddContextMenuItems

public CmsXmlAddContextMenuItems()

方法详细资料

executeUpdate

public boolean executeUpdate(org.dom4j.Document document,
                    java.lang.String xpath,
                    boolean forReal)

从类复制的说明: A_CmsSetupXmlUpdate

Executes the adding/updating changes on the given document.

Only needs to be overriden if A_CmsSetupXmlUpdate.getXPathsToUpdate() is not empty.

覆盖:

executeUpdate 在类中 A_CmsSetupXmlUpdate

参数:

document - the document to apply the changes to

xpath - the xpath to execute the changes for

forReal - is false, it is only on a empty doc to display the changes to the user

返回:

if something was modified

另请参阅:

A_CmsSetupXmlUpdate.executeUpdate(org.dom4j.Document, java.lang.String, boolean)

getName

public java.lang.String getName()

从接口复制的说明: I_CmsSetupXmlUpdate

Returns the nice name for the change.

返回:

the nice name

另请参阅:

I_CmsSetupXmlUpdate.getName()

getXPathsToUpdate

public java.util.List<java.lang.String> getXPathsToUpdate()

从类复制的说明: A_CmsSetupXmlUpdate

Returns a list of xpaths for the nodes to add/update.

覆盖:

getXPathsToUpdate 在类中 A_CmsSetupXmlUpdate

返回:

a list of strings

另请参阅:

A_CmsSetupXmlUpdate.getXPathsToUpdate()

checkExplorerType

protected boolean checkExplorerType(org.dom4j.Document doc,
                        java.lang.String xpath)

Checks whether the explorer type referenced by an xpath exists in the document.

参数:

doc - the document

xpath - the xpath, potentially referencing an explorertype

返回:

true if the xpath references no explorertype, or the referenced explorertype is contained in the document

existsExplorerType

protected boolean existsExplorerType(org.dom4j.Document doc,
                         java.lang.String explorertype)

Checks whether a given explorertype exists in the document.

参数:

doc - the XML document

explorertype - the explorertype to check

返回:

true if the explorertype exists

getCommonPath

protected java.lang.String getCommonPath()

从类复制的说明: A_CmsSetupXmlUpdate

Returns a parent path that is common for all nodes to modify.

覆盖:

getCommonPath 在类中 A_CmsSetupXmlUpdate

返回:

common parent path

另请参阅:

A_CmsSetupXmlUpdate.getCommonPath()