[richfaces-svn-commits] JBoss Rich Faces SVN: r12670 - trunk/samples/richfaces-demo/src/main/webapp/richfaces/queue.

Author: smukhina Date: 2009-02-16 10:19:10 -0500 (Mon, 16 Feb 2009) New Revision: 12670 Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/queue/customization.xhtml trunk/samples/richfaces-demo/src/main/webapp/richfaces/queue/usage.xhtml Log: https://jira.jboss.org/jira/browse/RF-5761 queue live demo section is corrected Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/queue/customization.xhtml =================================================================== --- trunk/samples/richfaces-demo/src/main/webapp/richfaces/queue/customization.xhtml 2009-02-16 15:11:59 UTC (rev 12669) +++ trunk/samples/richfaces-demo/src/main/webapp/richfaces/queue/customization.xhtml 2009-02-16 15:19:10 UTC (rev 12670) @@ -8,33 +8,30 @@ <ui:composition template="/templates/component-sample.xhtml"> <ui:define name="sample"> <p> - There you could explore <b>optimization </b>parameters of the <b>queue - </b>and learn how them influence the <b>Ajax requests</b>. This example + Here you could explore <b>optimization </b>parameters of the <b>queue + </b>and learn how they influence <b>Ajax requests</b>. This example is a good start to learn about Ajax requests flood protection. </p> <p> Pay attention to some points in the example: </p> - <ul> - <li> - Setting ignoreDupResponces to true - will reduce the count of DOM updates on typing inside input. - (in initial state - count of updates will be equals to count of requests) - </li> - <li> - Disabling the queue will causes fully asynchronous updates. Note - that updates could appears not in the right order and you could get - wrong string in the result. + <ul> <li> + Setting ignoreDupResponces to true reduces the count of DOM updates on typing inside the input. + (in initial state count of updates is equals to count of requests) + </li> <li> + Disabling the queue causes fully asynchronous updates. Note + that updates could appear not only in direct order and as a result you could get + wrong string. </li> <li> - Setting request delay to greater value will reduce the requests count - on fast typing. (More similar requests will be combined in the result) + Setting request delay to greater value reduces the requests count + on fast typing. (More similar requests are combined in the result) </li> - </ul> - <p><i> + </ul> <p><i> - Also pay your attention to the queue definition. As it mentioned in - our documentation such definition (inside some form without name) + Also pay your attention to the queue definition. As it is mentioned in + our documentation (queue chapter in developer guide) such definition (inside some form without a name) means that the queue becomes global for the form. </i></p> <fieldset class="demo_fieldset"> @@ -57,52 +54,47 @@ <b>Queue</b> provides subset of common <b>Ajax requests optimization attributes</b> (<i>requestDelay, ignoreDupResponse and timeout</i>) which you could explore at <h:commandLink value="Queue and Traffic Flood Protection" immediate="true" action="ajaxOptimization"/> section. - These attributes defined within the queue will be used for all the request - in case concrete components do not override them. + These attributes defined within the queue are used for all request + in case particular components do not override them. </p> </h:form> <p>The queue component also provides some additional attributes in order to - control queue itself: + control the queue itself: </p> <ul> <li> - <b>name</b> attribute which defines name for the queue. + <b>name</b> attribute defines a name for the queue. </li> <li> - <b>disabled</b> - attribute which allows to disable the queue. - Could be used in order to disable the global queue for particular - views or in order to switch between same named queues with different + <b>disabled</b> attribute allows to disable the queue. + It could be used in order to disable the global queue for particular + views or in order to switch between queues of the same name with different parameters. </li> <li> - <b>size</b> - Defines the count of requests which could be queued + <b>size</b> defines the count of requests which could be queued at the moment. -1 value means that queue has no size limit. </li> <li> - <b>sizeExceededBehavior</b> - defines the behavior for the queue - if size already exceeded and new request tried to be added to + <b>sizeExceededBehavior</b> defines the behavior for the queue + if size is already exceeded and a new request is tried to be added to the queue. (dropNew, dropNext, fireNew, fireNext values allowed) </li> <li> - <b>status</b> - attribute which allows to point status component - to all the requests from the particular queue. + <b>status</b> attribute allows to point the status component + to all requests from a particular queue. </li> </ul> <p> - Full attributes table and usage ways you could explore at our - queue documentation. + Complete attributes table and ways of usage you could explore in our + queue documentation (queue chapter in developer guide). </p> - <p><i> - Also pay your attention to the queue definition. As it mentioned in - our documentation such definition (inside some form without name) - means that the queue becomes global for the form. - </i></p> <p class="note"> <i><b>Note:</b></i> queue component could get its parameters from - EL bindings. But the component isn't designed to be updated via - ajax requests. (There are no useful cases where the developers - need to change the timeouts or request delays on the fly). So + EL bindings, but the component isn't designed to be updated via + ajax requests. As there are no useful cases where the developers + need to change the timeouts or request delays on the fly. Thus as you could see the example below uses <b>h:commandButton</b> in order to reebuild all the view and reinitialize the queue with new parameter values. Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/queue/usage.xhtml =================================================================== --- trunk/samples/richfaces-demo/src/main/webapp/richfaces/queue/usage.xhtml 2009-02-16 15:11:59 UTC (rev 12669) +++ trunk/samples/richfaces-demo/src/main/webapp/richfaces/queue/usage.xhtml 2009-02-16 15:19:10 UTC (rev 12670) @@ -8,15 +8,15 @@ <ui:composition template="/templates/component-sample.xhtml"> <ui:define name="sample"> <p> - The <b>Ajax Requests</b> area represent individual Ajax requests that can be fired by clicking the green images (a4j:commandLink components). + The <b>Ajax Requests</b> area represents individual Ajax requests that can be fired by clicking the green images (a4j:commandLink components). A <i>JSF managed bean</i> on the server causes a random sleep time (4 seconds or less) to simulate - different processing times for each request. The &lt;a4j:queue/&gt; (defined as global - for the form where controls placed) handles all the requests and fires next one only after - the responce from previous returned. + different processing time for each request. The &lt;a4j:queue/&gt; (defined as global + for the form where controls are placed) handles all requests and fires the next one only after + the response from the previous returned. </p> <p> - The demo JavaScript on the client includes a function that subscribes to these queue events, so the UI is updated as queue events happen.<br /> - Just click on any sequence of green images (any number, any order) and you will see that each request is handled in the order they were fired. + The demo JavaScript on the client includes a function that is subscribed to these queue events, so the UI is updated as queue events happen.<br /> + Just click on any sequence of green images (any number, any order) and you will see that each request is handled in the order it was fired. </p> <fieldset class="demo_fieldset">