Package org.opencms.ui.client

Class CmsGwtDialogExtensionConnector.ContextMenuHandler

java.lang.Object

org.opencms.ui.client.CmsGwtDialogExtensionConnector.ContextMenuHandler

All Implemented Interfaces:

I_CmsActionHandler, I_CmsContextMenuHandler

Enclosing class:

CmsGwtDialogExtensionConnector

public class CmsGwtDialogExtensionConnector.ContextMenuHandler
extends Object
implements I_CmsContextMenuHandler

Context menu handler.

Constructor Summary

Constructors

Constructor	Description
ContextMenuHandler()

Method Summary

Modifier and Type	Method	Description
void	ensureLockOnResource(org.opencms.util.CmsUUID structureId, I_CmsSimpleCallback<Boolean> callback)	Tries to lock the given resource and returns true on success.
Map<String,I_CmsContextMenuCommand>	getContextMenuCommands()	Returns the available context menu commands as a map by class name.
String	getContextType()	Returns the context type.
I_CmsContentEditorHandler	getEditorHandler()	Returns the editor handler.
void	leavePage(String targetUri)	Leaves the current page calling the target URI.
void	onSiteOrProjectChange(String sitePath, String serverLink)	Called when site and or project have been changed.
void	refreshResource(org.opencms.util.CmsUUID structureId)	Reloads the resource edited.
void	unlockResource(org.opencms.util.CmsUUID structureId)	Unlocks the resource if appropriate.

Methods inherited from class java.lang.Object

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

Constructor Details

ContextMenuHandler

public ContextMenuHandler()

Method Details

ensureLockOnResource

public void ensureLockOnResource(org.opencms.util.CmsUUID structureId,
 I_CmsSimpleCallback<Boolean> callback)

Description copied from interface: I_CmsContextMenuHandler

Tries to lock the given resource and returns true on success. If not successful a warning should be displayed.

Specified by:

ensureLockOnResource in interface I_CmsContextMenuHandler

Parameters:

structureId - the structure id of the resource to lock

callback - the callback to execute

See Also:

• I_CmsContextMenuHandler.ensureLockOnResource(org.opencms.util.CmsUUID, org.opencms.gwt.client.util.I_CmsSimpleCallback)

getContextMenuCommands

public Map<String,I_CmsContextMenuCommand> getContextMenuCommands()

Description copied from interface: I_CmsContextMenuHandler

Returns the available context menu commands as a map by class name.

Specified by:

getContextMenuCommands in interface I_CmsContextMenuHandler

Returns:

the available context menu commands as a map by class name

See Also:

• I_CmsContextMenuHandler.getContextMenuCommands()

getContextType

public String getContextType()

Description copied from interface: I_CmsContextMenuHandler

Returns the context type.

Specified by:

getContextType in interface I_CmsContextMenuHandler

Returns:

the context type

See Also:

• I_CmsContextMenuHandler.getContextType()

getEditorHandler

public I_CmsContentEditorHandler getEditorHandler()

Description copied from interface: I_CmsContextMenuHandler

Returns the editor handler.

Specified by:

getEditorHandler in interface I_CmsContextMenuHandler

Returns:

the editor handler

See Also:

• I_CmsContextMenuHandler.getEditorHandler()

leavePage

public void leavePage(String targetUri)

Description copied from interface: I_CmsActionHandler

Leaves the current page calling the target URI.

Specified by:

leavePage in interface I_CmsActionHandler

Parameters:

targetUri - the target URI

See Also:

• I_CmsActionHandler.leavePage(java.lang.String)

onSiteOrProjectChange

public void onSiteOrProjectChange(String sitePath,
 String serverLink)

Description copied from interface: I_CmsActionHandler

Called when site and or project have been changed.

Specified by:

onSiteOrProjectChange in interface I_CmsActionHandler

Parameters:

sitePath - the site path to the target resource

serverLink - the server link to the resource

See Also:

• I_CmsActionHandler.onSiteOrProjectChange(java.lang.String, java.lang.String)

refreshResource

public void refreshResource(org.opencms.util.CmsUUID structureId)

Description copied from interface: I_CmsActionHandler

Reloads the resource edited.

Specified by:

refreshResource in interface I_CmsActionHandler

Parameters:

structureId - the structure id of the resource to lock

See Also:

• I_CmsActionHandler.refreshResource(org.opencms.util.CmsUUID)

unlockResource

public void unlockResource(org.opencms.util.CmsUUID structureId)

Description copied from interface: I_CmsContextMenuHandler

Unlocks the resource if appropriate.

Specified by:

unlockResource in interface I_CmsContextMenuHandler

Parameters:

structureId - the structure id of the resource to lock

See Also:

• I_CmsContextMenuHandler.unlockResource(org.opencms.util.CmsUUID)