From richfaces-svn-commits at lists.jboss.org Tue Jan  6 08:50:18 2009
Content-Type: multipart/mixed; boundary="===============8986279287770397694=="
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: r12131 -
 trunk/docs/userguide/en/src/main/docbook/included.
Date: Tue, 06 Jan 2009 08:50:17 -0500
Message-ID: <E1LKCK1-0005vb-MU@committer01.frg.pub.inap.atl.jboss.com>

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

Author: cluts
Date: 2009-01-06 08:50:16 -0500 (Tue, 06 Jan 2009)
New Revision: 12131

Modified:
   trunk/docs/userguide/en/src/main/docbook/included/queue.xml
Log:
RF-4664 - the "6.20.4. Key attributes and ways of usage" section has been u=
pdated

Modified: trunk/docs/userguide/en/src/main/docbook/included/queue.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/queue.xml	2009-01-06 =
13:43:47 UTC (rev 12130)
+++ trunk/docs/userguide/en/src/main/docbook/included/queue.xml	2009-01-06 =
13:50:16 UTC (rev 12131)
@@ -75,8 +75,8 @@
     =

     <section>
         <title>Key attributes and ways of usage</title>
-        <para>It&apos;s possible by means of the <emphasis role=3D"bold"><=
property>&lt;a4j:queue&gt;</property></emphasis> component to create the se=
veral types of the queues.</para>
-        <itemizedlist>
+        <para>It&apos;s possible by means of the <emphasis role=3D"bold"><=
property>&lt;a4j:queue&gt;</property></emphasis> component to create the se=
veral types of the queues. The information about it you can find here.</par=
a>
+       <!-- <itemizedlist>
             <listitem>
                 <para>
                     So that to create a global queue you should add the fo=
llowing code into your &quot;web.xml&quot; file. In this instance the queue=
 can be used for the all pages and all components of these pages.
@@ -152,7 +152,8 @@
                     If you try to refer to the nonexistent queue the new n=
amed queue will be created with all default settings.
                 </para>
             </listitem>
-        </itemizedlist>
+            </itemizedlist>-->
+        <para>In order to disable or enable the <emphasis role=3D"bold"><p=
roperty>&lt;a4j:queue&gt;</property></emphasis> component on the page you c=
an use the <emphasis><property>&quot;disabled&quot;</property></emphasis> a=
ttribute.</para>
         <para>
             The <emphasis><property>&quot;size&quot;</property></emphasis>=
 attribute helps you to set the number of requests allowed in the queue at =
one time.
         </para>
@@ -174,6 +175,17 @@
             </listitem>
         </itemizedlist>
         <para>
+            The example of the usage this attribute you can find below.
+        </para>
+        <para>
+            <emphasis role=3D"bold">
+                Example:
+            </emphasis>
+        </para>
+        <programlisting role=3D"XML"><![CDATA[...
+    <a4j:queue sizeExceededBehavior=3D"dropNext" requestDelay=3D"5000" ...=
 />
+    ...]]></programlisting>
+        <para>
             The <emphasis><property>&quot;requestDelay&quot;</property></e=
mphasis> attribute defines delay time for all the requests which fired usin=
g this queue.
         </para>
         <para>
@@ -189,6 +201,20 @@
             The requests collected in the queue, combining similar ones, d=
uring request delay. =

             Note, that such requests can combine, if they are raised seque=
ntially, in order to not block the queue and not to change the requests ord=
er.
         </para>
+        <para>
+            You can define the JavaScript code for call after Ajax respons=
e receiving and before updating DOM on a client side via the <emphasis><pro=
perty>&quot;onbeforedomupdate&quot;</property></emphasis> attribute.
+        </para>
+        <para>
+            The <emphasis><property>&quot;onrequestqueue&quot;</property><=
/emphasis> attribute is a JavaScript code for call which fired after the ne=
w request has been added to queue.
+            And the <emphasis><property>&quot;onrequestdequeue&quot;</prop=
erty></emphasis> attribute is the code for call which fired after the reque=
st has been removed from queue. =

+        </para>
+        =

+        <para>
+            The <emphasis><property>&quot;onsubmit&quot;</property></empha=
sis> attribute is fired after request is completed. This attribute allows t=
o invoke JavaScript code before an Ajax request is sent.
+        </para>
+        <para>The additional information about the <emphasis><property>&qu=
ot;requestDelay&quot;</property></emphasis>, <emphasis><property>&quot;time=
out&quot;</property></emphasis> and <emphasis><property>&quot;ignoreDupResp=
onses&quot;</property></emphasis>
+            you can find in <link linkend=3D"QueueandTrafficFloodProtectio=
n">this</link> section.
+        </para>
     </section>
     =

     <section>


--===============8986279287770397694==--