Class CmsContextMenuDialog
- java.lang.Object
-
- org.opencms.gwt.client.ui.contextmenu.CmsContextMenuDialog
-
- All Implemented Interfaces:
I_CmsContextMenuCommand
,I_CmsHasContextMenuCommand
public final class CmsContextMenuDialog extends java.lang.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 java.lang.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 java.lang.String
PARAM_CONTENT_STRUCTURE_ID
The parameter name for the content structure id.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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 toI_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.
-
-
-
Field Detail
-
CLOSING_METHOD_NAME
public static final java.lang.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 java.lang.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 Detail
-
getContextMenuCommand
public static I_CmsContextMenuCommand getContextMenuCommand()
Returns the context menu command according toI_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 interfaceI_CmsContextMenuCommand
- Parameters:
structureId
- the structure id of the resourcehandler
- the context menu handlermenuEntryBean
- 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 interfaceI_CmsContextMenuCommand
- Parameters:
structureId
- the structure id of the resourcehandler
- the context menu handlerbean
- 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 interfaceI_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
-
-