Package org.opencms.ade.sitemap.client.edit

Class CmsEditEntryHandler

java.lang.Object

org.opencms.ade.sitemap.client.edit.A_CmsSitemapEntryEditorHandler

org.opencms.ade.sitemap.client.edit.CmsEditEntryHandler

All Implemented Interfaces:

I_CmsPropertyEditorHandler

public class CmsEditEntryHandler
extends A_CmsSitemapEntryEditorHandler

The mode handler for the 'edit entry' mode of the sitemap entry editor.

Since:

8.0.0

Field Summary

Fields inherited from class org.opencms.ade.sitemap.client.edit.A_CmsSitemapEntryEditorHandler

m_controller, m_entry

Constructor Summary

Constructors

Constructor	Description
CmsEditEntryHandler(CmsSitemapController controller, org.opencms.ade.sitemap.shared.CmsClientSitemapEntry entry, boolean isSimpleMode)	Creates a new instance of this class.

Method Summary

Modifier and Type	Method	Description
List<String>	getAllPropertyNames()	Gets a list of the names of available properties.
org.opencms.util.CmsUUID	getDefaultFileId()	Returns the default file id, if available.
String	getDefaultFilePath()	Gets the default file path, if available.
Map<String,org.opencms.gwt.shared.property.CmsClientProperty>	getDefaultFileProperties()	Returns the default file properties, if available.
String	getDialogTitle()	Returns the text which should be used for the title of the sitemap entry editor dialog.
protected org.opencms.ade.sitemap.shared.CmsClientSitemapEntry	getEntry()	Gets the edited sitemap entry.
List<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(String name)	Gets the property object which would be inherited by a sitemap entry.
String	getModeClass()	Returns the class name which should be added when displaying resource info boxes.
Map<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.
String	getPath()	Gets the path of the resource being edited.
protected String	getPath(String urlName)	Returns the path for the given URL name.
Map<String,org.opencms.gwt.shared.property.CmsClientTemplateBean>	getPossibleTemplates()	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 reloadStatus)	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(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.
void	setDefaultFilePath(String defaultFilePath)	Sets the default file path
void	setPageInfo(org.opencms.gwt.shared.CmsListInfoBean pageInfo)	Sets the page info bean.
boolean	useAdeTemplates()	Returns true if the property editor should use only ADE templates.

Methods inherited from class org.opencms.ade.sitemap.client.edit.A_CmsSitemapEntryEditorHandler

getName

Methods inherited from class java.lang.Object

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

Constructor Details

CmsEditEntryHandler

public CmsEditEntryHandler(CmsSitemapController controller,
 org.opencms.ade.sitemap.shared.CmsClientSitemapEntry entry,
 boolean isSimpleMode)

Creates a new instance of this class.

Parameters:

controller - the sitemap controller for this mode

entry - the sitemap entry for this mode

isSimpleMode - true if the sitemap entry editor is in simple mode

Method Details

getAllPropertyNames

public List<String> getAllPropertyNames()

Description copied from interface: I_CmsPropertyEditorHandler

Gets a list of the names of available properties.

Returns:

a list of property names

See Also:

• I_CmsPropertyEditorHandler.getAllPropertyNames()

getDefaultFileId

public org.opencms.util.CmsUUID getDefaultFileId()

Description copied from interface: I_CmsPropertyEditorHandler

Returns the default file id, if available.

Returns:

the default file id

See Also:

• I_CmsPropertyEditorHandler.getDefaultFileId()

getDefaultFilePath

public String getDefaultFilePath()

Description copied from interface: I_CmsPropertyEditorHandler

Gets the default file path, if available.

Returns:

the default file path

See Also:

• I_CmsPropertyEditorHandler.getDefaultFilePath()

getDefaultFileProperties

public Map<String,org.opencms.gwt.shared.property.CmsClientProperty> getDefaultFileProperties()

Description copied from interface: I_CmsPropertyEditorHandler

Returns the default file properties, if available.

Returns:

the default file properties

See Also:

• I_CmsPropertyEditorHandler.getDefaultFileProperties()

getDialogTitle

public String getDialogTitle()

Description copied from interface: I_CmsPropertyEditorHandler

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

See Also:

• I_CmsPropertyEditorHandler.getDialogTitle()

getForbiddenUrlNames

public List<String> getForbiddenUrlNames()

Description copied from interface: I_CmsPropertyEditorHandler

Returns the URL names which the new URL name of the entry must not be equal to.

Returns:

a list of forbidden URL names

See Also:

• I_CmsPropertyEditorHandler.getForbiddenUrlNames()

getId

public org.opencms.util.CmsUUID getId()

Description copied from interface: I_CmsPropertyEditorHandler

Returns the structure id of the resource being edited.

Returns:

the structure id of the resource being edited

See Also:

• I_CmsPropertyEditorHandler.getId()

getInheritedProperty

public org.opencms.gwt.shared.property.CmsClientProperty getInheritedProperty(String name)

Gets the property object which would be inherited by a sitemap entry.

Parameters:

name - the name of the property

Returns:

the property object which would be inherited

getModeClass

public String getModeClass()

Description copied from interface: I_CmsPropertyEditorHandler

Returns the class name which should be added when displaying resource info boxes.

Returns:

the class name to use for displaying resource info boxes

See Also:

• I_CmsPropertyEditorHandler.getModeClass()

getOwnProperties

public Map<String,org.opencms.gwt.shared.property.CmsClientProperty> getOwnProperties()

Description copied from interface: I_CmsPropertyEditorHandler

Returns the properties of the resource being edited.

Returns:

the properties of the resource being edited

See Also:

• I_CmsPropertyEditorHandler.getOwnProperties()

getPageInfo

public org.opencms.gwt.shared.CmsListInfoBean getPageInfo()

Description copied from interface: I_CmsPropertyEditorHandler

Returns the page info bean.

Returns:

the page info bean

See Also:

• I_CmsPropertyEditorHandler.getPageInfo()

getPath

public String getPath()

Description copied from interface: I_CmsPropertyEditorHandler

Gets the path of the resource being edited.

Returns:

the path of the resource being edited

See Also:

• I_CmsPropertyEditorHandler.getPath()

getPossibleTemplates

public Map<String,org.opencms.gwt.shared.property.CmsClientTemplateBean> getPossibleTemplates()

Description copied from interface: I_CmsPropertyEditorHandler

Returns a map of beans representing the selectable templates.

Returns:

a map of selectable templates

See Also:

• I_CmsPropertyEditorHandler.getPossibleTemplates()

handleSubmit

public void handleSubmit(String newUrlName,
 String vfsPath,
 List<org.opencms.gwt.shared.property.CmsPropertyModification> propertyChanges,
 boolean editedName,
 CmsReloadMode reloadStatus)

Description copied from interface: I_CmsPropertyEditorHandler

Handles the submit action for the sitemap entry editor.

Parameters:

newUrlName - the new url name

vfsPath - the new vfs path

propertyChanges - the property changes

editedName - if true, the URL name has been edited

reloadStatus - the information about which entry should reloaded

See Also:

• I_CmsPropertyEditorHandler.handleSubmit(java.lang.String, java.lang.String, java.util.List, boolean, org.opencms.gwt.client.property.CmsReloadMode)

hasEditableName

public boolean hasEditableName()

Description copied from interface: I_CmsPropertyEditorHandler

Returns if the handled entry has an editable name.

Returns:

true if the handled entry has an editable name

See Also:

• I_CmsPropertyEditorHandler.hasEditableName()

isFolder

public boolean isFolder()

Description copied from interface: I_CmsPropertyEditorHandler

Checks if the resource being edited is a folder.

Returns:

true if the resource being edited is a folder

See Also:

• I_CmsPropertyEditorHandler.isFolder()

isHiddenProperty

public boolean isHiddenProperty(String key)

Description copied from interface: I_CmsPropertyEditorHandler

Checks whether the property with the given name should be hidden.

Parameters:

key - the property name

Returns:

true if the property should be hidden

See Also:

• I_CmsPropertyEditorHandler.isHiddenProperty(java.lang.String)

isSimpleMode

public boolean isSimpleMode()

Description copied from interface: I_CmsPropertyEditorHandler

Should return true if the sitemap editor is running in simple mode.

Returns:

true if the sitemap editor is running in simple mode

See Also:

• I_CmsPropertyEditorHandler.isSimpleMode()

setDefaultFilePath

public void setDefaultFilePath(String defaultFilePath)

Sets the default file path

Parameters:

defaultFilePath - the new default file path

setPageInfo

public void setPageInfo(org.opencms.gwt.shared.CmsListInfoBean pageInfo)

Sets the page info bean.

Parameters:

pageInfo - the page info bean

useAdeTemplates

public boolean useAdeTemplates()

Description copied from interface: I_CmsPropertyEditorHandler

Returns true if the property editor should use only ADE templates.

Returns:

true if the property editor should use only ADE templates

See Also:

• I_CmsPropertyEditorHandler.useAdeTemplates()

getEntry

protected org.opencms.ade.sitemap.shared.CmsClientSitemapEntry getEntry()

Gets the edited sitemap entry.

Returns:

the edited sitemap entry

getPath

protected String getPath(String urlName)

Returns the path for the given URL name.

Parameters:

urlName - the URL name to create the path for

Returns:

the new path for the given URL name