rich:ajaxValidator

Component identification parameters

Name | Value
--- | ---
component-type | org.richfaces.ajaxValidator
component-class | org.richfaces.component.html.HtmlajaxValidator
component-family | org.richfaces.ajaxValidator
renderer-type | org.richfaces.ajaxValidatorRenderer
tag-class | org.richfaces.taglib.ajaxValidatorTag

## Creating the Component with a Page Tag

To create the simplest variant on a page use the following syntax:

Example:

    ...
    <h:outputText value="Name:" />
    <h:inputText value="#{userBean.name}" id="name" required="true">
              <f:validateLength minimum="3" maximum="12"/>
              <rich:ajaxValidator event="onblur"/>
    </h:inputText>
    ...

## Creating the Component Dynamically Using Java

Example:

    import org.richfaces.component.html.HtmlCalendar;
    ...
    HtmlAjaxValidator myAjaxValidator= new HtmlAjaxValidator();
    ...

## Details of Usage

The <rich:ajaxValidator> component should be added as a child component to an input JSF tag which data should be validated and an event that triggers validation should be specified as well. The component is ajaxSingle by default so only the current field will be validated.

The following example demonstrates how the <rich:ajaxValidator> adds AJAX functionality to standard JSF validators. The request is sent when the input field loses focus, the action is determined by the "event" attribute that is set to `"onblur"`.

    ...
    <rich:panel>
           <f:facet name="header">
                  <h:outputText value="User Info:" />
           </f:facet>
           <h:panelGrid columns="3">
                  <h:outputText value="Name:" />
                  <h:inputText value="#{userBean.name}" id="name" required="true">
                         <f:validateLength minimum="3" maximum="12"/>
                         <rich:ajaxValidator event="onblur"/>
                  </h:inputText>
                  <rich:message for="name" />
           </h:panelGrid>
    </rich:panel>
    ...

This is the result of the snippet.

Simple example of <rich:ajaxValidator> with

In the example above it's show how to work with standard JSF validators. The <rich:ajaxValidator> component also works perfectly with custom validators enhancing their usage with AJAX.

Custom validation can be performed in two ways:

- Using JSF Validation API is available in javax.faces.validator package

- Using Hibernate Validator, specifying a constraint for the data to be validated. A reference on Hibernate Validator can be found in Hibernated documentation.

The following example shows how the data entered by user can be validated using Hibernate Validator.

    ...
    <rich:panel>
           <f:facet name="header">
                  <h:outputText value="User Info:" />
           </f:facet>
           <h:panelGrid columns="3">
                  <h:outputText value="Name:" />
                  <h:inputText value="#{validationBean.name}" id="name" required="true">
                         <rich:ajaxValidator event="onblur" />
                  </h:inputText>
                  <rich:message for="name" />
           </h:panelGrid>
    </rich:panel>
    ...

Here is the source code of the managed bean.

    ...
    package org.richfaces.demo.validation;

    import org.hibernate.validator.NotEmpty;
    import org.hibernate.validator.Email;
    import org.hibernate.validator.Length;

    public class ValidationBean {

    	@NotEmpty
    	@Length(min=3,max=12)
    	private String name;
    	@Email (message="wrong email format")
    	@NotEmpty
    	private String email;

    	public ValidationBean() {
    	}
    	public String getName() {
    		return name;
    	}
    	public void setName(String name) {
    		this.name = name;
    	}
    	public String getEmail() {
    		return email;
    	}
    	public void setEmail(String email) {
    		this.email = email;
    	}
    }
    ...

By default the Hibernate Validator generates an error message in 10 language, though you can redefine the messages that are displayed to a user when validation fails. In the shows example it was done by adding `(message="wrong email format")` to the `@Email` annotation.

This is how it looks.

Validation using Hibernate validator

## Relevant Resources Links

On RichFaces LiveDemo page you can see an example of <rich:ajaxValidator> usage and sources for the given example.