Author: msorokin
Date: 2008-06-24 12:36:56 -0400 (Tue, 24 Jun 2008)
New Revision: 9202
Modified:
trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml
Log:
http://jira.jboss.com/jira/browse/RF-2305
New JS API functions added
Modified: trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml 2008-06-24 15:51:44
UTC (rev 9201)
+++ trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml 2008-06-24 16:36:56
UTC (rev 9202)
@@ -418,9 +418,84 @@
<entry>clear()</entry>
<entry>Clears list of files</entry>
</row>
+
+ <row>
+ <entry>$('id').component.entries</entry>
+ <entry>Returns a array of all files in the listмассив всех
файлов в списке
+
+ $('id').component.entries.length --- количество
файлов в списке
+
+ $('id').component.entries[0].fileName --- имя файла
+ </entry>
+ </row>
+
+
</tbody>
</tgroup>
</table>
+
+
+
+
+
+ <table>
+ <title>Client side object properties</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Objects</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+
+ <row>
+ <entry>$('id').component.entries</entry>
+ <entry>Returns a array of all files in the listмассив всех
файлов в списке
+
+ </entry>
+ </row>
+
+
+
+ <row>
+
<entry>$('id').component.entries.length</entry>
+ <entry>Returns the number of files in the list
</entry>
+ </row>
+
+
+ <row>
+
<entry>$('id').component.entries[0].fileName</entry>
+ <entry>Returns the file name, that is retrieved by the
array index </entry>
+ </row>
+
+
+
+ <row>
+ <entry>$('id').component.entries[0].state
</entry>
+ <entry>Returns the file state. Possible states are
+ <itemizedlist>
+
+
<listitem><para>"initialized" - the file is
added</para> </listitem>
+ <listitem><para>"progress"
- the file is being uploaded</para> </listitem>
+ <listitem><para>"ready" -
uploading is in process. The file will be uploaded on queue order.</para>
</listitem>
+ <listitem><para>"canceled"
- uploading of the file is canceled </para> </listitem>
+ <listitem><para>"done" -
the file is uploaded successfully</para> </listitem>
+ <listitem><para>"transfer_error’
" - a file transfer error occurred </para> </listitem>
+ <listitem><para>"size_error’
" - the file exceeded maximum size</para> </listitem>
+
+
+ </itemizedlist>
+
+
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+
+
</section>
<!-- End of JavaScript API-->
<section>