Author: msorokin Date: 2008-03-06 11:08:28 -0500 (Thu, 06 Mar 2008) New Revision: 6605 Modified: trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml Log: http://jira.jboss.com/jira/browse/RF-1690 Some sentences were amended. Modified: trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml 2008-03-06 16:06:40 UTC (rev 6604) +++ trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml 2008-03-06 16:08:28 UTC (rev 6605) @@ -47,15 +47,7 @@ <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... - <rich:progressBar value="#{bean.incValue}" enabled="#{bean.enabled}" id="progrs" action="#{bean.action}" > - <f:facet name="initial"> - <h:outputText value="Process not started"></h:outputText> - </f:facet> - <f:facet name="complete"> - <h:outputText value="Process completed"></h:outputText> - </f:facet> - <h:outputText value="{value}%" ></h:outputText> - </rich:progressBar> +<progressBar:progressBar value="#{bean.incValue1}"/> ...]]></programlisting> </section> <section> @@ -75,20 +67,6 @@ As it was mentioned above, the <emphasis role="bold"><property>&lt;rich:progressBar&gt;</property> </emphasis> component displays the status of the ongoing process. The component has a number of key attributes. </para> - <para> - The <emphasis><property> &quot;label&quot;</property></emphasis> attribute is responsible for displaying informational - data on the progress bar, if it&apos;s not displayed using children components. - If this attribute is not set and the children components are not used either, no textual information - regarding ongoing process will be indicated. - In order to indicate the current status you need to pass the value to this attribute. Please see an example. - </para> - <para> - <emphasis role="bold">Example:</emphasis> - </para> - <programlisting role="XML"><![CDATA[... -<rich:progressBar value="#{bean.incValue}" id="progrs" label="{value}%" > -</rich:progressBar> -...]]></programlisting> <para> The <emphasis><property>&quot;value&quot;</property></emphasis> attribute sets the current value of the process. Status of the process is calculated basing on <property> &quot;value&quot;</property> attribute. </para> @@ -107,11 +85,9 @@ </para> <programlisting role="XML"><![CDATA[... -<rich:progressBar value="#{bean.incValue}" enabled="#{bean.enabled}" id="progrs" +<rich:progressBar value="#{bean.incValue}" minValue="50" - maxValue="400"> - <h:outputText value="{value}%" ></h:outputText> -</rich:progressBar> + maxValue="400"/> ...]]> </programlisting> <para> The <emphasis><property>&quot;interval&quot;</property></emphasis>attribute defines the frequency of status polling. Polling is active while the component is operational. </para> <para> @@ -119,12 +95,8 @@ </para> <programlisting role="XML"><![CDATA[... -<rich:progressBar value="#{bean.incValue}" enabled="#{bean.enabled}" id="progrs" - nterval="900" > - . . . -</rich:progressBar> +<rich:progressBar value="#{bean.incValue}" " id="progrs" interval="900"/> ...]]> </programlisting> - <para> The <emphasis><property>&quot;parameters&quot;</property></emphasis>attribute allows to send some dynamical data to the component which is displayed in the informational part. Parameters can be passed through <emphasis><property>&quot;parameters&quot;</property></emphasis> attribute, or from component control.</para> @@ -132,42 +104,56 @@ <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... -<rich:progressBar ... progressVar="progress" parameters="param1:'1'" > +<rich:progressBar progressVar="progress" parameters="param1:'1'" > <h:outputText="{param1} task #{progress} %"/> </rich:progressBar> ...]]> </programlisting> - <para> - The component can also employ the following facets to display the <property> &quot;initial&quot;</property> and <property> &quot;complete&quot;</property> states of the process: + <para> + The <emphasis><property> &quot;label&quot;</property></emphasis> attribute is responsible for displaying informational + data on the progress bar, if it&apos;s not displayed using children components. + If this attribute is not set and the children components are not used either, no textual information + regarding ongoing process will be indicated. + In order to indicate the current status you need to pass the value to this attribute. Please see an example. + </para> + <para> + <emphasis role="bold">Example:</emphasis> </para> + <programlisting role="XML"><![CDATA[... +<rich:progressBar value="#{bean.incValue}" id="progrs" label="{value}%" > +</rich:progressBar> +...]]></programlisting> + + <para> In order to display textual and numerical information on the progress bar (as it was said above this can be aslo performed using <emphasis><property> &quot;label&quot;</property></emphasis> attribute ) you can also use this code: + </para> <para> <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... -<f:facet name="initial"> - <h:outputText value="Process not started" /> -</f:facet> -...]]></programlisting> +<h:outputText value="{value}%" ></h:outputText> +...]]></programlisting> + <para> - and + The component can also employ <emphasis><property> &quot;initial&quot;</property></emphasis> and <emphasis><property> &quot;complete&quot;</property></emphasis> + facets to display the states of the process: <emphasis><property> &quot;initial&quot;</property></emphasis> facet is displayed when the progress value is less or equal to <emphasis><property> &quot;minValue&quot;</property></emphasis> + , and the <emphasis><property> &quot;complete&quot;</property></emphasis> facet is shown when the value is greater or equal to <emphasis><property> &quot;maxValue&quot;</property></emphasis>. Please see an example below. </para> <para> <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... -<f:facet name="complete"> - <h:outputText value="Process completed" /> -</f:facet> +<progressBar:progressBar value="#{bean.incValue1}" > + <f:facet name="initial"> + <h:outputText value="Process not started"></h:outputText> + </f:facet> + <f:facet name="complete"> + <h:outputText value="Process completed"></h:outputText> + </f:facet> +</progressBar:progressBar> ...]]> </programlisting> - <para> However, the usage of these facets is optional. If you omit them nothing will be displayed. </para> - - <para> In order to display textual and numerical information on the progress bar (as it was said above this can be aslo performed using <emphasis><property> &quot;label&quot;</property></emphasis> attribute ) you need to use this code: </para> - <para> - <emphasis role="bold">Example:</emphasis> + <para> However, the usage of these facets is optional. If you omit them nothing will be displayed. </para> - <programlisting role="XML"><![CDATA[... -<h:outputText value="{value}%" ></h:outputText> -...]]></programlisting> - <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> + <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>