10:46 a.m.
Author: cluts
Date: 2008-12-08 11:46:17 -0500 (Mon, 08 Dec 2008)
New Revision: 11646
Modified:
trunk/docs/userguide/en/src/main/docbook/included/queue.desc.xml
trunk/docs/userguide/en/src/main/docbook/included/queue.xml
Log:
RF-4664 - new information and description of the component have been added; language
correction has been done
Modified: trunk/docs/userguide/en/src/main/docbook/included/queue.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/queue.desc.xml 2008-12-08 16:45:58
UTC (rev 11645)
+++ trunk/docs/userguide/en/src/main/docbook/included/queue.desc.xml 2008-12-08 16:46:17
UTC (rev 11646)
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<chapter>
+<chapter role="new">
<section>
<sectioninfo>
<keywordset>
@@ -7,6 +7,7 @@
</keywordset>
</sectioninfo>
<title>Description</title>
- <para>The <emphasis
role="bold"><property><a4j:queue></property></emphasis>
component creates queues that other components can reference and use.</para>
+ <para>The <emphasis
role="bold"><property><a4j:queue></property></emphasis>
component creates queues that other components can use and reference.</para>
+ <para>User can create a default queue for a form ( overriding the
global default queue ).</para>
</section>
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/src/main/docbook/included/queue.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/queue.xml 2008-12-08 16:45:58 UTC
(rev 11645)
+++ trunk/docs/userguide/en/src/main/docbook/included/queue.xml 2008-12-08 16:46:17 UTC
(rev 11646)
@@ -65,16 +65,13 @@
<itemizedlist>
<listitem>
<para>
- A user can set a queue globally in "web.xml". You
don't need set the queue on the page itself. The global queue can be used by all
components. Example you can see below:
+ A user can set a queue globally in "web.xml". You
don't need set the queue on the page itself. The global queue can be used by all
components. You can see the example below:
</para>
<programlisting
role="XML"><![CDATA[<context-param>
<param-name>org.richfaces.queue.global.enabled</param-name>
<param-value>true</param-value>
</context-param>]]></programlisting>
<para>
- The global queue can be disabled for specifically view's
application.
- </para>
- <para>
In order to enable/disable a global queue see the following
examples:
</para>
<programlisting role="XML"><![CDATA[<a4j:queue
name="org.richfaces.global_queue" disabled="false"...
/>]]></programlisting>
@@ -85,7 +82,7 @@
</listitem>
<listitem>
<para>
- A user can create separate queue for specific form with the help of
the <emphasis
role="bold"><property><a4j:form></property></emphasis>
or <emphasis
role="bold"><property><h:form></property></emphasis>
tags.
+ A user can create a separate queue for specific form with the help of
the <emphasis
role="bold"><property><a4j:form></property></emphasis>
or <emphasis
role="bold"><property><h:form></property></emphasis>
tags.
It will be the global queue only for this form.
</para>
<para>
@@ -111,7 +108,7 @@
<a4j:queue <a4j:queue name="fooQueue" ... />
...
</a4j:form>]]></programlisting>
- <para>If you use <emphasis
role="bold"><property><a4j:form></property></emphasis>
tag, you can reference a named queue as the form's default.</para>
+ <para>If you use the <emphasis
role="bold"><property><a4j:form></property></emphasis>
tag, you can reference a named queue as the form's default.</para>
<para>
<emphasis role="bold">
Example:
@@ -136,19 +133,49 @@
<a4j:commandButton eventsQueue="fooQueue" ...
>]]></programlisting>
<para>
- As a result all requests generated through the onblur of the
<emphasis><property><h:inputText></property></emphasis>
component, and clicking of the
<emphasis><property><h:commandButton></property></emphasis>
will be funneled through the <code>"fooQueue"</code>.
+ As a result all requests generated through the onblur of the
<emphasis
role="bold"><property><h:inputText></property></emphasis>
component, and clicking of the <emphasis
role="bold"><property><h:commandButton></property></emphasis>
will be funneled through the <code>"fooQueue"</code>.
</para>
<para>
- If you have a try to reference a nonexistent queue a new named queue
will be created with all default settings.
+ If you try to refer to the nonexistent queue the new named queue will
be created with all default settings.
</para>
</listitem>
</itemizedlist>
<para>
- The
<emphasis><property>"size"</property></emphasis>
attribute help you to set the number of items allowed in the queue at one time.
+ The
<emphasis><property>"size"</property></emphasis>
attribute helps you to set the number of requests allowed in the queue at one time.
</para>
<para>
-
+ The
<emphasis><property>"sizeExceededBehavior"</property></emphasis>
attribute defines four strategies of the queue's behavior if the number of the
requests waiting in the queue is exceeded:
</para>
+ <itemizedlist>
+ <listitem>
+ <para>dropNext - this strategy is default. It drops next request
that should be fired</para>
+ </listitem>
+ <listitem>
+ <para>dropNew - it drops the incoming request</para>
+ </listitem>
+ <listitem>
+ <para>fireNext - with the help of this strategy you can immediately
fire the next request in line to be fired</para>
+ </listitem>
+ <listitem>
+ <para>fireNew - This type of the strategy immediately fires the
incoming request.</para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ The
<emphasis><property>"requestDelay"</property></emphasis>
attribute defines time delay for all the requests which fired using this queue.
+ </para>
+ <para>
+ <emphasis role="bold">
+ Example:
+ </emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[<a4j:queue
requestDelay="2000" ... />]]></programlisting>
+ <para>
+ As a result all the requests which were fired using this queue will have 2
sec delay.
+ </para>
+ <para>
+ The requests collect in the queue, combining similar ones, during request
delay.
+ User should remember 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>
</section>
<section>