org.opencms.ade.sitemap.client.edit

类 CmsEditEntryHandler

java.lang.Object

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

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

所有已实现的接口:

I_CmsPropertyEditorHandler

public class CmsEditEntryHandler
extends A_CmsSitemapEntryEditorHandler

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

从以下版本开始:

8.0.0

字段概要

从类继承的字段 org.opencms.ade.sitemap.client.edit.A_CmsSitemapEntryEditorHandler

m_controller, m_entry

构造器概要

构造器

构造器和说明
CmsEditEntryHandler(CmsSitemapController controller, CmsClientSitemapEntry entry, boolean isSimpleMode) Creates a new instance of this class.

方法概要

方法

限定符和类型	方法和说明
java.util.List<java.lang.String>	getAllPropertyNames() Gets a list of the names of available properties.
CmsUUID	getDefaultFileId() Returns the default file id, if available.
java.util.Map<java.lang.String,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.
protected CmsClientSitemapEntry	getEntry() Gets the edited sitemap entry.
java.util.List<java.lang.String>	getForbiddenUrlNames() Returns the URL names which the new URL name of the entry must not be equal to.
CmsUUID	getId() Returns the structure id of the resource being edited.
CmsClientProperty	getInheritedProperty(java.lang.String name) Gets the property object which would be inherited by a sitemap entry.
java.lang.String	getModeClass() Returns the class name which should be added when displaying resource info boxes.
java.util.Map<java.lang.String,CmsClientProperty>	getOwnProperties() Returns the properties of the resource being edited.
CmsListInfoBean	getPageInfo() Returns the page info bean.
java.lang.String	getPath() Gets the path of the resource being edited.
protected java.lang.String	getPath(java.lang.String urlName) Returns the path for the given URL name.
java.util.Map<java.lang.String,CmsClientTemplateBean>	getPossibleTemplates() Returns a map of beans representing the selectable templates.
void	handleSubmit(java.lang.String newUrlName, java.lang.String vfsPath, java.util.List<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(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.
void	setPageInfo(CmsListInfoBean pageInfo) Sets the page info bean.
boolean	useAdeTemplates() Returns true if the property editor should use only ADE templates.

从类继承的方法 org.opencms.ade.sitemap.client.edit.A_CmsSitemapEntryEditorHandler

getName

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsEditEntryHandler

public CmsEditEntryHandler(CmsSitemapController controller,
                   CmsClientSitemapEntry entry,
                   boolean isSimpleMode)

Creates a new instance of this class.

参数:

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

方法详细资料

getAllPropertyNames

public java.util.List<java.lang.String> getAllPropertyNames()

从接口复制的说明: I_CmsPropertyEditorHandler

Gets a list of the names of available properties.

返回:

a list of property names

另请参阅:

I_CmsPropertyEditorHandler.getAllPropertyNames()

getDefaultFileId

public CmsUUID getDefaultFileId()

从接口复制的说明: I_CmsPropertyEditorHandler

Returns the default file id, if available.

返回:

the default file id

另请参阅:

I_CmsPropertyEditorHandler.getDefaultFileId()

getDefaultFileProperties

public java.util.Map<java.lang.String,CmsClientProperty> getDefaultFileProperties()

从接口复制的说明: I_CmsPropertyEditorHandler

Returns the default file properties, if available.

返回:

the default file properties

另请参阅:

I_CmsPropertyEditorHandler.getDefaultFileProperties()

getDialogTitle

public java.lang.String getDialogTitle()

从接口复制的说明: I_CmsPropertyEditorHandler

Returns the text which should be used for the title of the sitemap entry editor dialog.

返回:

the dialog title for the sitemap entry editor

另请参阅:

I_CmsPropertyEditorHandler.getDialogTitle()

getForbiddenUrlNames

public java.util.List<java.lang.String> getForbiddenUrlNames()

从接口复制的说明: I_CmsPropertyEditorHandler

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

返回:

a list of forbidden URL names

另请参阅:

I_CmsPropertyEditorHandler.getForbiddenUrlNames()

getId

public CmsUUID getId()

从接口复制的说明: I_CmsPropertyEditorHandler

Returns the structure id of the resource being edited.

返回:

the structure id of the resource being edited

另请参阅:

I_CmsPropertyEditorHandler.getId()

getInheritedProperty

public CmsClientProperty getInheritedProperty(java.lang.String name)

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

参数:

name - the name of the property

返回:

the property object which would be inherited

getModeClass

public java.lang.String getModeClass()

从接口复制的说明: I_CmsPropertyEditorHandler

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

返回:

the class name to use for displaying resource info boxes

另请参阅:

I_CmsPropertyEditorHandler.getModeClass()

getOwnProperties

public java.util.Map<java.lang.String,CmsClientProperty> getOwnProperties()

从接口复制的说明: I_CmsPropertyEditorHandler

Returns the properties of the resource being edited.

返回:

the properties of the resource being edited

另请参阅:

I_CmsPropertyEditorHandler.getOwnProperties()

getPageInfo

public CmsListInfoBean getPageInfo()

从接口复制的说明: I_CmsPropertyEditorHandler

Returns the page info bean.

返回:

the page info bean

另请参阅:

I_CmsPropertyEditorHandler.getPageInfo()

getPath

public java.lang.String getPath()

从接口复制的说明: I_CmsPropertyEditorHandler

Gets the path of the resource being edited.

返回:

the path of the resource being edited

另请参阅:

I_CmsPropertyEditorHandler.getPath()

getPossibleTemplates

public java.util.Map<java.lang.String,CmsClientTemplateBean> getPossibleTemplates()

从接口复制的说明: I_CmsPropertyEditorHandler

Returns a map of beans representing the selectable templates.

返回:

a map of selectable templates

另请参阅:

I_CmsPropertyEditorHandler.getPossibleTemplates()

handleSubmit

public void handleSubmit(java.lang.String newUrlName,
                java.lang.String vfsPath,
                java.util.List<CmsPropertyModification> propertyChanges,
                boolean editedName,
                CmsReloadMode reloadStatus)

从接口复制的说明: I_CmsPropertyEditorHandler

Handles the submit action for the sitemap entry editor.

参数:

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

另请参阅:

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

hasEditableName

public boolean hasEditableName()

从接口复制的说明: I_CmsPropertyEditorHandler

Returns if the handled entry has an editable name.

返回:

true if the handled entry has an editable name

另请参阅:

I_CmsPropertyEditorHandler.hasEditableName()

isFolder

public boolean isFolder()

从接口复制的说明: I_CmsPropertyEditorHandler

Checks if the resource being edited is a folder.

返回:

true if the resource being edited is a folder

另请参阅:

I_CmsPropertyEditorHandler.isFolder()

isHiddenProperty

public boolean isHiddenProperty(java.lang.String key)

从接口复制的说明: I_CmsPropertyEditorHandler

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

参数:

key - the property name

返回:

true if the property should be hidden

另请参阅:

I_CmsPropertyEditorHandler.isHiddenProperty(java.lang.String)

isSimpleMode

public boolean isSimpleMode()

从接口复制的说明: I_CmsPropertyEditorHandler

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

返回:

true if the sitemap editor is running in simple mode

另请参阅:

I_CmsPropertyEditorHandler.isSimpleMode()

setPageInfo

public void setPageInfo(CmsListInfoBean pageInfo)

Sets the page info bean.

参数:

pageInfo - the page info bean

useAdeTemplates

public boolean useAdeTemplates()

从接口复制的说明: I_CmsPropertyEditorHandler

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

返回:

true if the property editor should use only ADE templates

另请参阅:

I_CmsPropertyEditorHandler.useAdeTemplates()

getEntry

protected CmsClientSitemapEntry getEntry()

Gets the edited sitemap entry.

返回:

the edited sitemap entry

getPath

protected java.lang.String getPath(java.lang.String urlName)

Returns the path for the given URL name.

参数:

urlName - the URL name to create the path for

返回:

the new path for the given URL name