org.opencms.gwt.client.ui.input.form

类 CmsBasicFormField

java.lang.Object

org.opencms.gwt.client.ui.input.form.CmsBasicFormField

所有已实现的接口:

I_CmsFormField

public class CmsBasicFormField
extends java.lang.Object
implements I_CmsFormField

Basic implementation of the I_CmsFormField class.

从以下版本开始:

8.0.0

嵌套类概要

从接口继承的嵌套类/接口 org.opencms.gwt.client.ui.input.I_CmsFormField

I_CmsFormField.LayoutData, I_CmsFormField.ValidationStatus

构造器概要

构造器

构造器和说明
CmsBasicFormField(java.lang.String id, java.lang.String description, java.lang.String label, java.lang.Object defaultValue, I_CmsFormWidget widget) Constructs a new form field.

方法概要

方法

限定符和类型	方法和说明
void	bind(I_CmsStringModel model) Binds a model object to the form field.
static CmsBasicFormField	createField(CmsXmlContentProperty propertyConfig) Utility method for creating a single basic form field from an id and a property configuration.
static CmsBasicFormField	createField(CmsXmlContentProperty propertyConfig, java.util.Map<java.lang.String,java.lang.String> additionalParams) Utility method for creating a basic form field.
static CmsBasicFormField	createField(CmsXmlContentProperty propertyConfig, java.lang.String fieldId, I_CmsFormWidgetMultiFactory factory, java.util.Map<java.lang.String,java.lang.String> additionalParams, boolean alwaysAllowEmpty) Utility method for creating a single basic form field from an id and a property configuration.
static java.util.Map<java.lang.String,I_CmsFormField>	createFields(java.util.Collection<CmsXmlContentProperty> propertyConfigurations) Creates a map of fields from a map of field configurations.
boolean	equals(java.lang.Object o)
java.lang.Object	getDefaultValue() Returns the default value for the form field.
java.lang.String	getDescription() The description of the form field, or null if there is no description.
java.lang.String	getId() Returns the id of this form field, or null if the form field id has not been set.
java.lang.String	getLabel() The label of the form field, or null if there is no label.
I_CmsFormField.LayoutData	getLayoutData() Returns the layout data for this field.
I_CmsStringModel	getModel() Returns the model object for this field.
java.lang.String	getModelId() Returns the model id.
java.lang.String	getModelValue() Returns the model value.
I_CmsFormField.ValidationStatus	getValidationStatus() Returns the validation status of this form field.
I_CmsValidator	getValidator() Returns the validator for this form field, or null if the field has no validator.
I_CmsFormWidget	getWidget() Returns the widget used by this form field.
int	hashCode()
void	setId(java.lang.String id) Sets the id of this form field.
void	setValidationStatus(I_CmsFormField.ValidationStatus validationStatus) Updates the validation status of this form field.
void	setValidator(I_CmsValidator validator) Sets the validator for this form field.
void	unbind() Removes the binding to this form field's model.

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

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

构造器详细资料

CmsBasicFormField

public CmsBasicFormField(java.lang.String id,
                 java.lang.String description,
                 java.lang.String label,
                 java.lang.Object defaultValue,
                 I_CmsFormWidget widget)

Constructs a new form field.

参数:

id - the id of the form field

description - the description of the form field

label - the label of the form field

defaultValue - the default value of the form field

widget - the widget of the form field

方法详细资料

createField

public static CmsBasicFormField createField(CmsXmlContentProperty propertyConfig)

Utility method for creating a single basic form field from an id and a property configuration.

参数:

propertyConfig - the configuration of the property

返回:

the newly created form field

createField

public static CmsBasicFormField createField(CmsXmlContentProperty propertyConfig,
                            java.util.Map<java.lang.String,java.lang.String> additionalParams)

Utility method for creating a basic form field.

参数:

propertyConfig - the property configuration

additionalParams - the additional parameters

返回:

the newly created form fields

createField

public static CmsBasicFormField createField(CmsXmlContentProperty propertyConfig,
                            java.lang.String fieldId,
                            I_CmsFormWidgetMultiFactory factory,
                            java.util.Map<java.lang.String,java.lang.String> additionalParams,
                            boolean alwaysAllowEmpty)

Utility method for creating a single basic form field from an id and a property configuration.

参数:

propertyConfig - the configuration of the property

fieldId - the field id

factory - a factory for creating form widgets

additionalParams -

alwaysAllowEmpty -

返回:

the newly created form field

createFields

public static java.util.Map<java.lang.String,I_CmsFormField> createFields(java.util.Collection<CmsXmlContentProperty> propertyConfigurations)

Creates a map of fields from a map of field configurations.

参数:

propertyConfigurations - the map of field configurations

返回:

a map of form fields

bind

public void bind(I_CmsStringModel model)

从接口复制的说明: I_CmsFormField

Binds a model object to the form field.

指定者:

bind 在接口中 I_CmsFormField

参数:

model - the model object

另请参阅:

I_CmsFormField.bind(org.opencms.gwt.client.ui.input.I_CmsStringModel)

equals

public boolean equals(java.lang.Object o)

覆盖:

equals 在类中 java.lang.Object

另请参阅:

Object.equals(java.lang.Object)

getDefaultValue

public java.lang.Object getDefaultValue()

从接口复制的说明: I_CmsFormField

Returns the default value for the form field.

指定者:

getDefaultValue 在接口中 I_CmsFormField

返回:

the default value for the form field

另请参阅:

I_CmsFormField.getDefaultValue()

getDescription

public java.lang.String getDescription()

从接口复制的说明: I_CmsFormField

The description of the form field, or null if there is no description.

指定者:

getDescription 在接口中 I_CmsFormField

返回:

a description string or null

另请参阅:

I_CmsFormField.getDescription()

getId

public java.lang.String getId()

从接口复制的说明: I_CmsFormField

Returns the id of this form field, or null if the form field id has not been set. If a form field without an id is added to a form, typically it will receive a synthetic id.

指定者:

getId 在接口中 I_CmsFormField

返回:

the id

另请参阅:

I_CmsFormField.getId()

getLabel

public java.lang.String getLabel()

从接口复制的说明: I_CmsFormField

The label of the form field, or null if there is no label.

指定者:

getLabel 在接口中 I_CmsFormField

返回:

a label or null

另请参阅:

I_CmsFormField.getLabel()

getLayoutData

public I_CmsFormField.LayoutData getLayoutData()

从接口复制的说明: I_CmsFormField

Returns the layout data for this field.

指定者:

getLayoutData 在接口中 I_CmsFormField

返回:

the layout data for this field

另请参阅:

I_CmsFormField.getLayoutData()

getModel

public I_CmsStringModel getModel()

从接口复制的说明: I_CmsFormField

Returns the model object for this field.

指定者:

getModel 在接口中 I_CmsFormField

返回:

the model used for this field

另请参阅:

I_CmsFormField.getModel()

getModelId

public java.lang.String getModelId()

从接口复制的说明: I_CmsFormField

Returns the model id.

指定者:

getModelId 在接口中 I_CmsFormField

返回:

the model id

另请参阅:

I_CmsFormField.getModelId()

getModelValue

public java.lang.String getModelValue()

从接口复制的说明: I_CmsFormField

Returns the model value.

指定者:

getModelValue 在接口中 I_CmsFormField

返回:

the model value

另请参阅:

I_CmsFormField.getModelValue()

getValidationStatus

public I_CmsFormField.ValidationStatus getValidationStatus()

从接口复制的说明: I_CmsFormField

Returns the validation status of this form field.

If the field has no validator, this should always return valid.

指定者:

getValidationStatus 在接口中 I_CmsFormField

返回:

the validation status

另请参阅:

I_CmsFormField.getValidationStatus()

getValidator

public I_CmsValidator getValidator()

从接口复制的说明: I_CmsFormField

Returns the validator for this form field, or null if the field has no validator.

指定者:

getValidator 在接口中 I_CmsFormField

返回:

a validator or null

另请参阅:

I_CmsFormField.getValidator()

getWidget

public I_CmsFormWidget getWidget()

从接口复制的说明: I_CmsFormField

Returns the widget used by this form field.

指定者:

getWidget 在接口中 I_CmsFormField

返回:

a widget

另请参阅:

I_CmsFormField.getWidget()

hashCode

public int hashCode()

覆盖:

hashCode 在类中 java.lang.Object

另请参阅:

Object.hashCode()

setId

public void setId(java.lang.String id)

从接口复制的说明: I_CmsFormField

Sets the id of this form field.

指定者:

setId 在接口中 I_CmsFormField

参数:

id - the new id

另请参阅:

I_CmsFormField.setId(java.lang.String)

setValidationStatus

public void setValidationStatus(I_CmsFormField.ValidationStatus validationStatus)

从接口复制的说明: I_CmsFormField

Updates the validation status of this form field.

This will only have an effect if the field has a validator.

指定者:

setValidationStatus 在接口中 I_CmsFormField

参数:

validationStatus - the new validation status

另请参阅:

I_CmsFormField.setValidationStatus(org.opencms.gwt.client.ui.input.I_CmsFormField.ValidationStatus)

setValidator

public void setValidator(I_CmsValidator validator)

从接口复制的说明: I_CmsFormField

Sets the validator for this form field.

指定者:

setValidator 在接口中 I_CmsFormField

参数:

validator - the new validator

另请参阅:

I_CmsFormField.setValidator(org.opencms.gwt.client.validation.I_CmsValidator)

unbind

public void unbind()

从接口复制的说明: I_CmsFormField

Removes the binding to this form field's model.

指定者:

unbind 在接口中 I_CmsFormField

另请参阅:

I_CmsFormField.unbind()