Create new RichFaces Documentation Jira issue
This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.
JBoss.orgCommunity Documentation
The <rich:ajaxValidator> is a component designed to provide Ajax validation inside for JSF inputs.
Skips all JSF processing except validation
Possibility to use both standard and custom validation
Possibility to use Hibernate Validation
Event based validation triggering
Table 6.35. rich : ajaxValidator attributes
| Attribute Name |
Description
|
|---|---|
| ajaxListener | MethodExpression representing an action listener method that will be notified when this component is activated by the ajax Request and handle it. The expression must evaluate to a public method that takes an AjaxEvent parameter, with a return type of void. Default value is "null" |
| binding | JSF: The attribute takes a value-binding expression for a component property of a backing bean |
| data | Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax |
| disableDefault | Disables default action for target event ( append "return false;" to JavaScript ). Default value is "false" |
| event | Name of JavaScript event property ( onclick, onchange, etc.) of parent component by which validation will be triggered. Default value is "onblur" |
| eventsQueue | Name of requests queue to avoid send next request before complete other from same event. Can be used to reduce number of requests of frequently events (key press, mouse move etc.) |
| focus | ID of an element to set focus after request is completed on client side |
| id | JSF: Every component may have a unique id that is automatically created if omitted |
| ignoreDupResponses | Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. ignoreDupResponses="true" does not cancel the request while it is processed on the server, but just allows to avoid unnecessary updates on the client side if the response isn't actual now |
| limitToList | If "true", then of all AJAX-rendered on the page components only those will be updated, which ID's are passed to the "reRender" attribute of the describable component. "false"-the default value-means that all components with ajaxRendered="true" will be updated. |
| onbeforedomupdate | The client-side script method to be called before DOM is updated |
| oncomplete | The client-side script method to be called after the request is completed |
| onsubmit | DHTML: The client-side script method to be called before an ajax request is submitted |
| profiles | This attribute defines JavaBean Validation 'groups' feature (JSR-303). It is ignored if Hibernate Validator is used. |
| rendered | JSF: If "false", this component is not rendered |
| requestDelay | Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. When the delay time is over, the request will be sent to the server or removed if the newest 'similar' request is in a queue already |
| reRender | Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection |
| similarityGroupingId | If there are any component requests with identical IDs then these requests will be grouped. |
| status | ID (in format of call UIComponent.findComponent()) of Request status component |
| summary | Summary message for a validation errors. |
| timeout | Response waiting time on a particular request. If a response is not received during this time, the request is aborted |
Table 6.36. 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 |
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>
...
Example:
import org.richfaces.component.html.HtmlCalendar;
...
HtmlAjaxValidator myAjaxValidator= new HtmlAjaxValidator();
...
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:outputText value="Age:" />
<h:inputText value="#{userBean.age}" id="age" required="true">
<f:convertNumber integerOnly="true"/>
<f:validateLongRange minimum="18" maximum="99"/>
<rich:ajaxValidator event="onblur"/>
</h:inputText>
<rich:message for="age"/>
</h:panelGrid>
</rich:panel>
...
This is the result of the snippet.
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:outputText value="Email:" />
<h:inputText value="#{validationBean.email}" id="email">
<rich:ajaxValidator event="onblur" />
</h:inputText>
<rich:message for="email" />
<h:outputText value="Age:" />
<h:inputText value="#{validationBean.age}" id="age">
<rich:ajaxValidator event="onblur" />
</h:inputText>
<rich:message for="age" />
</h:panelGrid>
</rich:panel>
...
Here is the source code of the managed bean.
package org.richfaces.demo.validation;
import org.hibernate.validator.Email;
import org.hibernate.validator.Length;
import org.hibernate.validator.Max;
import org.hibernate.validator.Min;
import org.hibernate.validator.NotEmpty;
import org.hibernate.validator.NotNull;
import org.hibernate.validator.Pattern;
public class ValidationBean {
private String progressString="Fill the form please";
@NotEmpty
@Pattern(regex=".*[^\\s].*", message="This string contain only spaces")
@Length(min=3,max=12)
private String name;
@NotEmpty
private String email;
@NotNull
@Min(18)
@Max(100)
private Integer age;
public ValidationBean() {
}
/* Corresponding Getters and Setters */
}
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.
Visit the AjaxValidator page at RichFaces LiveDemo for examples of component usage and their sources.
