[richfaces-svn-commits] JBoss Rich Faces SVN: r11870 - trunk/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Thu Dec 18 08:22:21 EST 2008
Author: cluts
Date: 2008-12-18 08:22:21 -0500 (Thu, 18 Dec 2008)
New Revision: 11870
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 - 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-18 13:11:22 UTC (rev 11869)
+++ trunk/docs/userguide/en/src/main/docbook/included/queue.desc.xml 2008-12-18 13:22:21 UTC (rev 11870)
@@ -7,7 +7,7 @@
</keywordset>
</sectioninfo>
<title>Description</title>
- <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>
+ <para>The <emphasis role="bold"><property><a4j:queue></property></emphasis> component creates queues of requests of Ajax request that other Ajax4JSF or RichFaces components can reference and use.</para>
+ <para>This component can manage server requests of the components, which referred to it, with help of its attributes.</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-18 13:11:22 UTC (rev 11869)
+++ trunk/docs/userguide/en/src/main/docbook/included/queue.xml 2008-12-18 13:22:21 UTC (rev 11870)
@@ -37,12 +37,25 @@
<section>
<title>Creating on a page</title>
- <para>Here is the simplest way for a component creation on a page.</para>
+ <para>In order to create the named queue, see following example.</para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
+ <programlisting role="XML"><![CDATA[<a4j:queue name="myQueue" ... />
+...
+<h:inputText value="#{myQueue.text}">
+ <a:support id="onblur" event="onblur" eventsQueue="myQueue"/>
+</h:inputText>
+...
+<a4j:commandButton eventsQueue="myQueue" ... >]]></programlisting>
+ <para>You can also create the queue with a default name. This queue is global for the all form. See the example below.</para>
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
<programlisting role="XML"><![CDATA[<h:form>
- <a4j:queue name="fooQueue" ... />
+ ...
+ <a4j:queue/>
+ ...
</h:form>
]]></programlisting>
</section>
@@ -61,29 +74,28 @@
<section>
<title>Key attributes and ways of usage</title>
- <para>By means of the <emphasis role="bold"><property><a4j:queue></property></emphasis> component a user can create several types of queues associated with it.</para>
+ <para>By means of the <emphasis role="bold"><property><a4j:queue></property></emphasis> component you can create several types of queues associated with it.</para>
<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. You can see the example below:
+ In order to create global queue for the all 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>
- In order to enable/disable a global queue see the following examples:
+ In order to enable/disable a global queue for concrete views see the following examples:
</para>
<programlisting role="XML"><![CDATA[<a4j:queue name="org.richfaces.global_queue" disabled="false"... />]]></programlisting>
<para>
- or:
+ In order to disable the queue the<emphasis><property>"disabled"</property></emphasis> attribute should be "true".
</para>
- <programlisting role="XML"><![CDATA[<a4j:queue name="org.richfaces.global_queue" disabled="true"... />]]></programlisting>
</listitem>
<listitem>
<para>
- 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.
+ You can create a separate queue for a 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 is the queue only for this form. The queue's name don't define by default if you haven't defined it.
</para>
<para>
<emphasis role="bold">
@@ -105,7 +117,7 @@
</para>
<programlisting role="XML"><![CDATA[<a4j:form ... >
...
- <a4j:queue <a4j:queue name="fooQueue" ... />
+ <a4j:queue name="myQueue" ... />
...
</a4j:form>]]></programlisting>
<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>
@@ -114,26 +126,26 @@
Example:
</emphasis>
</para>
- <programlisting role="XML"><![CDATA[<a4j:form eventsQueue="fooQueue" ...>
+ <programlisting role="XML"><![CDATA[<a4j:form eventsQueue="myQueue" ...>
...
</a4j:form>]]></programlisting>
</listitem>
<listitem>
- <para>With the help of the <emphasis><property>"eventsQueue"</property></emphasis> attribute a user can reference a named queue from any <emphasis role="bold"><property>a4j</property></emphasis> or <emphasis role="bold"><property>rich</property></emphasis> component that supports this attribute.</para>
+ <para>With the help of the <emphasis><property>"eventsQueue"</property></emphasis> attribute you can reference a named queue from any <emphasis role="bold"><property>a4j</property></emphasis> or <emphasis role="bold"><property>rich</property></emphasis> component that supports this attribute.</para>
<para>
<emphasis role="bold">
Example:
</emphasis>
</para>
- <programlisting role="XML"><![CDATA[<a4j:queue name="fooQueue" ... />
+ <programlisting role="XML"><![CDATA[<a4j:queue name="myQueue" ... />
...
-<h:inputText value="#{foo2.bar1}">
- <a:support id="onblur" event="onblur" reRender="bar21" eventsQueue="fooQueue"/>
+<h:inputText value="#{queueBean.text}">
+ <a4j:support id="onblur" event="onblur" eventsQueue="myQueue"/>
</h:inputText>
-<a4j:commandButton eventsQueue="fooQueue" ... >]]></programlisting>
+<a4j:commandButton eventsQueue="myQueue" ... >]]></programlisting>
<para>
- 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>.
+ As a result all requests generated after the "onblur" event 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>"myQueue"</code>.
</para>
<para>
If you try to refer to the nonexistent queue the new named queue will be created with all default settings.
@@ -148,20 +160,20 @@
</para>
<itemizedlist>
<listitem>
- <para>dropNext - this strategy is default. It drops next request that should be fired</para>
+ <para>dropNext - drops next request that should be fired</para>
</listitem>
<listitem>
- <para>dropNew - it drops the incoming request</para>
+ <para>dropNew - 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>
+ <para>fireNext - immediately fires the next request in line to be fired</para>
</listitem>
<listitem>
- <para>fireNew - This type of the strategy immediately fires the incoming request.</para>
+ <para>fireNew - 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.
+ The <emphasis><property>"requestDelay"</property></emphasis> attribute defines delay time for all the requests which fired using this queue.
</para>
<para>
<emphasis role="bold">
@@ -170,11 +182,11 @@
</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.
+ As a result all the requests are fired with to 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.
+ 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>
</section>
More information about the richfaces-svn-commits
mailing list