org.opencms.setup.xml.v8

类 CmsXmlAddWidgets

java.lang.Object

org.opencms.setup.xml.A_CmsSetupXmlUpdate

org.opencms.setup.xml.A_CmsXmlVfs

org.opencms.setup.xml.v8.CmsXmlAddWidgets

所有已实现的接口:

I_CmsSetupXmlUpdate

public class CmsXmlAddWidgets
extends A_CmsXmlVfs

Updates the widget configuration.

从以下版本开始:

8.0.0

构造器概要

构造器

构造器和说明
CmsXmlAddWidgets()

方法概要

方法

限定符和类型	方法和说明
protected boolean	executeUpdate(org.dom4j.Document document, java.lang.String xpath, boolean forReal) Executes the adding/updating changes on the given 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.
protected java.util.List<java.lang.String>	getXPathsToUpdate() Returns a list of xpaths for the nodes to add/update.
boolean	validate(CmsSetupBean setupBean) Validates the need to apply this change.
protected java.lang.String	xpathForWidgetByAlias(java.lang.String alias) Returns the xpath for a widget with a given alias.
protected java.lang.String	xpathForWidgetClassAttribute(java.lang.String alias) Returns the xpath of the class attribute for a widget with a given alias.
protected java.lang.String	xpathForWidgets() Returns the xpath for the widgets node.

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

createResourceType, createRtParameter, getXmlFilename

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

createElementFromXml, execute, getCodeToChange, getXPathsToRemove, prepareDoc, updateDoc

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

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

构造器详细资料

CmsXmlAddWidgets

public CmsXmlAddWidgets()

方法详细资料

getName

public java.lang.String getName()

从接口复制的说明: I_CmsSetupXmlUpdate

Returns the nice name for the change.

返回:

the nice name

另请参阅:

I_CmsSetupXmlUpdate.getName()

validate

public boolean validate(CmsSetupBean setupBean)
                 throws java.lang.Exception

从接口复制的说明: I_CmsSetupXmlUpdate

Validates the need to apply this change.

指定者:

validate 在接口中 I_CmsSetupXmlUpdate

覆盖:

validate 在类中 A_CmsSetupXmlUpdate

参数:

setupBean - the setup bean

返回:

true if needed

抛出:

java.lang.Exception - if something goes wrong

另请参阅:

I_CmsSetupXmlUpdate.validate(org.opencms.setup.CmsSetupBean)

executeUpdate

protected 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)

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()

getXPathsToUpdate

protected 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()

xpathForWidgetByAlias

protected java.lang.String xpathForWidgetByAlias(java.lang.String alias)

Returns the xpath for a widget with a given alias.

参数:

alias - the widget alias

返回:

the xpath for the widget with the given alias

xpathForWidgetClassAttribute

protected java.lang.String xpathForWidgetClassAttribute(java.lang.String alias)

Returns the xpath of the class attribute for a widget with a given alias.

参数:

alias - the widget alias

返回:

the xpath of the widget's class attribute

xpathForWidgets

protected java.lang.String xpathForWidgets()

Returns the xpath for the widgets node.

返回:

the xpath for the widgets node