[richfaces-svn-commits] JBoss Rich Faces SVN: r12131 - trunk/docs/userguide/en/src/main/docbook/included.

[richfaces-svn-commits at lists.jboss.org]

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 updated

Modified: trunk/docs/userguide/en/src/main/docbook/included/queue.xml
===================================================================
--- 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="bold"><property>&lt;a4j:queue&gt;</property></emphasis> component to create the several types of the queues.</para>
-        <itemizedlist>
+        <para>It&apos;s possible by means of the <emphasis role="bold"><property>&lt;a4j:queue&gt;</property></emphasis> component to create the several types of the queues. The information about it you can find here.</para>
+       <!-- <itemizedlist>
             <listitem>
                 <para>
                     So that to create a global queue you should add the following 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 named queue will be created with all default settings.
                 </para>
             </listitem>
-        </itemizedlist>
+            </itemizedlist>-->
+        <para>In order to disable or enable the <emphasis role="bold"><property>&lt;a4j:queue&gt;</property></emphasis> component on the page you can use the <emphasis><property>&quot;disabled&quot;</property></emphasis> attribute.</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="bold">
+                Example:
+            </emphasis>
+        </para>
+        <programlisting role="XML"><![CDATA[...
+    <a4j:queue sizeExceededBehavior="dropNext" requestDelay="5000" ... />
+    ...]]></programlisting>
+        <para>
             The <emphasis><property>&quot;requestDelay&quot;</property></emphasis> attribute defines delay time for all the requests which fired using this queue.
         </para>
         <para>
@@ -189,6 +201,20 @@
             The requests collected in the queue, combining similar ones, during request delay. 
             Note, that such requests can combine, if they are raised sequentially, in order to not block the queue and not to change the requests order.
         </para>
+        <para>
+            You can define the JavaScript code for call after Ajax response receiving and before updating DOM on a client side via the <emphasis><property>&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 new request has been added to queue.
+            And the <emphasis><property>&quot;onrequestdequeue&quot;</property></emphasis> attribute is the code for call which fired after the request has been removed from queue. 
+        </para>
+        
+        <para>
+            The <emphasis><property>&quot;onsubmit&quot;</property></emphasis> attribute is fired after request is completed. This attribute allows to invoke JavaScript code before an Ajax request is sent.
+        </para>
+        <para>The additional information about the <emphasis><property>&quot;requestDelay&quot;</property></emphasis>, <emphasis><property>&quot;timeout&quot;</property></emphasis> and <emphasis><property>&quot;ignoreDupResponses&quot;</property></emphasis>
+            you can find in <link linkend="QueueandTrafficFloodProtection">this</link> section.
+        </para>
     </section>
     
     <section>