org.opencms.gwt.client.validation

类 CmsValidationController

java.lang.Object

org.opencms.gwt.client.validation.CmsValidationController

所有已实现的接口:

I_CmsValidationController

public class CmsValidationController
extends java.lang.Object
implements I_CmsValidationController

This class is responsible for coordinating the synchronous and asynchronous validation for a set of form fields.

从以下版本开始:

8.0.0

字段概要

字段

限定符和类型	字段和说明
protected java.util.Collection<I_CmsFormField>	m_fields The list of form fields which should be validated.
protected java.util.Map<java.lang.String,CmsValidationQuery>	m_validationQueries A map containing all validation queries which should be executed asynchronously.

构造器概要

构造器

构造器和说明
CmsValidationController(java.util.Collection<I_CmsFormField> fields, I_CmsValidationHandler handler) Creates a new validation controller for a list of form fields.
CmsValidationController(I_CmsFormField field, I_CmsValidationHandler handler) Creates a new validation controller for a single form field.

方法概要

方法

限定符和类型	方法和说明
int	getId() Returns the id of this validation controller.
java.util.Set<java.lang.String>	getValidatedFields() Returns the set of fields which have been validated.
protected void	internalStartValidation() Starts the validation.
protected void	onReceiveValidationResults(java.util.Map<java.lang.String,CmsValidationResult> results) Internal method which is executed when the results of the asynchronous validation are received from the server.
void	provideValidationResult(java.lang.String field, CmsValidationResult result) Reports the result of a synchronous validation.
void	setFormValidator(java.lang.String formValidatorClass) Sets the form validator class name for this validation controller.
void	setFormValidatorConfig(java.lang.String formValidatorConfig) Sets the form validator configuration string.
void	startValidation() Starts the validation.
void	validateAsync(java.lang.String field, java.lang.String value, java.lang.String validator, java.lang.String config) Requests an server-side validation to be performed later.

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

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

字段详细资料

m_fields

protected java.util.Collection<I_CmsFormField> m_fields

The list of form fields which should be validated.

m_validationQueries

protected java.util.Map<java.lang.String,CmsValidationQuery> m_validationQueries

A map containing all validation queries which should be executed asynchronously.

构造器详细资料

CmsValidationController

public CmsValidationController(java.util.Collection<I_CmsFormField> fields,
                       I_CmsValidationHandler handler)

Creates a new validation controller for a list of form fields.

参数:

fields - the fields which should be validated

handler - the validation handler

CmsValidationController

public CmsValidationController(I_CmsFormField field,
                       I_CmsValidationHandler handler)

Creates a new validation controller for a single form field.

参数:

field - the form field

handler - the validation handler

方法详细资料

getId

public int getId()

Returns the id of this validation controller.

返回:

an id

getValidatedFields

public java.util.Set<java.lang.String> getValidatedFields()

Returns the set of fields which have been validated.

返回:

the set of validated fields

provideValidationResult

public void provideValidationResult(java.lang.String field,
                           CmsValidationResult result)

从接口复制的说明: I_CmsValidationController

Reports the result of a synchronous validation.

指定者:

provideValidationResult 在接口中 I_CmsValidationController

参数:

field - the field name

result - the validation result

另请参阅:

I_CmsValidationController.provideValidationResult(java.lang.String, org.opencms.gwt.shared.CmsValidationResult)

setFormValidator

public void setFormValidator(java.lang.String formValidatorClass)

Sets the form validator class name for this validation controller.

参数:

formValidatorClass - the class name of the form validator

setFormValidatorConfig

public void setFormValidatorConfig(java.lang.String formValidatorConfig)

Sets the form validator configuration string.

a

参数:

formValidatorConfig - the form validator configuration string

startValidation

public void startValidation()

Starts the validation.

This uses the CmsValidationScheduler, so the validation only starts after the currently running or scheduled validations have finished running.

validateAsync

public void validateAsync(java.lang.String field,
                 java.lang.String value,
                 java.lang.String validator,
                 java.lang.String config)

从接口复制的说明: I_CmsValidationController

Requests an server-side validation to be performed later.

指定者:

validateAsync 在接口中 I_CmsValidationController

参数:

field - the field name

value - the value of the field

validator - the server-side validator class name

config - the configuration string for the server-side validator

另请参阅:

I_CmsValidationController.validateAsync(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

internalStartValidation

protected void internalStartValidation()

Starts the validation.

onReceiveValidationResults

protected void onReceiveValidationResults(java.util.Map<java.lang.String,CmsValidationResult> results)

Internal method which is executed when the results of the asynchronous validation are received from the server.

参数:

results - the validation results