Package org.opencms.xml.content
Interface I_CmsXmlContentEditorChangeHandler
-
- All Known Implementing Classes:
A_CmsXmlContentEditorChangeHandler
,CmsDelayedDefaultChangeHandler
,CmsEditorChangeHandlerFormatterSelection
,CmsEditorChangeHandlerProperty
public interface I_CmsXmlContentEditorChangeHandler
Handles changes during the xml content editor session.Allows to modify the content after certain content fields have been edited. The modifications will then be transfered to the editor.
For example, if the user sets a value for the field /link the change handler may set the value of another field /linktitle to the title of the linked resource.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getConfiguration()
Returns the handler configuration.java.lang.String
getScope()
Returns the handler scope.CmsXmlContent
handleChange(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.util.Collection<java.lang.String> changedPaths)
Handles the content change.void
setConfiguration(java.lang.String configuration)
Sets the configuration.void
setScope(java.lang.String scope)
Sets the scope to observe for changes.
-
-
-
Method Detail
-
getConfiguration
java.lang.String getConfiguration()
Returns the handler configuration.- Returns:
- the handler configuration
-
getScope
java.lang.String getScope()
Returns the handler scope.- Returns:
- the handler scope
-
handleChange
CmsXmlContent handleChange(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.util.Collection<java.lang.String> changedPaths)
Handles the content change.- Parameters:
cms
- the cms contextcontent
- the changed contentlocale
- the edited localechangedPaths
- the changed content value paths- Returns:
- the changed content
-
setConfiguration
void setConfiguration(java.lang.String configuration)
Sets the configuration.- Parameters:
configuration
- the configuration
-
setScope
void setScope(java.lang.String scope)
Sets the scope to observe for changes.With a scope set to '/link' all changes below the path /link will be observed.
- Parameters:
scope
- the scope
-
-