[richfaces-svn-commits] JBoss Rich Faces SVN: r7129 - trunk/docs/userguide/en/src/main/docbook/included.

Author: msorokin Date: 2008-03-24 13:20:10 -0400 (Mon, 24 Mar 2008) New Revision: 7129 Modified: trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml Log: http://jira.jboss.com/jira/browse/RF-1690 Some code samples and descripions were corrected. Modified: trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml 2008-03-24 17:19:03 UTC (rev 7128) +++ trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml 2008-03-24 17:20:10 UTC (rev 7129) @@ -96,7 +96,7 @@ <para> Displaying information on a progress bar can be also performed using - <property>&lt;h:outputText&gt;</property> JSF tag within + <property>&lt;h:outputText&gt;</property> within <emphasis role="bold"><property>&lt;rich:progressBar&gt;</property> </emphasis> tags passing the progress value to the value of the JSF tag. </para> @@ -105,8 +105,8 @@ </para> <programlisting role="XML"><![CDATA[... -<rich:progressBar value="#{bean.incValue1}" > - <h:outputText value="#{bean.incValue1}"></h:outputText> +<rich:progressBar value="#{bean.incValue1}"> + <h:outputText value="#{bean.incValue1}"/> </rich:progressBar> ...]]> </programlisting> @@ -132,7 +132,7 @@ <programlisting role="XML"><![CDATA[... <rich:progressBar value="#{bean.incValue1}" enabled="#{bean.enabled1}" id="progrs1" progressVar="progress"> - <h:outputText value="{progress}%"></h:outputText> + <h:outputText value="{progress}%"/> </rich:progressBar> ...]]> </programlisting> @@ -144,26 +144,23 @@ <emphasis><property>&quot;value&quot;</property></emphasis> attribute of a <emphasis role="bold"><property>&lt;rich:progressBar&gt;</property> </emphasis> - and transfers the received data to the &quot;value&quot; attribute of <property>&lt;h:outputText&gt;</property> JSF tag, to make the data appear on the page. + and transfers the received data to the &quot;value&quot; attribute of <property>&lt;h:outputText&gt;</property>, to make the data appear on the page. </para> <!--Macrosubs--> - - - <para> The <emphasis role="bold"><property>&lt;rich:progressBar&gt;</property> </emphasis> component provides 3 predefined macrosubstitution parameters: <itemizedlist> <listitem> - <para><property><emphasis><property>{value}</property></emphasis></property> contains <emphasis><property>&quot;value&quot;</property></emphasis></para> + <para><property><emphasis><property>{value}</property></emphasis></property> contains the current value</para> </listitem> <listitem> - <para><property><emphasis><property>{minValue}</property></emphasis></property> contains <emphasis><property>&quot;minValue&quot;</property></emphasis></para> + <para><property><emphasis><property>{minValue}</property></emphasis></property> contains min value</para> </listitem> <listitem> - <para><property><emphasis><property>{maxValue}</property></emphasis></property> contains <emphasis><property>&quot;maxValue&quot;</property></emphasis></para> + <para><property><emphasis><property>{maxValue}</property></emphasis></property> contains max value</para> </listitem> </itemizedlist> @@ -174,7 +171,7 @@ </para> <programlisting role="XML"><![CDATA[... <rich:progressBar value="#{bean.incValue1}" minValue="400" maxValue="900"> - <h:outputText value="Min value is {minValue}, current value is {value}, max value is {maxValue}"></h:outputText> + <h:outputText value="Min value is {minValue}, current value is {value}, max value is {maxValue}"/> </rich:progressBar> ...]]> </programlisting> <figure> @@ -185,10 +182,6 @@ </imageobject> </mediaobject> </figure> - - - - <!--END of Macrosubs--> <!-- Parameters--> <para> @@ -205,7 +198,7 @@ <programlisting role="XML"><![CDATA[... <progressBar:progressBar value="#{bean.incValue1}" parameters="param:'#{bean.incValue1}'"> - <h:outputText value="{param}%"></h:outputText> + <h:outputText value="{param}%"/> </progressBar:progressBar> ...]]> </programlisting> @@ -227,18 +220,6 @@ - - <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> - <para> - <emphasis role="bold">Example:</emphasis> - </para> - <programlisting role="XML"><![CDATA[... -<rich:progressBar progressVar="progress" parameters="param1:'1'" > - <h:outputText="{param1} task #{progress} %"/> -</rich:progressBar> -...]]> </programlisting> <para> The component can also employ <emphasis><property> &quot;initial&quot;</property></emphasis> and <emphasis><property> &quot;complete&quot;</property></emphasis> @@ -249,12 +230,12 @@ <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... -<rich:progressBar value="#{bean.incValue1}" > +<rich:progressBar value="#{bean.incValue1}"> <f:facet name="initial"> - <h:outputText value="Process not started"></h:outputText> + <h:outputText value="Process not started"/> </f:facet> <f:facet name="complete"> - <h:outputText value="Process completed"></h:outputText> + <h:outputText value="Process completed"/> </f:facet> </rich:progressBar> ...]]> </programlisting> @@ -270,8 +251,7 @@ <para><property>Client</property> - component updates after its value changed through JavaScript API. </para> </listitem> </itemizedlist> - - + </section> <!-- End. Details of Usage--> @@ -643,18 +623,16 @@ </mediaobject> </figure> <para>In the example the &quot;remained&quot; part of progress area is modified with a background-color CSS property.</para> - - - - - + <para>It&apos;s aslo possible to change styles of a particular <emphasis role="bold"> <property>&lt;rich:progressBar&gt;</property></emphasis> component. In this case you should create own style classes and use them in corresponding <emphasis role="bold"><property>&lt;rich:progressBar&gt;</property></emphasis> <property>styleClass</property> attributes. An example is placed below:</para> <para> <emphasis role="bold">Example:</emphasis> </para> <programlisting role="CSS"><![CDATA[... -.RremainClass{ background-color: #ebf3fd;} +.myClass{ +background-color: #ebf3fd; +} ...]]></programlisting> <para>The <emphasis><property>&quot;styleClass&quot;</property></emphasis> attribute for <emphasis role="bold" @@ -662,7 +640,7 @@ <para> <emphasis role="bold">Example:</emphasis> </para> - <programlisting role="CSS"><![CDATA[<rich:progressBar value="#{bean.incValue1}" styleClass="remainClass" /> + <programlisting role="CSS"><![CDATA[<rich:progressBar value="#{bean.incValue1}" styleClass="myClass"/> ]]></programlisting> <para>This is a result:</para>