Class CmsLocaleComparePropertyHandler
java.lang.Object
org.opencms.ade.sitemap.client.edit.CmsLocaleComparePropertyHandler
- All Implemented Interfaces:
I_CmsPropertyEditorHandler
Property submission handler for the sitemap editor's locale comparison mode.
-
Constructor Summary
ConstructorDescriptionCmsLocaleComparePropertyHandler
(org.opencms.ade.sitemap.shared.CmsLocaleComparePropertyData data) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionGets a list of the names of available properties.org.opencms.util.CmsUUID
Returns the default file id, if available.Returns the default file properties, if available.Returns the text which should be used for the title of the sitemap entry editor dialog.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
(String name) Returns an inherited property value.Returns the class name which should be added when displaying resource info boxes.getName()
Returns the URL name with which the sitemap entry editor should be initialized.Returns the properties of the resource being edited.org.opencms.gwt.shared.CmsListInfoBean
Returns the page info bean.getPath()
Gets the path of the resource being edited.Returns a map of beans representing the selectable templates.void
handleSubmit
(String newUrlName, String vfsPath, List<org.opencms.gwt.shared.property.CmsPropertyModification> propertyChanges, boolean editedName, CmsReloadMode reloadMode) Handles the submit action for the sitemap entry editor.boolean
Returns if the handled entry has an editable name.boolean
isFolder()
Checks if the resource being edited is a folder.boolean
isHiddenProperty
(String key) Checks whether the property with the given name should be hidden.boolean
Should return true if the sitemap editor is running in simple mode.void
setPageInfo
(org.opencms.gwt.shared.CmsListInfoBean pageInfo) Sets the page information.boolean
Returns true if the property editor should use only ADE templates.
-
Constructor Details
-
Method Details
-
getAllPropertyNames
Description copied from interface:I_CmsPropertyEditorHandler
Gets a list of the names of available properties.- Specified by:
getAllPropertyNames
in interfaceI_CmsPropertyEditorHandler
- Returns:
- a list of property names
- See Also:
-
getDefaultFileId
Description copied from interface:I_CmsPropertyEditorHandler
Returns the default file id, if available.- Specified by:
getDefaultFileId
in interfaceI_CmsPropertyEditorHandler
- Returns:
- the default file id
- See Also:
-
getDefaultFileProperties
Description copied from interface:I_CmsPropertyEditorHandler
Returns the default file properties, if available.- Specified by:
getDefaultFileProperties
in interfaceI_CmsPropertyEditorHandler
- Returns:
- the default file properties
- See Also:
-
getDialogTitle
Description copied from interface:I_CmsPropertyEditorHandler
Returns the text which should be used for the title of the sitemap entry editor dialog.- Specified by:
getDialogTitle
in interfaceI_CmsPropertyEditorHandler
- Returns:
- the dialog title for the sitemap entry editor
- See Also:
-
getForbiddenUrlNames
Description copied from interface:I_CmsPropertyEditorHandler
Returns the URL names which the new URL name of the entry must not be equal to.- Specified by:
getForbiddenUrlNames
in interfaceI_CmsPropertyEditorHandler
- Returns:
- a list of forbidden URL names
- See Also:
-
getId
Description copied from interface:I_CmsPropertyEditorHandler
Returns the structure id of the resource being edited.- Specified by:
getId
in interfaceI_CmsPropertyEditorHandler
- Returns:
- the structure id of the resource being edited
- See Also:
-
getInheritedProperty
Description copied from interface:I_CmsPropertyEditorHandler
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.
- Specified by:
getInheritedProperty
in interfaceI_CmsPropertyEditorHandler
- Parameters:
name
- the name of the property- Returns:
- the inherited property
- See Also:
-
getModeClass
Description copied from interface:I_CmsPropertyEditorHandler
Returns the class name which should be added when displaying resource info boxes.- Specified by:
getModeClass
in interfaceI_CmsPropertyEditorHandler
- Returns:
- the class name to use for displaying resource info boxes
- See Also:
-
getName
Description copied from interface:I_CmsPropertyEditorHandler
Returns the URL name with which the sitemap entry editor should be initialized.- Specified by:
getName
in interfaceI_CmsPropertyEditorHandler
- Returns:
- the initial URL name
- See Also:
-
getOwnProperties
Description copied from interface:I_CmsPropertyEditorHandler
Returns the properties of the resource being edited.- Specified by:
getOwnProperties
in interfaceI_CmsPropertyEditorHandler
- Returns:
- the properties of the resource being edited
- See Also:
-
getPageInfo
Description copied from interface:I_CmsPropertyEditorHandler
Returns the page info bean.- Specified by:
getPageInfo
in interfaceI_CmsPropertyEditorHandler
- Returns:
- the page info bean
- See Also:
-
getPath
Description copied from interface:I_CmsPropertyEditorHandler
Gets the path of the resource being edited.- Specified by:
getPath
in interfaceI_CmsPropertyEditorHandler
- Returns:
- the path of the resource being edited
- See Also:
-
getPossibleTemplates
Description copied from interface:I_CmsPropertyEditorHandler
Returns a map of beans representing the selectable templates.- Specified by:
getPossibleTemplates
in interfaceI_CmsPropertyEditorHandler
- Returns:
- a map of selectable templates
- See Also:
-
handleSubmit
public void handleSubmit(String newUrlName, String vfsPath, List<org.opencms.gwt.shared.property.CmsPropertyModification> propertyChanges, boolean editedName, CmsReloadMode reloadMode) Description copied from interface:I_CmsPropertyEditorHandler
Handles the submit action for the sitemap entry editor.- Specified by:
handleSubmit
in interfaceI_CmsPropertyEditorHandler
- 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- See Also:
-
hasEditableName
Description copied from interface:I_CmsPropertyEditorHandler
Returns if the handled entry has an editable name.- Specified by:
hasEditableName
in interfaceI_CmsPropertyEditorHandler
- Returns:
true
if the handled entry has an editable name- See Also:
-
isFolder
Description copied from interface:I_CmsPropertyEditorHandler
Checks if the resource being edited is a folder.- Specified by:
isFolder
in interfaceI_CmsPropertyEditorHandler
- Returns:
- true if the resource being edited is a folder
- See Also:
-
isHiddenProperty
Description copied from interface:I_CmsPropertyEditorHandler
Checks whether the property with the given name should be hidden.- Specified by:
isHiddenProperty
in interfaceI_CmsPropertyEditorHandler
- Parameters:
key
- the property name- Returns:
- true if the property should be hidden
- See Also:
-
isSimpleMode
Description copied from interface:I_CmsPropertyEditorHandler
Should return true if the sitemap editor is running in simple mode.- Specified by:
isSimpleMode
in interfaceI_CmsPropertyEditorHandler
- Returns:
- true if the sitemap editor is running in simple mode
- See Also:
-
useAdeTemplates
Description copied from interface:I_CmsPropertyEditorHandler
Returns true if the property editor should use only ADE templates.- Specified by:
useAdeTemplates
in interfaceI_CmsPropertyEditorHandler
- Returns:
- true if the property editor should use only ADE templates
- See Also:
-