Package org.opencms.ade.editprovider.client

Class CmsDirectEditToolbarHandler

java.lang.Object

org.opencms.gwt.client.ui.A_CmsToolbarHandler

org.opencms.ade.editprovider.client.CmsDirectEditToolbarHandler

All Implemented Interfaces:

I_CmsActionHandler, I_CmsContextMenuHandler, I_CmsToolbarHandler

public class CmsDirectEditToolbarHandler
extends A_CmsToolbarHandler

A toolbar handler for the Toolbar direct edit provider.

Since:

8.0.0

Constructor Summary

Constructors

Constructor	Description
CmsDirectEditToolbarHandler(CmsDirectEditEntryPoint entryPoint)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	activateSelection()	Activates the selection button.
void	deactivateCurrentButton()	De-activates the current button.
void	ensureLockOnResource(org.opencms.util.CmsUUID structureId, I_CmsSimpleCallback<java.lang.Boolean> callback)	Tries to lock the given resource and returns true on success.
I_CmsToolbarButton	getActiveButton()	Returns the currently active button (may be null).
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	insertContextMenu(java.util.List<org.opencms.gwt.shared.CmsContextMenuEntryBean> menuBeans, org.opencms.util.CmsUUID structureId)	Inserts the context menu.
void	leavePage(java.lang.String targetUri)	Leaves the current page calling the target URI.
void	loadContextMenu(org.opencms.util.CmsUUID structureId, org.opencms.gwt.shared.CmsCoreData.AdeContext context)	Loads the context menu.
void	onSiteOrProjectChange(java.lang.String sitePath, java.lang.String serverLink)	Called when site and or project have been changed.
void	refreshResource(org.opencms.util.CmsUUID structureId)	Reloads the resource edited.
void	setActiveButton(I_CmsToolbarButton button)	Sets the currently active tool-bar button.
void	setContextMenuButton(CmsToolbarContextButton button)	Sets the context menu button.
void	showPublishDialog()	Opens the publish dialog.
void	showToolbar(boolean show)	Toggles the visibility of the toolbar.
void	unlockResource(org.opencms.util.CmsUUID structureId)	Unlocks the resource if appropriate.

Methods inherited from class org.opencms.gwt.client.ui.A_CmsToolbarHandler

transformEntries, transformSingleEntry

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsDirectEditToolbarHandler

public CmsDirectEditToolbarHandler(CmsDirectEditEntryPoint entryPoint)

Constructor.

Parameters:

entryPoint - the entry point

Method Detail

activateSelection

public void activateSelection()

Description copied from interface: I_CmsToolbarHandler

Activates the selection button.

See Also:

I_CmsToolbarHandler.activateSelection()

deactivateCurrentButton

public void deactivateCurrentButton()

De-activates the current button.

ensureLockOnResource

public void ensureLockOnResource(org.opencms.util.CmsUUID structureId,
                                 I_CmsSimpleCallback<java.lang.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.

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)

getActiveButton

public I_CmsToolbarButton getActiveButton()

Description copied from interface: I_CmsToolbarHandler

Returns the currently active button (may be null).

Returns:

the currently active button

See Also:

I_CmsToolbarHandler.getActiveButton()

getContextMenuCommands

public java.util.Map<java.lang.String,I_CmsContextMenuCommand> getContextMenuCommands()

Description copied from interface: I_CmsContextMenuHandler

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

Returns:

the available context menu commands as a map by class name

See Also:

I_CmsContextMenuHandler.getContextMenuCommands()

getContextType

public java.lang.String getContextType()

Description copied from interface: I_CmsContextMenuHandler

Returns the context type.

Returns:

the context type

See Also:

I_CmsContextMenuHandler.getContextType()

getEditorHandler

public I_CmsContentEditorHandler getEditorHandler()

Description copied from interface: I_CmsContextMenuHandler

Returns the editor handler.

Returns:

the editor handler

See Also:

I_CmsContextMenuHandler.getEditorHandler()

insertContextMenu

public void insertContextMenu(java.util.List<org.opencms.gwt.shared.CmsContextMenuEntryBean> menuBeans,
                              org.opencms.util.CmsUUID structureId)

Inserts the context menu.

Parameters:

menuBeans - the menu beans from the server

structureId - the structure id of the resource at which the workplace should be opened

leavePage

public void leavePage(java.lang.String targetUri)

Description copied from interface: I_CmsActionHandler

Leaves the current page calling the target URI.

Parameters:

targetUri - the target URI

See Also:

I_CmsActionHandler.leavePage(java.lang.String)

loadContextMenu

public void loadContextMenu(org.opencms.util.CmsUUID structureId,
                            org.opencms.gwt.shared.CmsCoreData.AdeContext context)

Description copied from interface: I_CmsToolbarHandler

Loads the context menu.

Parameters:

structureId - the structure id of the resource for which to load the context menu

context - the context menu item visibility context

See Also:

I_CmsToolbarHandler.loadContextMenu(org.opencms.util.CmsUUID, org.opencms.gwt.shared.CmsCoreData.AdeContext)

onSiteOrProjectChange

public void onSiteOrProjectChange(java.lang.String sitePath,
                                  java.lang.String serverLink)

Description copied from interface: I_CmsActionHandler

Called when site and or project have been changed.

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.

Parameters:

structureId - the structure id of the resource to lock

See Also:

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

setActiveButton

public void setActiveButton(I_CmsToolbarButton button)

Sets the currently active tool-bar button.

Parameters:

button - the button

setContextMenuButton

public void setContextMenuButton(CmsToolbarContextButton button)

Sets the context menu button.

Parameters:

button - the context menu button

showPublishDialog

public void showPublishDialog()

Opens the publish dialog.

showToolbar

public void showToolbar(boolean show)

Toggles the visibility of the toolbar.

Parameters:

show - true to show the toolbar

unlockResource

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

Description copied from interface: I_CmsContextMenuHandler

Unlocks the resource if appropriate.

Parameters:

structureId - the structure id of the resource to lock

See Also:

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