CmsForm

java.lang.Object
- org.opencms.gwt.client.ui.input.form.CmsForm

```
public class CmsForm
extends java.lang.Object
```
This class acts as a container for form fields.
It is also responsible for collecting and validating the values of the form fields.

从以下版本开始:

8.0.0

字段概要

字段
限定符和类型	字段和说明
`protected java.util.Set<java.lang.String>`	`m_editedFields` The set of fields which have been edited.
`protected java.util.Map<java.lang.String,I_CmsFormField>`	`m_fields` A map from field ids to the corresponding widgets.
`protected I_CmsFormHandler`	`m_formHandler` The form handler.
`protected boolean`	`m_pressedEnter` A flag which indicates whether the user has pressed enter in a widget.

构造器概要

构造器
构造器和说明
`CmsForm(A_CmsFormFieldPanel panel)` Creates a new form with an existing form widget container.
`CmsForm(boolean initPanel)` Creates a new form and optionally sets the form widget container to a simple form field panel.

方法概要

方法
限定符和类型	方法和说明
`void`	`addField(I_CmsFormField field, java.lang.String initialValue)` Adds a form field.
`void`	`addField(java.lang.String fieldGroup, I_CmsFormField formField)` Adds a form field to the form.
`void`	`addField(java.lang.String fieldGroup, I_CmsFormField formField, java.lang.String initialValue)` Adds a form field to the form and sets its initial value.
`void`	`addResetHandler(I_CmsFormResetHandler handler)` Adds a new form reset handler to the form.
`java.util.Map<java.lang.String,java.lang.String>`	`collectValues()` Collects all values from the form fields.
`protected java.lang.String`	`createValidatorConfig()` Returns the configuration string for the server side form validator.
`protected void`	`defaultHandleKeyPress(I_CmsFormField field, int keyCode)` The default keypress event handling function for form fields.
`protected void`	`defaultHandleValueChange(I_CmsFormField field, java.lang.String newValue, boolean inhibitValidation)` Default handler for value change events of form fields.
`java.util.Set<java.lang.String>`	`getEditedFields()` Returns the set of names of fields which have been edited by the user in the current form.
`I_CmsFormField`	`getField(java.lang.String id)` Returns the form field with a given id.
`java.util.Map<java.lang.String,I_CmsFormField>`	`getFields()` Returns a map of this form's field, indexed by their field name.
`protected java.util.Collection<I_CmsFormField>`	`getFieldsByModelId(java.lang.String modelId)` Gets the fields with a given model id.
`A_CmsFormFieldPanel`	`getWidget()` Returns the form widget container.
`void`	`handleSubmit(I_CmsFormSubmitHandler handler)` Passes this form's data to a form submit handler.
`boolean`	`noFieldsInvalid()` Checks that no fields are invalid.
`boolean`	`noFieldsInvalid(java.util.Collection<I_CmsFormField> fields)` Returns true if none of the fields in a collection are marked as invalid.
`void`	`removeGroup(java.lang.String group)` Removes all fields for the given group.
`void`	`render()` Renders all fields.
`void`	`renderGroup(java.lang.String group)` Renders the fields of the given group.
`void`	`setFormHandler(I_CmsFormHandler handler)` Sets the form handler for this form.
`void`	`setValidatorClass(java.lang.String validatorClass)` Sets the server-side form validator class to use.
`void`	`setWidget(A_CmsFormFieldPanel widget)` Sets the form widget container.
`protected void`	`updateFieldValidationStatus(I_CmsFormField field, CmsValidationResult result)` Updates the field validation status.
`protected void`	`updateFieldValidationStatus(java.lang.String fieldId, CmsValidationResult result)` Applies a validation result to a form field.
`protected void`	`updateModelValidationStatus(java.lang.String modelId, CmsValidationResult result)` Updates the model validation status.
`void`	`validateAllFields()` Performs an initial validation of all form fields.
`void`	`validateAndSubmit()` Validates the form fields and submits their values if the validation was successful.
`void`	`validateField(I_CmsFormField field)` Validates a single field.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - m_editedFields
```
protected java.util.Set<java.lang.String> m_editedFields
```
    The set of fields which have been edited.
  - m_fields
```
protected java.util.Map<java.lang.String,I_CmsFormField> m_fields
```
    A map from field ids to the corresponding widgets.
  - m_formHandler
```
protected I_CmsFormHandler m_formHandler
```
    The form handler.
  - m_pressedEnter
```
protected boolean m_pressedEnter
```
    A flag which indicates whether the user has pressed enter in a widget.
- 构造器详细资料
  - CmsForm
```
public CmsForm(A_CmsFormFieldPanel panel)
```
    Creates a new form with an existing form widget container.
    
    参数:
    panel - the form widget container
  - CmsForm
```
public CmsForm(boolean initPanel)
```
    Creates a new form and optionally sets the form widget container to a simple form field panel.
    
    参数:
    initPanel - if true, initializes the form widget container
- 方法详细资料
  - addField
```
public void addField(I_CmsFormField field,
            java.lang.String initialValue)
```
    Adds a form field.
    
    参数:
    field - the field to add
    initialValue - the initial field value
  - addField
```
public void addField(java.lang.String fieldGroup,
            I_CmsFormField formField)
```
    Adds a form field to the form.
    
    参数:
    fieldGroup - the form field group key
    formField - the form field which should be added
  - addField
```
public void addField(java.lang.String fieldGroup,
            I_CmsFormField formField,
            java.lang.String initialValue)
```
    Adds a form field to the form and sets its initial value.
    
    参数:
    fieldGroup - the form field group key
    formField - the form field which should be added
    initialValue - the initial value of the form field, or null if the field shouldn't have an initial value
  - addResetHandler
```
public void addResetHandler(I_CmsFormResetHandler handler)
```
    Adds a new form reset handler to the form.
    
    参数:
    handler - the new form reset handler
  - collectValues
```
public java.util.Map<java.lang.String,java.lang.String> collectValues()
```
    Collects all values from the form fields.
    This method omits form fields whose values are null.
    
    返回:
    a map of the form field values
  - getEditedFields
```
public java.util.Set<java.lang.String> getEditedFields()
```
    Returns the set of names of fields which have been edited by the user in the current form.
    
    返回:
    the set of names of fields edited by the user
  - getField
```
public I_CmsFormField getField(java.lang.String id)
```
    Returns the form field with a given id.
    
    参数:
    id - the id of the form field
    
    返回:
    the form field with the given id, or null if no field was found
  - getFields
```
public java.util.Map<java.lang.String,I_CmsFormField> getFields()
```
    Returns a map of this form's field, indexed by their field name.
    
    返回:
    a map of form fields
  - getWidget
```
public A_CmsFormFieldPanel getWidget()
```
    Returns the form widget container.
    
    返回:
    the form widget container
  - handleSubmit
```
public void handleSubmit(I_CmsFormSubmitHandler handler)
```
    Passes this form's data to a form submit handler.
    
    参数:
    handler - the form submit handler
  - noFieldsInvalid
```
public boolean noFieldsInvalid()
```
    Checks that no fields are invalid.
    
    返回:
    true if no fields are invalid.
  - noFieldsInvalid
```
public boolean noFieldsInvalid(java.util.Collection<I_CmsFormField> fields)
```
    Returns true if none of the fields in a collection are marked as invalid.
    
    参数:
    fields - the form fields
    
    返回:
    true if none of the fields are invalid
  - removeGroup
```
public void removeGroup(java.lang.String group)
```
    Removes all fields for the given group.
    
    参数:
    group - the group for which the fields should be removed
  - render
```
public void render()
```
    Renders all fields.
  - renderGroup
```
public void renderGroup(java.lang.String group)
```
    Renders the fields of the given group.
    
    参数:
    group - the field group
  - setFormHandler
```
public void setFormHandler(I_CmsFormHandler handler)
```
    Sets the form handler for this form.
    
    参数:
    handler - the form handler
  - setValidatorClass
```
public void setValidatorClass(java.lang.String validatorClass)
```
    Sets the server-side form validator class to use.
    
    参数:
    validatorClass - the form validator class name
  - setWidget
```
public void setWidget(A_CmsFormFieldPanel widget)
```
    Sets the form widget container.
    
    参数:
    widget - the form widget container
  - validateAllFields
```
public void validateAllFields()
```
    Performs an initial validation of all form fields.
  - validateAndSubmit
```
public void validateAndSubmit()
```
    Validates the form fields and submits their values if the validation was successful.
  - validateField
```
public void validateField(I_CmsFormField field)
```
    Validates a single field.
    
    参数:
    field - the field to validate
  - createValidatorConfig
```
protected java.lang.String createValidatorConfig()
```
    Returns the configuration string for the server side form validator.
    
    返回:
    the form validator configuration string
  - defaultHandleKeyPress
```
protected void defaultHandleKeyPress(I_CmsFormField field,
                         int keyCode)
```
    The default keypress event handling function for form fields.
    
    参数:
    field - the form field for which the event has been fired
    keyCode - the key code
  - defaultHandleValueChange
```
protected void defaultHandleValueChange(I_CmsFormField field,
                            java.lang.String newValue,
                            boolean inhibitValidation)
```
    Default handler for value change events of form fields.
    
    参数:
    field - the form field for which the event has been fired
    inhibitValidation - prevents validation of the edited field
    newValue - the new value
  - getFieldsByModelId
```
protected java.util.Collection<I_CmsFormField> getFieldsByModelId(java.lang.String modelId)
```
    Gets the fields with a given model id.
    
    参数:
    modelId - the model id
    
    返回:
    the fields with the given model id
  - updateFieldValidationStatus
```
protected void updateFieldValidationStatus(I_CmsFormField field,
                               CmsValidationResult result)
```
    Updates the field validation status.
    
    参数:
    field - the form field
    result - the validation result
  - updateFieldValidationStatus
```
protected void updateFieldValidationStatus(java.lang.String fieldId,
                               CmsValidationResult result)
```
    Applies a validation result to a form field.
    
    参数:
    fieldId - the field id to which the validation result should be applied
    result - the result of the validation operation
  - updateModelValidationStatus
```
protected void updateModelValidationStatus(java.lang.String modelId,
                               CmsValidationResult result)
```
    Updates the model validation status.
    
    参数:
    modelId - the model id
    result - the validation result

类 CmsForm

字段概要

构造器概要

方法概要

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

字段详细资料

m_editedFields

m_fields

m_formHandler

m_pressedEnter

构造器详细资料

CmsForm

CmsForm

方法详细资料

addField

addField

addField

addResetHandler

collectValues

getEditedFields

getField

getFields

getWidget

handleSubmit

noFieldsInvalid

noFieldsInvalid

removeGroup

render

renderGroup

setFormHandler

setValidatorClass

setWidget

validateAllFields

validateAndSubmit

validateField

createValidatorConfig

defaultHandleKeyPress

defaultHandleValueChange

getFieldsByModelId

updateFieldValidationStatus

updateFieldValidationStatus

updateModelValidationStatus