Package org.opencms.ade.containerpage.client

Class CmsContentEditorHandler

java.lang.Object

org.opencms.ade.containerpage.client.CmsContentEditorHandler

All Implemented Interfaces:

I_CmsContentEditorHandler

public class CmsContentEditorHandler
extends java.lang.Object
implements I_CmsContentEditorHandler

The container-page editor implementation of the XML content editor handler.

Since:

8.0.0

Constructor Summary

Constructors

Constructor	Description
CmsContentEditorHandler(CmsContainerpageHandler handler)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	closeContentEditor()	Closes the content editor.
protected java.lang.String	getCurrentElementId()	Returns the currently edited element's id.
void	onClose(java.lang.String sitePath, org.opencms.util.CmsUUID structureId, boolean isNew, boolean hasChangedSettings, boolean usedPublishDialog)	Executed by the XML content editor dialog on close.
void	openDialog(CmsContainerPageElementPanel element, boolean inline, boolean wasNew)	Opens the XML content editor.
void	openDialog(I_CmsEditableData editableData, boolean isNew, java.lang.String dependingElementId, java.lang.String mode, org.opencms.ade.contenteditor.shared.CmsEditHandlerData handlerDataForNew)	Opens the XML content editor, checking for if an edit handler is configured first.
void	openEditorForHistory(java.lang.String historyHash)	Opens the content editor according to the history hash.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsContentEditorHandler

public CmsContentEditorHandler(CmsContainerpageHandler handler)

Constructor.

Parameters:

handler - the container-page handler

Method Detail

closeContentEditor

public void closeContentEditor()

Closes the content editor.

onClose

public void onClose(java.lang.String sitePath,
                    org.opencms.util.CmsUUID structureId,
                    boolean isNew,
                    boolean hasChangedSettings,
                    boolean usedPublishDialog)

Description copied from interface: I_CmsContentEditorHandler

Executed by the XML content editor dialog on close.

Specified by:

onClose in interface I_CmsContentEditorHandler

Parameters:

sitePath - the sitepath of the edited resource

structureId - the structure id of the edited resource

isNew - true if the resource was newly created

hasChangedSettings - true in case container page element settings where changed during edit

usedPublishDialog - true if the editor was closed by using the publish button

See Also:

I_CmsContentEditorHandler.onClose(java.lang.String, org.opencms.util.CmsUUID, boolean, boolean, boolean)

openDialog

public void openDialog(CmsContainerPageElementPanel element,
                       boolean inline,
                       boolean wasNew)

Opens the XML content editor.

Parameters:

element - the container element widget

inline - true to open the in-line editor for the given element if available

wasNew - true in case this is a newly created element not previously edited

openDialog

public void openDialog(I_CmsEditableData editableData,
                       boolean isNew,
                       java.lang.String dependingElementId,
                       java.lang.String mode,
                       org.opencms.ade.contenteditor.shared.CmsEditHandlerData handlerDataForNew)

Opens the XML content editor, checking for if an edit handler is configured first.

Parameters:

editableData - the data of the element to edit

isNew - true if a new resource should be created

dependingElementId - the id of a depending element

mode - the element creation mode

handlerDataForNew - the edit handler data, if we are using an edit handler to create a new element; null otherwise

openEditorForHistory

public void openEditorForHistory(java.lang.String historyHash)

Opens the content editor according to the history hash.

Parameters:

historyHash - the history hash

getCurrentElementId

protected java.lang.String getCurrentElementId()

Returns the currently edited element's id.

Returns:

the currently edited element's id