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

Class CmsEditProperties

java.lang.Object

org.opencms.gwt.client.ui.contextmenu.CmsEditProperties

All Implemented Interfaces:

I_CmsHasContextMenuCommand

public final class CmsEditProperties
extends Object
implements I_CmsHasContextMenuCommand

The class for the "edit properties" context menu entries.

Since:

8.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CmsEditProperties.I_MultiFileNavigation	Interface used to access the next/previous file for which to edit properties.
static class	CmsEditProperties.PropertyEditingContext	Helper class which encapsulates the differences between the contexts where the property edit dialog is opened.
protected static class	CmsEditProperties.PropertyEditorHandler	Property editor handler which uses a text box for the template selection.
static class	CmsEditProperties.WorkplacePropertyEditorContext	Helper class for editing properties in the workplace.

Method Summary

Modifier and Type	Method	Description
static void	editProperties(org.opencms.util.CmsUUID structureId, I_CmsContextMenuHandler contextMenuHandler, boolean editName, Runnable cancelHandler, boolean enableAdeTemplateSelect, CmsEditProperties.PropertyEditingContext editContext)	Starts the property editor for the resource with the given structure id.
static void	editPropertiesWithFileNavigation(org.opencms.util.CmsUUID structureId, I_CmsContextMenuHandler contextMenuHandler, boolean editName, Runnable cancelHandler, boolean enableAdeTemplateSelect, CmsEditProperties.PropertyEditingContext editContext, CmsActiveFieldData prevFieldData)	Starts the property editor for the resource with the given structure id.
static I_CmsContextMenuCommand	getContextMenuCommand()	Returns the context menu command according to I_CmsHasContextMenuCommand.
static void	openPropertyDialog(org.opencms.gwt.shared.property.CmsPropertiesBean result, I_CmsContextMenuHandler contextMenuHandler, boolean editName, Runnable cancelHandler, boolean enableAdeTemplateSelect, CmsEditProperties.PropertyEditingContext editContext)	Opens the property dialog and populates it with the data from a given CmsPropertiesBean.

Methods inherited from class java.lang.Object

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

Method Details

editProperties

public static void editProperties(org.opencms.util.CmsUUID structureId,
 I_CmsContextMenuHandler contextMenuHandler,
 boolean editName,
 Runnable cancelHandler,
 boolean enableAdeTemplateSelect,
 CmsEditProperties.PropertyEditingContext editContext)

Starts the property editor for the resource with the given structure id.

Parameters:

structureId - the structure id of a resource

contextMenuHandler - the context menu handler

editName - if true, provides a field for changing the file name

cancelHandler - callback which is executed if the user cancels the property dialog

enableAdeTemplateSelect - enables/disables special template selector

editContext - the editing context

editPropertiesWithFileNavigation

public static void editPropertiesWithFileNavigation(org.opencms.util.CmsUUID structureId,
 I_CmsContextMenuHandler contextMenuHandler,
 boolean editName,
 Runnable cancelHandler,
 boolean enableAdeTemplateSelect,
 CmsEditProperties.PropertyEditingContext editContext,
 CmsActiveFieldData prevFieldData)

Starts the property editor for the resource with the given structure id.

Parameters:

structureId - the structure id of a resource

contextMenuHandler - the context menu handler

editName - if true, provides a field for changing the file name

cancelHandler - callback which is executed if the user cancels the property dialog

enableAdeTemplateSelect - enables/disables special template selector

editContext - the editing context

prevFieldData - the previous active field data (may be null)

getContextMenuCommand

public static I_CmsContextMenuCommand getContextMenuCommand()

Returns the context menu command according to I_CmsHasContextMenuCommand.

Returns:

the context menu command

openPropertyDialog

public static void openPropertyDialog(org.opencms.gwt.shared.property.CmsPropertiesBean result,
 I_CmsContextMenuHandler contextMenuHandler,
 boolean editName,
 Runnable cancelHandler,
 boolean enableAdeTemplateSelect,
 CmsEditProperties.PropertyEditingContext editContext)

Opens the property dialog and populates it with the data from a given CmsPropertiesBean.

Parameters:

result - the property data

contextMenuHandler - the context menu handler

editName - true if the name should be editable

cancelHandler - the cancel handler

enableAdeTemplateSelect - true if template selection should be enabled

editContext - the edit context