Author: msorokin Date: 2008-04-09 12:17:22 -0400 (Wed, 09 Apr 2008) New Revision: 7706 Modified: trunk/docs/userguide/en/src/main/docbook/included/progressBar.desc.xml trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml Log: http://jira.jboss.com/jira/browse/RF-1690 Fixing descriptions, basing on the comments of developers Modified: trunk/docs/userguide/en/src/main/docbook/included/progressBar.desc.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/progressBar.desc.xml 2008-04-09 16:11:39 UTC (rev 7705) +++ trunk/docs/userguide/en/src/main/docbook/included/progressBar.desc.xml 2008-04-09 16:17:22 UTC (rev 7706) @@ -23,10 +23,12 @@ <section> <title>Key Features</title> <itemizedlist> - <listitem><para>Highly customizable look and feel</para></listitem> - <listitem><para>Status polling frequency and timeout adjustment</para></listitem> + + <listitem><para>Option to control rerendering frequency</para></listitem> <listitem><para>Ajax or Client modes</para></listitem> - <listitem><para>Option to display some numeric data along side with graphical presentation</para></listitem> + <listitem><para>Possibility to display status information on the progress bar </para></listitem> + <listitem><para>Highly customizable look and feel</para></listitem> + </itemizedlist> </section> </section> \ No newline at end of file Modified: trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml 2008-04-09 16:11:39 UTC (rev 7705) +++ trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml 2008-04-09 16:17:22 UTC (rev 7706) @@ -67,29 +67,69 @@ As it was mentioned above, the <emphasis role="bold"><property>&lt;rich:progressBar&gt;</property></emphasis> component displays the status of the ongoing process. </para> + + <para>The <emphasis role="bold"><property>&lt;rich:progressBar&gt;</property> </emphasis> component can run in two modes: Ajax (default) and Client. + </para> + <itemizedlist> + <listitem> + <para><property>Ajax</property> - In this mode the component works the same way as <emphasis role="bold"><property>&lt;a4j:poll/&gt;</property></emphasis> which gets the current progress value from the sever, repeating after a set time interval. </para> + + </listitem> + <listitem> + <para><property>Client</property> - The current progress value in <property>Client</property> mode is set using JavaScript API </para> + </listitem> + </itemizedlist> + <para> + In order to define the mode you need to use <emphasis><property>&quot;mode&quot;</property></emphasis> attribute. + </para> + + + + + <para> + One of the key attributes of the component is <emphasis><property>&quot;interval&quot;</property></emphasis> which defines the frequency of status polling and rerenders the component when the value is updated. + </para> <para> + Polling is active while the <emphasis><property>&quot;enabled&quot;</property></emphasis> attribute is &quot;true&quot;.</para> + <para> + <emphasis role="bold">Example:</emphasis> + </para> + <programlisting role="XML"><![CDATA[... +<rich:progressBar value="#{bean.incValue}" id="progrs" interval="900" enabled="true"/> +...]]> </programlisting> + + <para> + With the help of <emphasis><property>&quot;timeout&quot;</property></emphasis> attribute you can define the waiting time on a particular request. + If a response is not received during this time the request is aborted. + </para> + + + <para> Status of the process is calculated basing on values of the following attributes: <itemizedlist> <listitem> <para> - <emphasis><property>&quot;value&quot;</property></emphasis> attribute sets the current value of the process + <emphasis><property>&quot;value&quot;</property></emphasis> is a value binding to the current progress value </para> </listitem> <listitem> <para> - <emphasis><property>&quot;minValue&quot;</property></emphasis> (default value is &quot;0&quot;) sets minimal value for - the <emphasis role="bold"><property>&lt;rich:progressBar&gt;</property></emphasis> to start rendering + <emphasis><property>&quot;minValue&quot;</property></emphasis> (default value is &quot;0&quot;) sets minimal progress value </para> </listitem> <listitem> <para> - <emphasis><property>&quot;maxValue&quot;</property></emphasis> (default value is &quot;100&quot;) sets maximum value for - the <emphasis role="bold"><property>&lt;rich:progressBar&gt;</property></emphasis> to finish rendering + <emphasis><property>&quot;maxValue&quot;</property></emphasis> (default value is &quot;100&quot;) sets maximum progress value </para> </listitem> </itemizedlist> </para> + + + + + <para> <emphasis role="bold">Example:</emphasis> </para> @@ -97,6 +137,34 @@ <programlisting role="XML"><![CDATA[... <rich:progressBar value="#{bean.incValue}" minValue="50" maxValue="400"/> ...]]> </programlisting> +<para>This is the result</para> + <figure> + <title>Progress bar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/progressbarNoLabel.png"/> + </imageobject> + </mediaobject> + </figure> + + + + + + + + + + + + + + + + + + + <!--para> The <emphasis><property> &quot;label&quot;</property></emphasis> attribute is responsible for displaying informational @@ -143,13 +211,13 @@ </listitem> <listitem> - <para>Using <emphasis role="bold"><property>&lt;h:outputText /&gt;</property></emphasis></para> + <para>Using any child components that display text. One of the components that can be used is <emphasis role="bold"><property>&lt;h:outputText /&gt;</property></emphasis></para> <para> <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... -<rich:progressBar value="#{bean.incValue1}"> - <h:outputText value="#{bean.incValue1}"/> +<rich:progressBar value="#{bean.incValue}"> + <h:outputText value="#{bean.incValue} %"/> </rich:progressBar> ...]]> </programlisting> </listitem> @@ -250,12 +318,16 @@ (e.g parameters=&quot;param:&apos;#{bean.incValue1}&apos;&quot;) and you can use it to pass the data. </para--> + + + + <para> The <emphasis><property>&quot;parameters&quot;</property></emphasis> is also a special attribute that defines parameters for substitution in the label. - All you need is to define a value of your own parameter + All you need is to define the value of your own parameter (e.g parameters=&quot;param:&apos;#{bean.incValue1}&apos;&quot;) and you can use it to pass the data. </para> @@ -265,33 +337,27 @@ </para> <programlisting role="XML"><![CDATA[... -<progressBar:progressBar value="#{bean.incValue1}" parameters="param:'#{bean.incValue1}'"> - <h:outputText value="{param}%"/> -</progressBar:progressBar> +<rich:progressBar value="#{bean.incValue}" parameters="param:'#{bean.dwnlSpeed}'"> + <h:outputText value="download speed {param} KB/s"/> +</rich:progressBar> ...]]> </programlisting> - + <para>This is the result</para> + <figure> + <title>Usage of parameters</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/progressbarParams.png"/> + </imageobject> + </mediaobject> + </figure> - + + <!-- END Parameters--> - <para> - The <emphasis><property>&quot;interval&quot;</property></emphasis> attribute defines the frequency of status polling. - </para> - <para> - Polling is active while the <emphasis><property>&quot;enabled&quot;</property></emphasis> attribute is &quot;true&quot;.</para> - <para> - <emphasis role="bold">Example:</emphasis> - </para> - <programlisting role="XML"><![CDATA[... -<rich:progressBar value="#{bean.incValue}" id="progrs" interval="900" enabled="true"/> -...]]> </programlisting> + - <para> - With the help of <emphasis><property>&quot;timeout&quot;</property></emphasis> attribute you can define the waiting time on a particular request. - If a response is not received during this time the request is aborted. - </para> - <para> The component can also employ <emphasis><property> &quot;initial&quot;</property></emphasis> and <emphasis><property> &quot;complete&quot;</property></emphasis> @@ -313,16 +379,7 @@ ...]]> </programlisting> <para> However, the usage of these facets is optional. If you omit them nothing will be displayed. </para> - <para>The <emphasis role="bold"><property>&lt;rich:progressBar&gt;</property> </emphasis> component can be used in two modes: Ajax (default) and Client. In order to define the mode you need to use <emphasis><property>&quot;mode&quot;</property></emphasis> attribute. - </para> - <itemizedlist> - <listitem> - <para><property>Ajax</property> - polling is activated when the component is enabled to check its value. </para> - </listitem> - <listitem> - <para><property>Client</property> - component updates after its value changed through JavaScript API. </para> - </listitem> - </itemizedlist> + </section> <!-- End. Details of Usage-->