From richfaces-svn-commits at lists.jboss.org Thu Sep 30 02:53:16 2010 Content-Type: multipart/mixed; boundary="===============0832320334363294286==" 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: r19388 - in modules/docs/trunk/Component_Reference/src/main/docbook/en-US: extras and 1 other directory. Date: Thu, 30 Sep 2010 02:53:16 -0400 Message-ID: <201009300653.o8U6rGDw007744@svn01.web.mwc.hst.phx2.redhat.com> --===============0832320334363294286== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: SeanRogers Date: 2010-09-30 02:53:15 -0400 (Thu, 30 Sep 2010) New Revision: 19388 Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exa= m-Component_Reference-richprogressBar-Basic_usage.xml_sample Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_= Reference.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo= nent_Reference-Output_and_messages.xml Log: Added rich:progressBar Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Com= ponent_Reference.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 --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component= _Reference.xml 2010-09-29 20:27:22 UTC (rev 19387) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component= _Reference.xml 2010-09-30 06:53:15 UTC (rev 19388) @@ -25,7 +25,9 @@ + Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha= p-Component_Reference-Output_and_messages.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 --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Output_and_messages.xml 2010-09-29 20:27:22 UTC (rev 19387) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Output_and_messages.xml 2010-09-30 06:53:15 UTC (rev 19388) @@ -3,9 +3,19 @@ ]> Output and messages + + + Documentation in development + + Some concepts covered in this chapter may refer to the previous version= of Richfaces, version 3.3.3. This chapter is sc= heduled for review to ensure all information is up to date. + + Read this chapter for details on components that display messages and ot= her feedback to the user. + = + + = + + = - + = +
<sgmltag><rich:progressBar></sgmltag> The <rich:progressBar> component displays a pr= ogress bar to indicate the status of a process to the user. It can update e= ither through Ajax or on the client side, and the look and feel can be full= y customized. +
+ <sgmltag><rich:progressBar></sgmltag> + + + + + + + A <rich:progressBar> component. The bar has= progressed to 50% of the total time. + + + +
+ = +
+ Basic usage + + Basic usage of the <rich:progressBar> compone= nt requires only the value attribute, which points to th= e method that provides the current progress. + + + Basic usage + + +
+ = +
+ Customizing the appearance + + By default, the minimum value of the progress bar is 0 and the maximum value of the progress bar is 100. Th= ese values can be customized using the minValue and maxValue attributes respectively. + + + The progress bar can be labeled in one of two ways: + + + + Using the label attribute + + + The content of the label attribute is displayed = over the progress bar. + + + Using the <varname>label</varname> attribute + + + + + + Using nested child components + + + Child components, such as the JSF <h:outputText> component, can be nested in the <rich:progressBar> component to display over the progress bar. + + + Using nested child components + + + + + + + For labeling, the <rich:progressBar> componen= t recognizes three macro-substitution parameters: + + + + {value} + + + The current progress value. + + + + + {minValue} + + + The minimum value for the progress bar. + + + + + {maxValue} + + + The maximum value for the progress bar. + + + + + + Using macro-substitution for labeling + + + + Additionally, you can use the {param} parameter to = specify any custom parameters you require. Define the parameters in the bea= n for the progress method, then reference it with the <rich:pro= gressBar> component's parameters attribute,= as shown in . + + + Using the <varname>param</varname> parameter + + + + To define customized initial and complete states for the progress bar,= use the initial and complete facets.= The initial facet displays when the progress value is l= ess than or equal to the minimum value, and the complete= facet displays when the progress value is greater than or equal to the max= imum value. + + + Initial and complete states + + +
+ = +
+ Using set intervals + + The <rich:progressBar> component can be set t= o constantly poll for updates at a constant interval. Use the inte= rval component to set the interval in milliseconds. The progress = bar is updated whenever the polled value changes. Polling is only active wh= en the enabled attribute is set to true. + + + Using set intervals + + +
+ = +
+ Update mode + + The mode for updating the progress bar is determined by the mode= attribute, which can have one of the following values: + + + + ajax + + + The progress bar updates in the same way as the <a4j:po= ll> component. The <rich:progressBar>= component repeatedly polls the server for the current progress value. + + + + + client + + + The progress bar updates on the client side, set using the JavaScri= pt API. + + + + +
= + + + --> = Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras= /exam-Component_Reference-richprogressBar-Basic_usage.xml_sample =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 --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex= am-Component_Reference-richprogressBar-Basic_usage.xml_sample = (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex= am-Component_Reference-richprogressBar-Basic_usage.xml_sample 2010-09-30 06= :53:15 UTC (rev 19388) @@ -0,0 +1 @@ + --===============0832320334363294286==--