[richfaces-svn-commits] JBoss Rich Faces SVN: r7029 - in trunk: ui/fileUpload/src/main/config/component and 1 other directory.

Author: vsukhov Date: 2008-03-20 14:33:13 -0400 (Thu, 20 Mar 2008) New Revision: 7029 Modified: trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml trunk/ui/fileUpload/src/main/config/component/fileUpload.xml Log: http://jira.jboss.com/jira/browse/RF-1207 I've added the description of attributes, Added some information about immediateUpload attribute Modified: trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml 2008-03-20 18:25:06 UTC (rev 7028) +++ trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml 2008-03-20 18:33:13 UTC (rev 7029) @@ -173,13 +173,26 @@ <rich:fileUpload uploadData="#{bean.data}" addControlLabel="myLabel" autoclear="true" maxFilesQuantity="2" fileUploadListener="#{bean.listener}" acceptedTypes="html"/> ...]]></programlisting> + <para>The <emphasis> + <property> &quot;immediateUpload&quot;</property></emphasis> attribute allows files to be uploaded immediately after they have been added into list. + If you set this attribute to true files immediately uploads after they have been added into list, all next files automatically uploads one by one. + If you cancel uploading – next files aren't start uploading till you press the general upload button or clear the list. + + </para> + <para> + <emphasis role="bold">Example:</emphasis> + </para> + <programlisting role="XML"><![CDATA[... +<rich:fileUpload uploadData="#{bean.data}" addControlLabel="myLabel" autoclear="true" maxFilesQuantity="2" fileUploadListener="#{bean.listener}" + acceptedTypes="html" immediateUpload="true"/> + ...]]></programlisting> <para>The <emphasis role="bold"> <property>&lt;rich:fileUpload&gt;</property> </emphasis> provides using a number of handlers. The <emphasis> <property> &quot;onupload&quot;</property></emphasis> is available to cancel the upload at client side. The <emphasis> <property> &quot;onuploadcomplete&quot;</property></emphasis> is called after all files in from list uploaded. The <emphasis> <property> &quot;onuploadcanceled&quot;</property></emphasis> is called after upload was canceled via cancel control. The <emphasis> - <property> &quot;onerror&quot;</property></emphasis> is if the file upload was interrupted according to any errors.</para> + <property> &quot;onerror&quot;</property></emphasis> is called if the file upload was interrupted according to any errors.</para> <para> There are a number of facets providing for this component: <emphasis> Modified: trunk/ui/fileUpload/src/main/config/component/fileUpload.xml =================================================================== --- trunk/ui/fileUpload/src/main/config/component/fileUpload.xml 2008-03-20 18:25:06 UTC (rev 7028) +++ trunk/ui/fileUpload/src/main/config/component/fileUpload.xml 2008-03-20 18:33:13 UTC (rev 7029) @@ -67,17 +67,17 @@ <description>Collection of files uploaded</description> </property> <property elonly="true" hidden="true" existintag="false" exist="false" > - <name>contentType</name> + <name>contentType</name> <classname>java.lang.Object</classname> </property> <property elonly="true" hidden="true" existintag="false" exist="false" > - <name>fileName</name> + <name>fileName</name> <classname>java.lang.Object</classname> </property> <property elonly="true" hidden="true" existintag="false" exist="false" > - <name>fileSize</name> + <name>fileSize</name> <classname>java.lang.Object</classname> - </property> + </property> <property hidden="true" existintag="false" exist="false" > <name>progressInfo</name> <classname>java.lang.Object</classname> @@ -186,7 +186,7 @@ <name>disabled</name> <classname>boolean</classname> <description> - Disabled attribute + Attribute 'disabled' provides possibility to make the whole component disabled if its value equals to "true". </description> <defaultvalue>false</defaultvalue> </property> @@ -216,75 +216,121 @@ <property> <name>onupload</name> <classname>java.lang.String</classname> + <description>A JavaScript event handler called on an upload operation</description> </property> <property> <name>onuploadcomplete</name> <classname>java.lang.String</classname> + <description>A JavaScript event handler called when upload is completed</description> </property> <property> <name>onuploadcanceled</name> <classname>java.lang.String</classname> + <description>A JavaScript event handler called when upload is cancelled</description> </property> <property> <name>onerror</name> <classname>java.lang.String</classname> + <description>A JavaScript event handler called when the file upload was interrupted according to any errors</description> </property> <property> <name>addControlLabel</name> <classname>java.lang.String</classname> + <description>Defines a label for an add control</description> </property> <property> <name>uploadControlLabel</name> <classname>java.lang.String</classname> + <description>Defines a label for an upload control</description> </property> <property> <name>stopControlLabel</name> <classname>java.lang.String</classname> + <description>Defines a label for a stop control</description> </property> <property> <name>cancelEntryControlLabel</name> <classname>java.lang.String</classname> + <description>Defines a label for a cancel control</description> </property> <property> <name>clearControlLabel</name> <classname>java.lang.String</classname> + <description>Defines a label for a clear control</description> </property> <property> <name>clearAllControlLabel</name> <classname>java.lang.String</classname> + <description>Defines a label for a clearAll control</description> </property> <property> <name>stopEntryControlLabel</name> <classname>java.lang.String</classname> - </property> - <property elonly="true" hidden="true" existintag="false" exist="false" > - <name>size</name> - <classname>java.lang.Object</classname> - </property> - <property elonly="true" hidden="true" existintag="false" exist="false" > - <name>localContentType</name> - <classname>java.lang.Object</classname> - </property> - <property elonly="true" hidden="true" existintag="false" exist="false" > - <name>localFileName</name> - <classname>java.lang.Object</classname> - </property> - <property elonly="true" hidden="true" existintag="false" exist="false" > - <name>localFileSize</name> - <classname>java.lang.Object</classname> - </property> - <property elonly="true" hidden="true" existintag="false" exist="false" > - <name>localInputStream</name> - <classname>java.lang.Object</classname> - </property> - <property elonly="true" hidden="true" existintag="false" exist="false" > - <name>localValueSet</name> - <classname>java.lang.Object</classname> - </property> - <property elonly="true" hidden="true" existintag="false" exist="false" > - <name>maxLength</name> - <classname>java.lang.Object</classname> + <description>Defines a label for a stop control</description> </property> + <property> + <name>locale</name> + <classname>java.lang.Object</classname> + <description>Used for locale definition</description> + + </property> + <property> + <name>requiredMessage</name> + <classname>java.lang.String</classname> + <description> + A ValueExpression enabled attribute that, if present, + will be used as the text of the validation message for + the "required" facility, if the "required" facility is + used + </description> + </property> + <property> + <name>converterMessage</name> + <classname>java.lang.String</classname> + <description> + A ValueExpression enabled attribute that, if present, + will be used as the text of the converter message, + replacing any message that comes from the converter + </description> + </property> + <property> + <name>validatorMessage</name> + <classname>java.lang.String</classname> + <description> + A ValueExpression enabled attribute that, if present, + will be used as the text of the validator message, + replacing any message that comes from the validator + </description> + </property> + + <property elonly="true" hidden="true" existintag="false" exist="false" > + <name>size</name> + <classname>java.lang.Object</classname> + </property> + <property elonly="true" hidden="true" existintag="false" exist="false" > + <name>localContentType</name> + <classname>java.lang.Object</classname> + </property> + <property elonly="true" hidden="true" existintag="false" exist="false" > + <name>localFileName</name> + <classname>java.lang.Object</classname> + </property> + <property elonly="true" hidden="true" existintag="false" exist="false" > + <name>localFileSize</name> + <classname>java.lang.Object</classname> + </property> + <property elonly="true" hidden="true" existintag="false" exist="false" > + <name>localInputStream</name> + <classname>java.lang.Object</classname> + </property> + <property elonly="true" hidden="true" existintag="false" exist="false" > + <name>localValueSet</name> + <classname>java.lang.Object</classname> + </property> + <property elonly="true" hidden="true" existintag="false" exist="false" > + <name>maxLength</name> + <classname>java.lang.Object</classname> + </property> </component> &listeners; </components>