Author: atsebro Date: 2008-09-16 11:24:34 -0400 (Tue, 16 Sep 2008) New Revision: 10454 Modified: trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml Log: RF-4080: Developer guide does not contain details for web.xml configuration to successfully integrate fileUpload component with myfaces framework Modified: trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml 2008-09-16 15:23:57 UTC (rev 10453) +++ trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml 2008-09-16 15:24:34 UTC (rev 10454) @@ -127,26 +127,26 @@ <programlisting role="XML"><![CDATA[... <rich:fileUpload uploadData="#{bean.data}" fileUploadListener="#{bean.listener}"/> ...]]></programlisting> - <para> + <para> The following methods of processing the uploaded files are: </para> - <itemizedlist> - <listitem> - <para> - <code>isMultiUpload()</code>. It returns &quot;true&quot; if several files have been uploaded - </para> + <itemizedlist> + <listitem> + <para> + <code>isMultiUpload()</code>. It returns &quot;true&quot; if several files have been uploaded + </para> </listitem> - <listitem> - <para> + <listitem> + <para> <code>getUploadItems()</code>. It returns the list of the uploaded files. - If one file was uploaded, the <code>getUploadItems()</code> method will return the list consisting of one file - </para> + If one file was uploaded, the <code>getUploadItems()</code> method will return the list consisting of one file + </para> </listitem> - <listitem> - <para> + <listitem> + <para> <code>getUploadItem()</code>. It returns the whole list in case of uploading one file only. If several files were uploaded, the <code>getUploadItem()</code> method will return the first element of the uploaded files list. - </para> - </listitem> + </para> + </listitem> </itemizedlist> <para> Automatically files uploading could be performed by means of the <emphasis> <property> &quot;immediateUpload&quot;</property> @@ -433,15 +433,15 @@ </itemizedlist> </para> - <!-- - There is a number of facets providing for this component: - <emphasis> - <property> &quot;header&quot;</property></emphasis> - - <emphasis> - <property> &quot;footer&quot;</property></emphasis> - <emphasis> - <property> &quot;label&quot;</property></emphasis>. could be used to provide displaying the progress of uploading. + <!-- + There is a number of facets providing for this component: + <emphasis> + <property> &quot;header&quot;</property></emphasis> + + <emphasis> + <property> &quot;footer&quot;</property></emphasis> + <emphasis> + <property> &quot;label&quot;</property></emphasis>. could be used to provide displaying the progress of uploading. --> <para> @@ -599,18 +599,15 @@ - <para> The <emphasis role="bold"> - <property>&lt;rich:fileUpload&gt;</property> - </emphasis> component could work together with Seam framework. <ulink - url="http://www.jboss.org/file-access/default/members/jbossrichfaces... - >Here</ulink> you can see how to configure filters for both - of them in web.xml file in order to handle <emphasis role="bold"> - <property>&lt;rich:fileUpload&gt;</property> - </emphasis> requests. </para> + <para> The <emphasis role="bold"><property>&lt;rich:fileUpload&gt;</property></emphasis> component could work together with Seam framework. + <ulink url="http://www.jboss.org/file-access/default/members/jbossrichfaces... + you can see how to configure filter for this framework in web.xml file in order to handle <emphasis role="bold"><property>&lt;rich:fileUpload&gt;</property></emphasis> requests. + </para> + <para>To make <property>&lt;rich:fileUpload&gt;</property> component work properly with MyFaces extensions, + the order in which filters are defined and mapped in web.xml, is important. + See <ulink url="http://www.jboss.org/file-access/default/members/jbossrichfaces... FAQ chapter</ulink>. + </para> - - - </section> <!-- JavaScript API--> <section> @@ -1598,36 +1595,36 @@ </section> </section> -<!--para>In order to encode form around <emphasis role="bold"> - <property>&lt;rich:fileUpload&gt;</property> - </emphasis> component you could confine this area by <emphasis role="bold"> - <property>&lt;h:form&gt;</property> - </emphasis>/<emphasis role="bold"> - <property>&lt;/h:form&gt;</property></emphasis> tags. - </para> - <para> - <emphasis role="bold">Example:</emphasis> - </para> - <programlisting role="XML"><![CDATA[... - <h:form> - <rich:fileUpload uploadData="#{bean.data}" addControlLabel="myLabel" autoclear="true" maxFilesQuantity="2" fileUploadListener="#{bean.listener}" - acceptedTypes="html" immediateUpload="true"/> - <a4j:commandLink style="font-weight: bold; width: 200px;" value="Show files uploaded:" reRender="files_list"> - <h:dataTable value="#{bean.fileList}" var="file" id="files_list" style="width: 500px"> - <h:column> - <h:outputText value="#{file.fileName}"></h:outputText> - </h:column> - </h:dataTable> - </h:form> - ...]]></programlisting> - <para>This is a result:</para> - <figure> - <title><emphasis role="bold"> - <property>&lt;rich:fileUpload&gt;</property> - </emphasis>at server-side</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/fileUpload11.png"/> - </imageobject> - </mediaobject> +<!--para>In order to encode form around <emphasis role="bold"> + <property>&lt;rich:fileUpload&gt;</property> + </emphasis> component you could confine this area by <emphasis role="bold"> + <property>&lt;h:form&gt;</property> + </emphasis>/<emphasis role="bold"> + <property>&lt;/h:form&gt;</property></emphasis> tags. + </para> + <para> + <emphasis role="bold">Example:</emphasis> + </para> + <programlisting role="XML"><![CDATA[... + <h:form> + <rich:fileUpload uploadData="#{bean.data}" addControlLabel="myLabel" autoclear="true" maxFilesQuantity="2" fileUploadListener="#{bean.listener}" + acceptedTypes="html" immediateUpload="true"/> + <a4j:commandLink style="font-weight: bold; width: 200px;" value="Show files uploaded:" reRender="files_list"> + <h:dataTable value="#{bean.fileList}" var="file" id="files_list" style="width: 500px"> + <h:column> + <h:outputText value="#{file.fileName}"></h:outputText> + </h:column> + </h:dataTable> + </h:form> + ...]]></programlisting> + <para>This is a result:</para> + <figure> + <title><emphasis role="bold"> + <property>&lt;rich:fileUpload&gt;</property> + </emphasis>at server-side</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/fileUpload11.png"/> + </imageobject> + </mediaobject> </figure-->