From richfaces-svn-commits at lists.jboss.org Fri Jan  4 11:25:25 2008
Content-Type: multipart/mixed; boundary="===============4773266783910793150=="
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: r5144 -
 trunk/docs/userguide/en/src/main/docbook/included.
Date: Fri, 04 Jan 2008 11:25:25 -0500
Message-ID: <E1JApML-0006Lw-LK@committer01.frg.pub.inap.atl.jboss.com>

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

Author: artdaw
Date: 2008-01-04 11:25:25 -0500 (Fri, 04 Jan 2008)
New Revision: 5144

Modified:
   trunk/docs/userguide/en/src/main/docbook/included/form.xml
Log:
http://jira.jboss.com/jira/browse/RF-1813 - done

Modified: trunk/docs/userguide/en/src/main/docbook/included/form.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/form.xml	2008-01-04 1=
6:23:33 UTC (rev 5143)
+++ trunk/docs/userguide/en/src/main/docbook/included/form.xml	2008-01-04 1=
6:25:25 UTC (rev 5144)
@@ -53,12 +53,17 @@
   <section>
     <title>Key attributes and ways of usage</title>
     <para>The difference with the original component is that all hidden fi=
elds required for command links are always rendered and it doesn't depend o=
n links rendering on the initial page. It solves the problem with invalid l=
inks that weren't rendered on a page immediately, but after some Ajax reque=
st.</para>
-    <para>Beginning with release 1.0.5 additional attributes that make thi=
s form variant universal have appeared. With a new attribute definition as =
ajax=3D<emphasis >
-        <property>&quot;true&quot;</property>
-      </emphasis>, it becomes possible to set Ajax submission way for any =
components inside, i.e. not a page URL is used as an <emphasis >
-        <property>&quot;action&quot;</property>
-      </emphasis> attribute, but the javascript:A4J.AJAX.Submit(...) call.=
 In this case, rendering is defined as &quot;reRender&quot;=3Dlist of Ids f=
or the form element itself.</para>
-	<para>Example</para>
+    <para>Beginning with release 1.0.5 additional attributes that make thi=
s form variant universal have appeared. =

+    </para>
+    <para>
+      If <emphasis><property>&quot;ajaxSubmit&quot;</property></emphasis> =
attribute is true, =

+      it becomes possible to set Ajax submission way for any components in=
side, =

+      i.e. not a page URL is used as an <emphasis><property>&quot;action&q=
uot;</property></emphasis> attribute, but the javascript:A4J.AJAX.Submit(..=
.) call. =

+      In this case, the <emphasis><property>&quot;reRender&quot;</property=
></emphasis> attribute contains a list of Ids of components defined for re-=
rendering.
+      If you have <emphasis role=3D"bold"><property>&lt;h:commandButton&gt=
;</property></emphasis> or =

+      <emphasis role=3D"bold"><property>&lt;h:commandLink&gt;</property></=
emphasis> inside the form, they work as <emphasis role=3D"bold"><property>&=
lt;a4j:commandButton&gt;</property></emphasis>. =

+    </para>
+    <para><emphasis role=3D"bold">Example:</emphasis></para>
 	<programlisting role=3D"XML"><![CDATA[<a4j:form id=3D"helloForm" ajaxSubm=
it=3D"true" reRender=3D"table">
 	...
 	<t:dataTable id=3D"table"... >
@@ -81,7 +86,13 @@
         <property>&lt;h:commandLink&gt;</property>
       </emphasis> and can't be made Ajax ones with using e.g. <emphasis ro=
le=3D"bold">
         <property>&lt;a4j:support&gt;</property>
-      </emphasis>.</para>
+      </emphasis>.
+</para>
+    <para>
+      With the help of <emphasis><property>&quot;limitToList&quot;</proper=
ty></emphasis> attribute you can limit areas, which are updated after the r=
esponses. =

+      If <emphasis><property>&quot;limitToList&quot;</property></emphasis>=
 is true, only the reRender attribute is taken in account. =

+      Therefore, if you use blocks of text wrapped with <emphasis role=3D"=
bold"><property>&lt;a4j:outputPanel&gt;</property></emphasis> and <emphasis=
><property>&quot;ajaxRendered&quot;</property></emphasis>=3D <property>true=
</property>, blocks of text are ignored.
+    </para>
   </section>
   <section>
     <title>Relevant resources links</title>


--===============4773266783910793150==--