From richfaces-svn-commits at lists.jboss.org Wed Jan 5 00:28:29 2011 Content-Type: multipart/mixed; boundary="===============1838693151998918615==" 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: r20885 - in modules/docs/trunk/Component_Reference/src/main/docbook/en-US: extras and 1 other directory. Date: Wed, 05 Jan 2011 00:28:29 -0500 Message-ID: <201101050528.p055SThL020070@svn01.web.mwc.hst.phx2.redhat.com> --===============1838693151998918615== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: SeanRogers Date: 2011-01-05 00:28:28 -0500 (Wed, 05 Jan 2011) New Revision: 20885 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo= nent_Reference-Rich_inputs.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exa= m-Component_Reference-richfileUpload-Basic_usage.xml_sample Log: Updated fileUpload based on technical review RFPL-972 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha= p-Component_Reference-Rich_inputs.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-Rich_inputs.xml 2011-01-05 00:46:22 UTC (rev 20884) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Rich_inputs.xml 2011-01-05 05:28:28 UTC (rev 20885) @@ -426,13 +426,13 @@
<sgmltag><rich:fileUpload></sgmltag> - The <rich:fileUpload> component allows the use= r to upload files to a server. It features multiple uploads, automatic uplo= ads, progress bars, restrictions on file types and sizes to be uploaded, an= d an embedded Flash module. + The <rich:fileUpload> component allows the use= r to upload files to a server. It features multiple uploads, progress bars,= restrictions on file types, and restrictions on sizes to be uploaded. =
Basic usage - Basic usage requires the uploadData attribute, poin= ting to the collection of uploaded files. + Basic usage requires the fileUploadListener attribu= te. Use the attribute to call a function on the server side after each file= is uploaded. Basic usage @@ -440,23 +440,67 @@
= -
- Interactivity options +
+ Upload settings - Files are uploaded to either the temporary folder (different for each = operating system) or to RAM (random-access memory), depe= nding on the value of the createTempFile parameter o= f the Ajax4jsf Filter section in the web.xml for the p= roject. + Files are uploaded to either the temporary folder (different for each = operating system) or to RAM (random-access memory), depe= nding on the value of the org.richfaces.fileUpload.createTempFil= e parameter of the web.xml settings file f= or the project. If the parameter is set to true, the fil= es are uploaded to the temporary folder. - Use the fileUploadListener attribute to call a func= tion on the server side after each file is uploaded. + To limit the maximum size of the uploaded files, define the byte size = with the org.richfaces.fileUpload.maxRequestSize par= ameter of the web.xml settings file for the project. +
+ +
+ Interactivity options + - The text labels used in the component can be completely customized. La= bels for the various controls of the component can be set using ad= dControlLabel, clearAllControlLabel, = clearControlLabel, stopEntryControlLabel, and = uploadControlLabel. The status label for the upload can = be set using the label attribute and the following wildc= ards: + The text labels used in the component can be completely customized. La= bels for the various controls of the component can be set using the followi= ng parameters: + + + addLabel + + + The addLabel parameter sets the label for the Add button. + + + + + clearAllLabel + + + The clearAllLabel parameter sets the label for t= he Clear All button. + + + + + clearLabel + + + The clearLabel parameter sets the label for the = Clear button. + + + + + uploadLabel + + + The uploadLabel parameter sets the label for the= Upload button. + + + + + + + The progress of a file upload operation can be represented using eithe= r a referencing <rich:progressBar> component, or t= he progress facet. Refer to for details on the <rich:progressBar> component. + + + To disable the <rich:fileUpload> component, u= se the disabled attribute. +
- +
<sgmltag><rich:fileUpload></sgmltag> client-side events</t= itle> <para> There are a number of event handlers specific to the <sgmltag><rich= :fileUpload></sgmltag> component: </para> <itemizedlist> + <!-- <listitem> <para> <varname>onadd</varname> is triggered before a file is added to the = list. </para> </listitem> + --> <listitem> <para> - <varname>onupload</varname> is triggered before a file is uploaded. + <varname>onfilesubmit</varname> is triggered before a file is upload= ed. </para> </listitem> <listitem> @@ -504,6 +557,7 @@ <varname>onuploadcomplete</varname> is triggered after all files in = the list have finished uploading. </para> </listitem> + <!-- <listitem> <para> <varname>onuploadcanceled</varname> is triggered after an upload has= been canceled. @@ -514,6 +568,7 @@ <varname>onerror</varname> is triggered when an error occurs during = the upload process. </para> </listitem> + --> </itemizedlist> </section> = @@ -522,29 +577,24 @@ <itemizedlist> <listitem> <para> - <parameter>component-type</parameter>: <classname>org.richfaces.file= Upload</classname> + <parameter>component-type</parameter>: <classname>org.richfaces.File= Upload</classname> </para> </listitem> <listitem> <para> - <parameter>component-class</parameter>: <classname>org.richfaces.com= ponent.html.HtmlFileUpload</classname> + <parameter>component-class</parameter>: <classname>org.richfaces.com= ponent.UIFileUpload</classname> </para> </listitem> <listitem> <para> - <parameter>component-family</parameter>: <classname>org.richfaces.fi= leUpload</classname> + <parameter>component-family</parameter>: <classname>org.richfaces.Fi= leUpload</classname> </para> </listitem> <listitem> <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.rende= rkit.inplaceFileUpload</classname> + <parameter>renderer-type</parameter>: <classname>org.richfaces.FileU= ploadRenderer</classname> </para> </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.fi= leUploadTag</classname> - </para> - </listitem> </itemizedlist> </section> </section> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/ext= ras/exam-Component_Reference-richfileUpload-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-richfileUpload-Basic_usage.xml_sample 2011-01-05 00:= 46:22 UTC (rev 20884) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex= am-Component_Reference-richfileUpload-Basic_usage.xml_sample 2011-01-05 05:= 28:28 UTC (rev 20885) @@ -1 +1 @@ -<rich:fileUpload uploadData=3D"#{bean.data}" /> +<rich:fileUpload fileUploadListener=3D"#{bean.listener}" /> --===============1838693151998918615==--