[richfaces-svn-commits] JBoss Rich Faces SVN: r13574 - trunk/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Tue Apr 14 10:55:19 EDT 2009
Author: ochikvina
Date: 2009-04-14 10:55:18 -0400 (Tue, 14 Apr 2009)
New Revision: 13574
Modified:
trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml
Log:
https://jira.jboss.org/jira/browse/RF-6754 - the Details of Usage for rich:progressBar is updated as the component is deprecated;
Modified: trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml 2009-04-14 14:50:14 UTC (rev 13573)
+++ trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml 2009-04-14 14:55:18 UTC (rev 13574)
@@ -82,10 +82,7 @@
<para>
In order to define the mode you need to use <emphasis><property>"mode"</property></emphasis> attribute.
</para>
-
-
-
-
+
<para>
One of the key attributes of the component is <emphasis><property>"interval"</property></emphasis> which defines the frequency of status polling and rerenders the component when the value is updated.
</para>
@@ -126,10 +123,6 @@
</para>
-
-
-
-
<para>
<emphasis role="bold">Example:</emphasis>
</para>
@@ -147,24 +140,6 @@
</mediaobject>
</figure>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
<!--para>
The <emphasis><property> "label"</property></emphasis> attribute is responsible for displaying informational
@@ -224,54 +199,6 @@
</itemizedlist>
-
- <!--para>
- The <emphasis><property> "progressVar"</property></emphasis> attribute serves to provide an option for a
- value substitution on the page. It defines a variable that contains the
- data taken from
- <emphasis><property>"value"</property></emphasis> attribute.
- The sole purpose of the
- <emphasis><property> "progressVar"</property></emphasis>
- attribute is to provide a way to use the data placed into the
- <emphasis><property>"value"</property></emphasis> attribute.
- Please study carefully the following code example:
- </para-->
-
- <para>
- The <emphasis><property>"progressVar"</property></emphasis> attribute (deprecated) defines request scoped variable that could be used
- for substitution purpose. This variable contains the data taken from <emphasis><property>"value"</property></emphasis> attribute.
- Please, study carefully the following example.
- </para>
- <para>
- <emphasis role="bold">Example:</emphasis>
- </para>
- <programlisting role="XML"><![CDATA[...
-<rich:progressBar value="#{bean.incValue1}" enabled="#{bean.enabled1}" id="progrs1" progressVar="progress">
- <h:outputText value="{progress}%"/>
-</rich:progressBar>
-...]]> </programlisting>
-
-
- <!--para>
- In the shown example <emphasis><property> "progressVar"</property></emphasis> attribute
- gets the "progress" value which contains data taken from
- <emphasis><property>"value"</property></emphasis>
- attribute of a
- <emphasis role="bold"><property><rich:progressBar></property> </emphasis>
- and transfers the received data to the "value" attribute of <property><h:outputText></property>, to make the data appear on the page.
- </para-->
-
- <para>
- In the shown example <emphasis><property> "progressVar"</property></emphasis> attribute
- defines a variable "progress" with the value taken from <emphasis><property>"value"</property></emphasis>
- attribute of the <emphasis role="bold"><property><rich:progressBar></property></emphasis> component.
- The "progress" variable performs substitution passing the current progress value to the
- <emphasis><property>"value"</property></emphasis> attribute of the
- <emphasis role="bold"><property><h:outputText></property></emphasis>.
- This is how the current value of a progress appears on
- the label of <emphasis role="bold"><property><rich:progressBar></property></emphasis>.
- </para>
-
<!--Macrosubs-->
<para>
@@ -310,6 +237,7 @@
</mediaobject>
</figure>
<!--END of Macrosubs-->
+
<!-- Parameters-->
<!--para>
The <emphasis><property>"parameters"</property></emphasis>
@@ -317,13 +245,8 @@
All you need is to define a value of your own parameter
(e.g parameters="param:'#{bean.incValue1}'")
and you can use it to pass the data.
- </para-->
-
-
+ </para-->
-
-
-
<para>
The <emphasis><property>"parameters"</property></emphasis>
is also a special attribute which defines parameters that can be to get additional data from server (e.g. additional info about process status).
@@ -341,7 +264,7 @@
<h:outputText value="download speed {param} KB/s"/>
</rich:progressBar>
...]]> </programlisting>
- <para>This is the result</para>
+ <para>This is the result:</para>
<figure>
<title>Usage of parameters</title>
<mediaobject>
@@ -355,10 +278,43 @@
<!-- END Parameters-->
-
+ <para>
+ The <emphasis><property>"progressVar"</property></emphasis> attribute (deprecated) defines request scoped variable that could be used
+ for substitution purpose. This variable contains the data taken from <emphasis><property>"value"</property></emphasis> attribute.
+ Please, study carefully the following example.
+ </para>
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[...
+<rich:progressBar value="#{bean.incValue1}" enabled="#{bean.enabled1}" id="progrs1" progressVar="progress">
+ <h:outputText value="{progress}%"/>
+</rich:progressBar>
+...]]> </programlisting>
-
+ <para>In the shown example <emphasis><property> "progressVar"</property></emphasis> attribute
+ defines a variable "progress" with the value taken from <emphasis><property>"value"</property></emphasis>
+ attribute of the <emphasis role="bold"><property><rich:progressBar></property></emphasis> component.
+ The "progress" variable performs substitution passing the current progress value to the
+ <emphasis><property>"value"</property></emphasis> attribute of the
+ <emphasis role="bold"><property><h:outputText></property></emphasis>.
+ This is how the current value of a progress appears on
+ the label of <emphasis role="bold"><property><rich:progressBar></property></emphasis>.</para>
+
+ <para>As the
+ <emphasis><property> "progressVar"</property></emphasis> attribute is deprecated, it's better to use
+ the predefined macrosubstitution parameter <code>{value}</code> instead. See how you can rewrite the above example with the help of <code>{value}</code>.
+ </para>
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[...
+<rich:progressBar value="#{bean.incValue1}" enabled="#{bean.enabled1}" id="progrs1">
+ <h:outputText value="{value}%"/>
+</rich:progressBar>
+...]]> </programlisting>
+
<para>
The component can also employ <emphasis><property> "initial"</property></emphasis> and <emphasis><property> "complete"</property></emphasis> facets to display the states of the process:
<emphasis><property>"initial"</property></emphasis> facet is displayed when the progress value is less or equal to <emphasis><property> "minValue"</property></emphasis>, and the <emphasis><property>"complete"</property></emphasis> facet is shown when the value is greater or equal to <emphasis><property> "maxValue"</property></emphasis>. Please see an example below.
More information about the richfaces-svn-commits
mailing list