Class CmsEditProperties
- java.lang.Object
-
- org.opencms.gwt.client.ui.contextmenu.CmsEditProperties
-
- All Implemented Interfaces:
I_CmsHasContextMenuCommand
public final class CmsEditProperties extends java.lang.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
All Methods Static Methods Concrete Methods Modifier and Type Method Description static void
editProperties(org.opencms.util.CmsUUID structureId, I_CmsContextMenuHandler contextMenuHandler, boolean editName, java.lang.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, java.lang.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 toI_CmsHasContextMenuCommand
.static void
openPropertyDialog(org.opencms.gwt.shared.property.CmsPropertiesBean result, I_CmsContextMenuHandler contextMenuHandler, boolean editName, java.lang.Runnable cancelHandler, boolean enableAdeTemplateSelect, CmsEditProperties.PropertyEditingContext editContext)
Opens the property dialog and populates it with the data from a given CmsPropertiesBean.
-
-
-
Method Detail
-
editProperties
public static void editProperties(org.opencms.util.CmsUUID structureId, I_CmsContextMenuHandler contextMenuHandler, boolean editName, java.lang.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 resourcecontextMenuHandler
- the context menu handlereditName
- if true, provides a field for changing the file namecancelHandler
- callback which is executed if the user cancels the property dialogenableAdeTemplateSelect
- enables/disables special template selectoreditContext
- the editing context
-
editPropertiesWithFileNavigation
public static void editPropertiesWithFileNavigation(org.opencms.util.CmsUUID structureId, I_CmsContextMenuHandler contextMenuHandler, boolean editName, java.lang.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 resourcecontextMenuHandler
- the context menu handlereditName
- if true, provides a field for changing the file namecancelHandler
- callback which is executed if the user cancels the property dialogenableAdeTemplateSelect
- enables/disables special template selectoreditContext
- the editing contextprevFieldData
- the previous active field data (may be null)
-
getContextMenuCommand
public static I_CmsContextMenuCommand getContextMenuCommand()
Returns the context menu command according toI_CmsHasContextMenuCommand
.- Returns:
- the context menu command
-
openPropertyDialog
public static void openPropertyDialog(org.opencms.gwt.shared.property.CmsPropertiesBean result, I_CmsContextMenuHandler contextMenuHandler, boolean editName, java.lang.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 datacontextMenuHandler
- the context menu handlereditName
- true if the name should be editablecancelHandler
- the cancel handlerenableAdeTemplateSelect
- true if template selection should be enablededitContext
- the edit context
-
-