org.opencms.gwt.client.property

接口 I_CmsPropertyEditorHandler

所有已知实现类:

A_CmsSitemapEntryEditorHandler, CmsEditEntryHandler, CmsSimplePropertyEditorHandler, CmsUploadPropertyEditorHandler

public interface I_CmsPropertyEditorHandler

An interface for sitemap entry editor modes.

从以下版本开始:

8.0.0

方法概要

方法

限定符和类型	方法和说明
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.
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) 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,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.
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 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.

方法详细资料

getAllPropertyNames

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

Gets a list of the names of available properties.

返回:

a list of property names

getDefaultFileId

CmsUUID getDefaultFileId()

Returns the default file id, if available.

返回:

the default file id

getDefaultFileProperties

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

Returns the default file properties, if available.

返回:

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.

返回:

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.

返回:

a list of forbidden URL names

getId

CmsUUID getId()

Returns the structure id of the resource being edited.

返回:

the structure id of the resource being edited

getInheritedProperty

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.

参数:

name - the name of the property

返回:

the inherited property

getModeClass

java.lang.String getModeClass()

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

返回:

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.

返回:

the initial URL name

getOwnProperties

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

Returns the properties of the resource being edited.

返回:

the properties of the resource being edited

getPageInfo

CmsListInfoBean getPageInfo()

Returns the page info bean.

返回:

the page info bean

getPath

java.lang.String getPath()

Gets the path of the resource being edited.

返回:

the path of the resource being edited

getPossibleTemplates

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

Returns a map of beans representing the selectable templates.

返回:

a map of selectable templates

handleSubmit

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

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

reloadMode - the information about which entry should reloaded

hasEditableName

boolean hasEditableName()

Returns if the handled entry has an editable name.

返回:

true if the handled entry has an editable name

isFolder

boolean isFolder()

Checks if the resource being edited is a folder.

返回:

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.

参数:

key - the property name

返回:

true if the property should be hidden

isSimpleMode

boolean isSimpleMode()

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

返回:

true if the sitemap editor is running in simple mode

useAdeTemplates

boolean useAdeTemplates()

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

返回:

true if the property editor should use only ADE templates