Author: cluts
Date: 2008-08-28 10:58:50 -0400 (Thu, 28 Aug 2008)
New Revision: 10225
Modified:
trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml
trunk/docs/userguide/en/src/main/docbook/included/suggestionbox.xml
Log:
RF-2305 - described new functions for suggestionbox and fileUpload
Modified: trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml 2008-08-28 14:49:55
UTC (rev 10224)
+++ trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml 2008-08-28 14:58:50
UTC (rev 10225)
@@ -414,15 +414,15 @@
</itemizedlist>
</para>
- <!--
- There is a number of facets providing for this component:
- <emphasis>
- <property>
"header"</property></emphasis>
-
- <emphasis>
- <property>
"footer"</property></emphasis>
- <emphasis>
- <property>
"label"</property></emphasis>. could be used to provide
displaying the progress of uploading.
+ <!--
+ There is a number of facets providing for this component:
+ <emphasis>
+ <property>
"header"</property></emphasis>
+
+ <emphasis>
+ <property>
"footer"</property></emphasis>
+ <emphasis>
+ <property>
"label"</property></emphasis>. could be used to provide
displaying the progress of uploading.
-->
<para>
@@ -579,7 +579,6 @@
<code>RICH_FILE_UPLOAD_ENTRY_CANCEL_LABEL</code> there. </para>
- <para> </para>
<para> The <emphasis role="bold">
<property><rich:fileUpload></property>
@@ -651,14 +650,16 @@
uploaded. </entry>
</row>
- <!-- <row>
- <entry>
- getUploadItems()
- </entry>
- <entry>
-
- </entry>
- </row>-->
+ <row>
+ <entry> getUploadItems()
</entry>
+ <entry> Returns the list of the
uploaded
+ files. If several files were
+ uploaded the first element of
+ this list will be returned. If
+ one file was uploaded, the
+ list consisting of one file
+ will be returned </entry>
+ </row>
</tbody>
</tgroup>
@@ -1597,36 +1598,36 @@
</section>
</section>
-<!--para>In order to encode form around <emphasis role="bold">
- <property><rich:fileUpload></property>
- </emphasis> component you could confine this area by <emphasis
role="bold">
- <property><h:form></property>
- </emphasis>/<emphasis role="bold">
- <property></h:form></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><rich:fileUpload></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><rich:fileUpload></property>
+ </emphasis> component you could confine this area by <emphasis
role="bold">
+ <property><h:form></property>
+ </emphasis>/<emphasis role="bold">
+ <property></h:form></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><rich:fileUpload></property>
+ </emphasis>at server-side</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/fileUpload11.png"/>
+ </imageobject>
+ </mediaobject>
</figure-->
Modified: trunk/docs/userguide/en/src/main/docbook/included/suggestionbox.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/suggestionbox.xml 2008-08-28
14:49:55 UTC (rev 10224)
+++ trunk/docs/userguide/en/src/main/docbook/included/suggestionbox.xml 2008-08-28
14:58:50 UTC (rev 10225)
@@ -249,8 +249,38 @@
you can find example of getting additional properties.
</para>
</section>
-
<section>
+ <title>JavaScript API</title>
+ <table>
+ <title>JavaScript API</title>
+
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Function</entry>
+
+ <entry>Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry>callSuggestion()</entry>
+ <entry>Calls the suggestion. If the "ignoreMinChars"
value is "true" then the number of symbols to send a query is no longer
actual for callSuggestion()</entry>
+ </row>
+
+ <row>
+ <entry>getSelectedItems()</entry>
+ <entry>Returns the array of objects</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+</section>
+
+ <section>
<title>Look-and-Feel Customization</title>
<para>For skinnability implementation, the components use a
<emphasis>
Show replies by date