Package org.opencms.gwt.client.property
Interface I_CmsPropertyEditorHandler
-
- All Known Implementing Classes:
A_CmsSitemapEntryEditorHandler
,CmsEditEntryHandler
,CmsEditProperties.PropertyEditorHandler
,CmsLocaleComparePropertyHandler
,CmsSimplePropertyEditorHandler
,CmsUploadPropertyEditorHandler
public interface I_CmsPropertyEditorHandler
An interface for sitemap entry editor modes.- Since:
- 8.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<java.lang.String>
getAllPropertyNames()
Gets a list of the names of available properties.org.opencms.util.CmsUUID
getDefaultFileId()
Returns the default file id, if available.java.util.Map<java.lang.String,org.opencms.gwt.shared.property.CmsClientProperty>
getDefaultFileProperties()
Returns the default file properties, if available.java.lang.String
getDialogTitle()
Returns the text which should be used for the title of the sitemap entry editor dialog.java.util.List<java.lang.String>
getForbiddenUrlNames()
Returns the URL names which the new URL name of the entry must not be equal to.org.opencms.util.CmsUUID
getId()
Returns the structure id of the resource being edited.org.opencms.gwt.shared.property.CmsClientProperty
getInheritedProperty(java.lang.String name)
Returns an inherited property value.java.lang.String
getModeClass()
Returns the class name which should be added when displaying resource info boxes.java.lang.String
getName()
Returns the URL name with which the sitemap entry editor should be initialized.java.util.Map<java.lang.String,org.opencms.gwt.shared.property.CmsClientProperty>
getOwnProperties()
Returns the properties of the resource being edited.org.opencms.gwt.shared.CmsListInfoBean
getPageInfo()
Returns the page info bean.java.lang.String
getPath()
Gets the path of the resource being edited.java.util.Map<java.lang.String,org.opencms.gwt.shared.property.CmsClientTemplateBean>
getPossibleTemplates()
Returns a map of beans representing the selectable templates.void
handleSubmit(java.lang.String newUrlName, java.lang.String vfsPath, java.util.List<org.opencms.gwt.shared.property.CmsPropertyModification> propertyChanges, boolean editedName, CmsReloadMode reloadMode)
Handles the submit action for the sitemap entry editor.boolean
hasEditableName()
Returns if the handled entry has an editable name.boolean
isFolder()
Checks if the resource being edited is a folder.boolean
isHiddenProperty(java.lang.String key)
Checks whether the property with the given name should be hidden.boolean
isSimpleMode()
Should return true if the sitemap editor is running in simple mode.boolean
useAdeTemplates()
Returns true if the property editor should use only ADE templates.
-
-
-
Method Detail
-
getAllPropertyNames
java.util.List<java.lang.String> getAllPropertyNames()
Gets a list of the names of available properties.- Returns:
- a list of property names
-
getDefaultFileId
org.opencms.util.CmsUUID getDefaultFileId()
Returns the default file id, if available.- Returns:
- the default file id
-
getDefaultFileProperties
java.util.Map<java.lang.String,org.opencms.gwt.shared.property.CmsClientProperty> getDefaultFileProperties()
Returns the default file properties, if available.- Returns:
- the default file properties
-
getDialogTitle
java.lang.String getDialogTitle()
Returns the text which should be used for the title of the sitemap entry editor dialog.- Returns:
- the dialog title for the sitemap entry editor
-
getForbiddenUrlNames
java.util.List<java.lang.String> getForbiddenUrlNames()
Returns the URL names which the new URL name of the entry must not be equal to.- Returns:
- a list of forbidden URL names
-
getId
org.opencms.util.CmsUUID getId()
Returns the structure id of the resource being edited.- Returns:
- the structure id of the resource being edited
-
getInheritedProperty
org.opencms.gwt.shared.property.CmsClientProperty getInheritedProperty(java.lang.String name)
Returns an inherited property value.This is the value that the resource being edited would inherit if it didn't define its own value for that property.
- Parameters:
name
- the name of the property- Returns:
- the inherited property
-
getModeClass
java.lang.String getModeClass()
Returns the class name which should be added when displaying resource info boxes.- Returns:
- the class name to use for displaying resource info boxes
-
getName
java.lang.String getName()
Returns the URL name with which the sitemap entry editor should be initialized.- Returns:
- the initial URL name
-
getOwnProperties
java.util.Map<java.lang.String,org.opencms.gwt.shared.property.CmsClientProperty> getOwnProperties()
Returns the properties of the resource being edited.- Returns:
- the properties of the resource being edited
-
getPageInfo
org.opencms.gwt.shared.CmsListInfoBean getPageInfo()
Returns the page info bean.- Returns:
- the page info bean
-
getPath
java.lang.String getPath()
Gets the path of the resource being edited.- Returns:
- the path of the resource being edited
-
getPossibleTemplates
java.util.Map<java.lang.String,org.opencms.gwt.shared.property.CmsClientTemplateBean> getPossibleTemplates()
Returns a map of beans representing the selectable templates.- Returns:
- a map of selectable templates
-
handleSubmit
void handleSubmit(java.lang.String newUrlName, java.lang.String vfsPath, java.util.List<org.opencms.gwt.shared.property.CmsPropertyModification> propertyChanges, boolean editedName, CmsReloadMode reloadMode)
Handles the submit action for the sitemap entry editor.- Parameters:
newUrlName
- the new url namevfsPath
- the new vfs pathpropertyChanges
- the property changeseditedName
- if true, the URL name has been editedreloadMode
- the information about which entry should reloaded
-
hasEditableName
boolean hasEditableName()
Returns if the handled entry has an editable name.- Returns:
true
if the handled entry has an editable name
-
isFolder
boolean isFolder()
Checks if the resource being edited is a folder.- Returns:
- true if the resource being edited is a folder
-
isHiddenProperty
boolean isHiddenProperty(java.lang.String key)
Checks whether the property with the given name should be hidden.- Parameters:
key
- the property name- Returns:
- true if the property should be hidden
-
isSimpleMode
boolean isSimpleMode()
Should return true if the sitemap editor is running in simple mode.- Returns:
- true if the sitemap editor is running in simple mode
-
useAdeTemplates
boolean useAdeTemplates()
Returns true if the property editor should use only ADE templates.- Returns:
- true if the property editor should use only ADE templates
-
-