org.opencms.gwt.client.property

类 A_CmsPropertyEditor

java.lang.Object

org.opencms.gwt.client.property.A_CmsPropertyEditor

所有已实现的接口:

I_CmsFormWidgetMultiFactory

直接已知子类:

CmsNavModePropertyEditor, CmsSimplePropertyEditor, CmsVfsModePropertyEditor

public abstract class A_CmsPropertyEditor
extends java.lang.Object
implements I_CmsFormWidgetMultiFactory

The abstract base class for dialogs to edit properties.

从以下版本开始:

8.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	FIELD_LINK The field id for the link selector widget.
static java.lang.String	FIELD_URLNAME The field id of the "url name" form field.
protected java.util.List<java.lang.String>	m_allProps The list of all property names.
protected java.lang.String	m_disabledReason The reason to disable the form input fields.
protected CmsForm	m_form The form containing the fields.
protected I_CmsPropertyEditorHandler	m_handler The handler for this sitemap entry editor.
protected java.util.Map<java.lang.String,CmsXmlContentProperty>	m_propertyConfig The configuration of the properties.
protected I_CmsFormField	m_urlNameField The URL name field.
protected CmsDefaultStringModel	m_urlNameModel The model for the URL name field.

构造器概要

构造器

构造器和说明
A_CmsPropertyEditor(java.util.Map<java.lang.String,CmsXmlContentProperty> propertyConfig, I_CmsPropertyEditorHandler handler) Creates a new sitemap entry editor.

方法概要

方法

限定符和类型	方法和说明
protected void	addSpecialFields() Method to add special, non-property fields.
protected abstract void	buildFields() Builds and renders the fields for the properties.
static void	checkWidgetRequirements(java.lang.String key, I_CmsFormWidget widget) Checks whether a widget can be used in the sitemap entry editor, and throws an exception otherwise.
I_CmsFormWidget	createFormWidget(java.lang.String key, java.util.Map<java.lang.String,java.lang.String> widgetParams) Creates a new form widget.
protected CmsBasicFormField	createUrlNameField() Creates the text field for editing the URL name.
void	disableInput(java.lang.String disabledReason) Disables all input to the form.
CmsForm	getForm() Gets the form for the properties.
protected java.lang.String	getTitle(java.util.Map<java.lang.String,java.lang.String> fieldValues) Gets the title from a map of field values.
protected CmsDefaultStringModel	getUrlNameModel(java.lang.String urlName) Lazily creates the model object for the URL name field.
void	initializeWidgets(CmsPopup dialog) Initializes the widgets for editing the properties.
protected java.lang.String	message(java.lang.String key, java.lang.Object... args) Returns a localized message from the message bundle.
protected void	setGhostValue(I_CmsFormField field, java.lang.String value, boolean ghostMode) Sets the ghost value for a form field if its normal value is empty and the field's widget supports ghost values.
void	setPropertyNames(java.util.List<java.lang.String> propertyNames) Sets the names of properties which can be edited.
protected abstract void	setupFieldContainer() Sets up the widget which will contain the input fields for the properties.
protected void	setUrlNameField(java.lang.String urlName) Sets the contents of the URL name field in the form.
protected void	showUrlNameError(java.lang.String message) Shows an error message next to the URL name input field.

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

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

字段详细资料

FIELD_LINK

public static final java.lang.String FIELD_LINK

The field id for the link selector widget.

另请参阅:

常量字段值

FIELD_URLNAME

public static final java.lang.String FIELD_URLNAME

The field id of the "url name" form field.

另请参阅:

常量字段值

m_allProps

protected java.util.List<java.lang.String> m_allProps

The list of all property names.

m_disabledReason

protected java.lang.String m_disabledReason

The reason to disable the form input fields.

m_form

protected CmsForm m_form

The form containing the fields.

m_handler

protected I_CmsPropertyEditorHandler m_handler

The handler for this sitemap entry editor.

m_propertyConfig

protected java.util.Map<java.lang.String,CmsXmlContentProperty> m_propertyConfig

The configuration of the properties.

m_urlNameField

protected I_CmsFormField m_urlNameField

The URL name field.

m_urlNameModel

protected CmsDefaultStringModel m_urlNameModel

The model for the URL name field.

构造器详细资料

A_CmsPropertyEditor

public A_CmsPropertyEditor(java.util.Map<java.lang.String,CmsXmlContentProperty> propertyConfig,
                   I_CmsPropertyEditorHandler handler)

Creates a new sitemap entry editor.

参数:

handler - the handler

propertyConfig - the property configuration

方法详细资料

checkWidgetRequirements

public static void checkWidgetRequirements(java.lang.String key,
                           I_CmsFormWidget widget)

Checks whether a widget can be used in the sitemap entry editor, and throws an exception otherwise.

参数:

key - the widget key

widget - the created widget

createFormWidget

public I_CmsFormWidget createFormWidget(java.lang.String key,
                               java.util.Map<java.lang.String,java.lang.String> widgetParams)

从接口复制的说明: I_CmsFormWidgetMultiFactory

Creates a new form widget.

指定者:

createFormWidget 在接口中 I_CmsFormWidgetMultiFactory

参数:

key - the key identifying the widget type

widgetParams - the widget initialization parameters

返回:

the created form widget

另请参阅:

I_CmsFormWidgetMultiFactory.createFormWidget(java.lang.String, java.util.Map)

disableInput

public void disableInput(java.lang.String disabledReason)

Disables all input to the form.

参数:

disabledReason - the reason to display to the user

getForm

public CmsForm getForm()

Gets the form for the properties.

返回:

the property form

initializeWidgets

public void initializeWidgets(CmsPopup dialog)

Initializes the widgets for editing the properties.

参数:

dialog - the dialog which the property editor is part of

setPropertyNames

public void setPropertyNames(java.util.List<java.lang.String> propertyNames)

Sets the names of properties which can be edited.

参数:

propertyNames - the property names

addSpecialFields

protected void addSpecialFields()

Method to add special, non-property fields.

buildFields

protected abstract void buildFields()

Builds and renders the fields for the properties.

createUrlNameField

protected CmsBasicFormField createUrlNameField()

Creates the text field for editing the URL name.

返回:

the newly created form field

getTitle

protected java.lang.String getTitle(java.util.Map<java.lang.String,java.lang.String> fieldValues)

Gets the title from a map of field values.

参数:

fieldValues - the map of field values

返回:

the title

getUrlNameModel

protected CmsDefaultStringModel getUrlNameModel(java.lang.String urlName)

Lazily creates the model object for the URL name field.

参数:

urlName - the initial value for the URL name

返回:

the model object for the URL name field

message

protected java.lang.String message(java.lang.String key,
                       java.lang.Object... args)

Returns a localized message from the message bundle.

参数:

key - the message key

args - the message parameters

返回:

the localized message

setGhostValue

protected void setGhostValue(I_CmsFormField field,
                 java.lang.String value,
                 boolean ghostMode)

Sets the ghost value for a form field if its normal value is empty and the field's widget supports ghost values.

参数:

field - the form field

value - the ghost value to set

ghostMode - if true, sets the widget to ghost mode

setupFieldContainer

protected abstract void setupFieldContainer()

Sets up the widget which will contain the input fields for the properties.

setUrlNameField

protected void setUrlNameField(java.lang.String urlName)

Sets the contents of the URL name field in the form.

参数:

urlName - the new URL name

showUrlNameError

protected void showUrlNameError(java.lang.String message)

Shows an error message next to the URL name input field.

参数:

message - the message which should be displayed, or null if no message should be displayed