From richfaces-svn-commits at lists.jboss.org Tue Aug 12 13:56:01 2008
Content-Type: multipart/mixed; boundary="===============6476785697536498694=="
MIME-Version: 1.0
From: richfaces-svn-commits at lists.jboss.org
To: richfaces-svn-commits at lists.jboss.org
Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r10057 -
 trunk/docs/userguide/en/src/main/docbook/included.
Date: Tue, 12 Aug 2008 13:56:01 -0400
Message-ID: <E1KSy6D-0005hK-2w@committer01.frg.pub.inap.atl.jboss.com>

--===============6476785697536498694==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: artdaw
Date: 2008-08-12 13:56:00 -0400 (Tue, 12 Aug 2008)
New Revision: 10057

Modified:
   trunk/docs/userguide/en/src/main/docbook/included/beanValidator.desc.xml
   trunk/docs/userguide/en/src/main/docbook/included/beanValidator.xml
Log:
https://jira.jboss.org/jira/browse/RF-3903
The info about beanValidator is added

Modified: trunk/docs/userguide/en/src/main/docbook/included/beanValidator.d=
esc.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/docs/userguide/en/src/main/docbook/included/beanValidator.desc.xm=
l	2008-08-12 17:38:30 UTC (rev 10056)
+++ trunk/docs/userguide/en/src/main/docbook/included/beanValidator.desc.xm=
l	2008-08-12 17:56:00 UTC (rev 10057)
@@ -9,16 +9,16 @@
         <title>Description</title>
         <para>The<emphasis role=3D"bold">
             <property>&lt;rich:beanValidator&gt;</property> =

-        </emphasis>is a component designed to provide ajax validation insi=
de for JSF inputs.</para>
+        </emphasis>is a component designed to provide validation using Hib=
ernate model-based constraints</para>
 =

+
+
+
     </section>
     <section>
         <title>Key Features</title>
         <itemizedlist>
-            <listitem><para>Skips all JSF processing except validation</pa=
ra></listitem>
-            <listitem><para>Possibility to use both standard and custom va=
lidation</para></listitem>
-            <listitem><para>Possibility to use Hibernate Validation</para>=
</listitem>
-            <listitem><para>Event based validation triggering</para></list=
item>
+            <listitem><para>Validation using Hibernate constraints</para><=
/listitem>
         </itemizedlist>
     </section>
 </section>

Modified: trunk/docs/userguide/en/src/main/docbook/included/beanValidator.x=
ml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/docs/userguide/en/src/main/docbook/included/beanValidator.xml	200=
8-08-12 17:38:30 UTC (rev 10056)
+++ trunk/docs/userguide/en/src/main/docbook/included/beanValidator.xml	200=
8-08-12 17:56:00 UTC (rev 10057)
@@ -55,18 +55,16 @@
   <section>
     <title>Creating the Component with a Page Tag</title>
 =

-    <para>To create the simplest variant on a page use the following synta=
x:</para>
+    <para>To create the simplest variant of the component on a page use th=
e following syntax:</para>
 =

 =

     <para>
       <emphasis role=3D"bold">Example:</emphasis>
     </para>
     <programlisting role=3D"XML"><![CDATA[...
- <h:outputText value=3D"Name:" />
-                <h:inputText value=3D"#{userBean.name}" id=3D"name" requir=
ed=3D"true">
-                    <f:validateLength minimum=3D"3" maximum=3D"12"/>
-                    <rich:beanValidator event=3D"onblur"/>
-                </h:inputText>
+<h:inputText value=3D"#{validationBean.email}" id=3D"email">
+<rich:beanValidator summary=3D"Invalid email"/>
+</h:inputText>
 ...]]></programlisting>
   </section>
 =

@@ -81,6 +79,119 @@
 HtmlbeanValidator mybeanValidator=3D new HtmlbeanValidator();
 ...
 ]]></programlisting>
+    =

+    =

+    <!-- Start  Details of Usage-->
+    <section>
+      <title>Details of Usage</title>
+      =

+   <para>  =

+ Starting from 3.2.2 GA version Rich Faces provides support for model-base=
d constraints defined using Hibernate Validator. =

+ Thus it's possible to use Hibernate Validators the same as for Seam based=
 applications.
+   </para>
+      =

+  <para>The <emphasis role=3D"bold"><property>&lt;rich:beanValidator&gt;</=
property></emphasis>
+       component is defined in the same way as any JSF validator. Look at =
the example below. =

+  </para> =

+      =

+      <programlisting role=3D"XML"><![CDATA[...     =

+      <rich:panel>
+        <f:facet name=3D"header">
+          <h:outputText value=3D"#{validationBean.progressString}" id=3D"p=
rogress"/>
+        </f:facet>
+        <h:panelGrid columns=3D"3">
+          <h:outputText value=3D"Name:" />
+          <h:inputText value=3D"#{validationBean.name}" id=3D"name">
+            <rich:beanValidator summary=3D"Invalid name"/>
+          </h:inputText>
+          <rich:message for=3D"name" />
+          <h:outputText value=3D"Email:" />
+          <h:inputText value=3D"#{validationBean.email}" id=3D"email">
+            <rich:beanValidator summary=3D"Invalid email"/>
+          </h:inputText>
+          <rich:message for=3D"email" />
+          <h:outputText value=3D"Age:" />
+          <h:inputText value=3D"#{validationBean.age}" id=3D"age">
+            <rich:beanValidator summary=3D"Wrong age"/>
+          </h:inputText>
+          <rich:message for=3D"age" />
+          <f:facet name=3D"footer">
+            <a4j:commandButton value=3D"Submit" action=3D"#{validationBean=
.success}" reRender=3D"progress"/>
+          </f:facet>
+        </h:panelGrid>
+      </rich:panel>
+      ...]]></programlisting>    =

+      =

+      <para>Please play close attention on  the bean code that contains th=
e constraints
+      defined with Hibernate annotation which perform validation of the in=
put data.</para>
+      =

+      <programlisting role=3D"JAVA"><![CDATA[
+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;
+
+public class ValidationBean {
+
+    @NotEmpty
+    @Length(min=3D3,max=3D12)
+    private String name;
+    @Email
+    @NotEmpty
+    private String email;
+    @NotNull
+    @Min(18)
+    @Max(100)
+    private int age;
+    =

+    public ValidationBean() {
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name =3D name;
+    }
+
+    public String getEmail() {
+        return email;
+    }
+
+    public void setEmail(String email) {
+        this.email =3D email;
+    }
+
+    public int getAge() {
+        return age;
+    }
+
+    public void setAge(int age) {
+        this.age =3D age;
+    }
+}]]></programlisting>
+      =

+<para>The following figure shows what happens if validation fails</para> =

+      =

+      <figure>
+        <title><emphasis role=3D"bold"><property>&lt;rich:beanValidator&gt=
;</property></emphasis> usage</title>  =

+        <mediaobject>
+          <imageobject>
+            <imagedata fileref=3D"images/beanValidator1.png"/>
+          </imageobject>
+        </mediaobject>     =

+      </figure>    =

+      <para>As you can see from the example that  in order to validate the=
 <emphasis role=3D"bold"><property>&lt;rich:beanValidator&gt;</property></e=
mphasis>
+      should be nested into a input JSF or RichFaces component. =

+      </para>
+      =

+      <para>The component has the only attribute - <emphasis><property>&qu=
ot;summary&quot;</property></emphasis>which displays validation messages ab=
out validation errors.</para>
+      </section>
   </section>
 =

 =



--===============6476785697536498694==--