org.opencms.setup.xml
Class CmsXmlReplaceHtmlAreaWidgets

java.lang.Object
  org.opencms.setup.xml.A_CmsSetupXmlUpdate
      org.opencms.setup.xml.CmsXmlReplaceHtmlAreaWidgets

All Implemented Interfaces:

I_CmsSetupXmlUpdate

public class CmsXmlReplaceHtmlAreaWidgets
extends A_CmsSetupXmlUpdate

Replaces the html area widget entries.

Since:

6.1.8

Version:

$Revision: 1.2 $

Author:

Michael Moossen

Constructor Summary

CmsXmlReplaceHtmlAreaWidgets()

Method Summary

protected boolean	executeUpdate(Document document, String xpath) Executes the adding/updating changes on the given document.
protected String	getCommonPath() Returns a parent path that is common for all nodes to modify.
String	getName() Returns the nice name for the change.
String	getXmlFilename() Returns the affected xml configuration file name.
protected List	getXPathsToUpdate() Returns a list of xpaths for the nodes to add/update.

Methods inherited from class org.opencms.setup.xml.A_CmsSetupXmlUpdate

execute, getCodeToChange, getXPathsToRemove, prepareDoc, updateDoc, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsXmlReplaceHtmlAreaWidgets

public CmsXmlReplaceHtmlAreaWidgets()

Method Detail

getName

public String getName()

Description copied from interface: I_CmsSetupXmlUpdate

Returns the nice name for the change.

Returns:

the nice name

See Also:

I_CmsSetupXmlUpdate.getName()

getXmlFilename

public String getXmlFilename()

Description copied from interface: I_CmsSetupXmlUpdate

Returns the affected xml configuration file name.

Returns:

the xml file name

See Also:

I_CmsSetupXmlUpdate.getXmlFilename()

executeUpdate

protected boolean executeUpdate(Document document,
                                String xpath)

Description copied from class: A_CmsSetupXmlUpdate

Executes the adding/updating changes on the given document.

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

Overrides:

executeUpdate in class A_CmsSetupXmlUpdate

Parameters:

document - the document to apply the changes to

xpath - the xpath to execute the changes for

Returns:

if something was modified

See Also:

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

getCommonPath

protected String getCommonPath()

Description copied from class: A_CmsSetupXmlUpdate

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

Overrides:

getCommonPath in class A_CmsSetupXmlUpdate

Returns:

common parent path

See Also:

A_CmsSetupXmlUpdate.getCommonPath()

getXPathsToUpdate

protected List getXPathsToUpdate()

Description copied from class: A_CmsSetupXmlUpdate

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

Overrides:

getXPathsToUpdate in class A_CmsSetupXmlUpdate

Returns:

a list of strings

See Also:

A_CmsSetupXmlUpdate.getXPathsToUpdate()