From richfaces-svn-commits at lists.jboss.org Mon Jul 20 16:20:09 2009 Content-Type: multipart/mixed; boundary="===============1143500120736198279==" 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: r14947 - branches/community/3.3.X/docs/userguide/en/src/main/docbook/included. Date: Fri, 17 Jul 2009 08:33:40 -0400 Message-ID: <200907171233.n6HCXekT010157@svn01.web.mwc.hst.phx2.redhat.com> --===============1143500120736198279== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: atsebro Date: 2009-07-17 08:33:40 -0400 (Fri, 17 Jul 2009) New Revision: 14947 Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/pol= l.xml Log: RF-7512:a4j:poll component description review Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/inclu= ded/poll.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 --- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/po= ll.xml 2009-07-17 09:48:42 UTC (rev 14946) +++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/po= ll.xml 2009-07-17 12:33:40 UTC (rev 14947) @@ -1,48 +1,44 @@ - - - a4j:poll - - - - Component identification parameters - - - - Name - Value - - - - - component-type - org.ajax4jsf.Poll - - - component-family - org.ajax4jsf.components.AjaxPoll - - - component-class - org.ajax4jsf.component.html.AjaxPoll - - - renderer-type - org.ajax4jsf.components.AjaxPollRenderer - - - -
+ + + a4j:poll + + + + Component identification parameters + + + + Name + Value + + + + + component-type + org.ajax4jsf.Poll + + + component-family + org.ajax4jsf.components.AjaxPoll + + + component-class + org.ajax4jsf.component.html.AjaxPoll<= /entry> + + + renderer-type + org.ajax4jsf.components.AjaxPollRende= rer + + + +
= -
- Creating on a page - To create the simplest variant on a page use the= following syntax: - - - Example: - - +
+ Creating the component with a Page Tag + To create the simplest variant on a page= use the following syntax: + ]]> -
-
- Creating the Component Dynamically Using Java - - - Example: - - +
+ Creating the Component Dynamically Using Java + + Example: + + -
-
- Key attributes and ways of usage - The - <a4j:poll> - componet is used for periodical polling of server data. = In order to use the component - it's necessary to set an update interval. The - "interval" - attribute defines an interval in milliseconds between th= e previous - response and the next request. The total period beetween two request= s generated by the - - <a4j:poll> - component is a sum of an - "interval" - attribute value and server response time. Default value = for - "interval" - attribute is set to "1000" milliseconds (1 sec= ond). See an example of definition in - the "Creating on a page" sectio= n. - The - "timeout" - attribute defines response waiting time in milliseconds.= If a response - isn't received during this period a connection is aborted and t= he next request is - sent. Default value for - "timeout" - attribute isn't set. - The - "enabled" - attribute defines should the - <a4j:poll> - send request or not. It's necessary to render the - - <a4j:poll> - to apply the current value of - "enabled" - attribute. You can use an EL-expression for - "enabled" - attribute to point to a bean property. An example of usa= ge of mentioned above attributes is placed= below: = +
+ = +
+ Details of usage + + The <a4j:poll> componet is used for periodical polling of server data= . = + In order to use the component it's necessary to set= an update interval. = + The "interval"<= /emphasis> attribute defines an interval in milliseconds between the previo= us response and the next request. = + The total period beetween two requests generated by the = <a4j:poll> co= mponent is a sum of an"interval" attribute value and server response time. = + Default value for "interval&quo= t; attribute is set to "1000" milliseconds = (1 second). = + See an example of definition in the "Creating the component with a Page Tag" section. = + + + The "timeout" attribute defines response waiting time in milliseconds. = + If a response isn't received during this period a c= onnection is aborted and the next request is sent. = + Default value for "timeout"= ; attribute isn't set. + + = + + The "enabled" attribute defines should the &l= t;a4j:poll> send request or not. = + It's necessary to render the <a4j:poll> to apply the current val= ue of "enabled" attribu= te. = + You can use an EL-expression for &qu= ot;enabled" attribute to point to a bean propert= y. = + An example of usage of mentioned above attributes is pla= ced below: + Example: @@ -115,11 +96,8 @@ - - + + @@ -127,29 +105,32 @@ ...]]> = - The example shows how date and time are updated on a page in com= pliance with data taken - from a server. The - <a4j:poll> - componet sends requests to the server every second. - "reRender" - attribute for - <a4j:poll> - contains value of its own Id. Hence, it renders itself f= or applying the current value - of - "enabled" - attribute. + + The example shows how date and time are updated on a page in com= pliance with data taken from a server. = + The <a4j:poll> componet sends requests to the server every second. = + "reRender" a= ttribute of the <a4j:poll> contains poll's own Id. = + Hence, it is self rendered for applying the current value of "enabled" attribute. + = - Note: The form around the - <a4j:poll> - component is required. - = + = - Note: - To make the <a4j:poll> component = - send requests periodically when it limitToList is set to "= true", pass the = - <a4j:poll> ID to it reRender attribute. - - + Notes: + + + + The form around the <a4j:poll> component is required. + + + = + + + To make the <a4j= :poll> component send requests periodically when i= t limitToList is set to "true", = + pass the <a4j:po= ll> ID to it reRender attribute. + + + = + + = = - - Information about the "process" attribute usage you can find &quo= t; Decide what to process " guide section. - + + Information about the "process&= quot; attribute usage you can find "Decide what to process" guide section. +
= -
- Relevant resources links - In - - RichFaces Wiki article "Creating a Banner Using Effects and Pol= l" - - you can get additional information how to create an image - banner using - - <rich:effect> - - and - - <a4j:poll> - - components and also you can figure out how to create an HTML banner = in = - - RichFaces Wiki article "Creating an HTML Banner Using Effects a= nd Poll" - - . - - In - RichFaces Cookbook article on Slide Show" - you can find information how to make a Slide Show with help of the - - <rich:effect> - and - <a4j:poll> - components. - - On = - - RichFaces Live Demo page - - you can see the example of - - <a4j:poll> - - usage and sources for the given example. - - - The additional information about component usage you can find - in - - RichFaces Users Forum - - . - + = +
+ Relevant resources links + + Vizit the Poll page at RichFaces LiveD= emo for examples of the component usage and their sources. + + = + + Useful examples and articles: = + + + + + "Create a Banner Using Effects= and Poll" article at RichFaces Wiki = + gives an example of how to create an image b= anner using <rich:effect> and <a4j:poll>components; = + + + + + "Create an HTML Banner Usi= ng Effects and Poll" article at RichFaces Wiki = + brings the code of the way of creating an HT= ML banner banner using <rich:effect>= ; and <a4j:poll&= gt;components; = + + + + + "RichFaces and Slides= how" thread in the RichFaces users forum contains an informati= on and code on making a Slide Show with the help of the <a4j:poll> component; + + + = + + Manage the RichFaces Users Forum f= or fresh issues about the component usage. + +
= -
- --===============1143500120736198279==--