Package org.opencms.gwt.client.ui.contextmenu

Class CmsContextMenuDialog

java.lang.Object

org.opencms.gwt.client.ui.contextmenu.CmsContextMenuDialog

All Implemented Interfaces:

I_CmsContextMenuCommand, I_CmsHasContextMenuCommand

public final class CmsContextMenuDialog
extends Object
implements I_CmsHasContextMenuCommand, I_CmsContextMenuCommand

A context menu entry command to open any dialog within an iFrame.

The dialog will be called with the parameter PARAM_CONTENT_STRUCTURE_ID containing the structure id of the currently edited content if available.

To close the dialog call from within the dialog frame context window.parent[CLOSING_METHOD_NAME](boolean reload).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLOSING_METHOD_NAME	The name of the dialog close method exported to the window context.
protected I_CmsContextMenuHandler	m_menuHandler	The context menu handler for this command instance.
static final String	PARAM_CONTENT_STRUCTURE_ID	The parameter name for the content structure id.

Method Summary

Modifier and Type	Method	Description
void	execute(org.opencms.util.CmsUUID structureId, I_CmsContextMenuHandler handler, org.opencms.gwt.shared.CmsContextMenuEntryBean menuEntryBean)	Executed on context menu item click.
static I_CmsContextMenuCommand	getContextMenuCommand()	Returns the context menu command according to I_CmsHasContextMenuCommand.
A_CmsContextMenuItem	getItemWidget(org.opencms.util.CmsUUID structureId, I_CmsContextMenuHandler handler, org.opencms.gwt.shared.CmsContextMenuEntryBean bean)	Returns the special menu item widget for this command.
boolean	hasItemWidget()	Returns if this command provides it's own menu item widget.
protected void	onClose(boolean reload)	Executed on dialog close.

Methods inherited from class java.lang.Object

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

Field Details

CLOSING_METHOD_NAME

public static final String CLOSING_METHOD_NAME

The name of the dialog close method exported to the window context.

See Also:

• Constant Field Values

PARAM_CONTENT_STRUCTURE_ID

public static final String PARAM_CONTENT_STRUCTURE_ID

The parameter name for the content structure id.

See Also:

• Constant Field Values

m_menuHandler

protected I_CmsContextMenuHandler m_menuHandler

The context menu handler for this command instance.

Method Details

getContextMenuCommand

public static I_CmsContextMenuCommand getContextMenuCommand()

Returns the context menu command according to I_CmsHasContextMenuCommand.

Returns:

the context menu command

execute

public void execute(org.opencms.util.CmsUUID structureId,
 I_CmsContextMenuHandler handler,
 org.opencms.gwt.shared.CmsContextMenuEntryBean menuEntryBean)

Description copied from interface: I_CmsContextMenuCommand

Executed on context menu item click.

Specified by:

execute in interface I_CmsContextMenuCommand

Parameters:

structureId - the structure id of the resource

handler - the context menu handler

menuEntryBean - the context menu entry bean

See Also:

• I_CmsContextMenuCommand.execute(org.opencms.util.CmsUUID, org.opencms.gwt.client.ui.contextmenu.I_CmsContextMenuHandler, org.opencms.gwt.shared.CmsContextMenuEntryBean)

getItemWidget

public A_CmsContextMenuItem getItemWidget(org.opencms.util.CmsUUID structureId,
 I_CmsContextMenuHandler handler,
 org.opencms.gwt.shared.CmsContextMenuEntryBean bean)

Description copied from interface: I_CmsContextMenuCommand

Returns the special menu item widget for this command.

Specified by:

getItemWidget in interface I_CmsContextMenuCommand

Parameters:

structureId - the structure id of the resource

handler - the context menu handler

bean - the context menu entry bean

Returns:

the special menu item widget for this command

See Also:

• I_CmsContextMenuCommand.getItemWidget(org.opencms.util.CmsUUID, org.opencms.gwt.client.ui.contextmenu.I_CmsContextMenuHandler, org.opencms.gwt.shared.CmsContextMenuEntryBean)

hasItemWidget

public boolean hasItemWidget()

Description copied from interface: I_CmsContextMenuCommand

Returns if this command provides it's own menu item widget.

Specified by:

hasItemWidget in interface I_CmsContextMenuCommand

Returns:

true if this command provides it's own menu item widget

See Also:

• I_CmsContextMenuCommand.hasItemWidget()

onClose

protected void onClose(boolean reload)

Executed on dialog close.

Parameters:

reload - true if the page should be reloaded