Interface I_CmsContextMenuHandler
-
- All Superinterfaces:
I_CmsActionHandler
- All Known Subinterfaces:
I_CmsToolbarHandler
- All Known Implementing Classes:
A_CmsToolbarHandler
,CmsContainerpageHandler
,CmsContextMenuHandler
,CmsDialogContextMenuHandler
,CmsDirectEditToolbarHandler
,CmsGwtDialogExtensionConnector.ContextMenuHandler
,CmsPropertyDialogExtensionConnector.ContextMenuHandler
,CmsResultContextMenuHandler
,CmsSitemapToolbarHandler
public interface I_CmsContextMenuHandler extends I_CmsActionHandler
Interface for context menu commands.- Since:
- version 8.0.1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
ensureLockOnResource(org.opencms.util.CmsUUID structureId, I_CmsSimpleCallback<java.lang.Boolean> callback)
Tries to lock the given resource and returnstrue
on success.java.util.Map<java.lang.String,I_CmsContextMenuCommand>
getContextMenuCommands()
Returns the available context menu commands as a map by class name.java.lang.String
getContextType()
Returns the context type.I_CmsContentEditorHandler
getEditorHandler()
Returns the editor handler.void
unlockResource(org.opencms.util.CmsUUID structureId)
Unlocks the resource if appropriate.-
Methods inherited from interface org.opencms.gwt.client.ui.contextmenu.I_CmsActionHandler
leavePage, onSiteOrProjectChange, refreshResource
-
-
-
-
Method Detail
-
ensureLockOnResource
void ensureLockOnResource(org.opencms.util.CmsUUID structureId, I_CmsSimpleCallback<java.lang.Boolean> callback)
Tries to lock the given resource and returnstrue
on success. If not successful a warning should be displayed.- Parameters:
structureId
- the structure id of the resource to lockcallback
- the callback to execute
-
getContextMenuCommands
java.util.Map<java.lang.String,I_CmsContextMenuCommand> getContextMenuCommands()
Returns the available context menu commands as a map by class name.- Returns:
- the available context menu commands as a map by class name
-
getContextType
java.lang.String getContextType()
Returns the context type.- Returns:
- the context type
-
getEditorHandler
I_CmsContentEditorHandler getEditorHandler()
Returns the editor handler.- Returns:
- the editor handler
-
unlockResource
void unlockResource(org.opencms.util.CmsUUID structureId)
Unlocks the resource if appropriate.- Parameters:
structureId
- the structure id of the resource to lock
-
-