[richfaces-svn-commits] JBoss Rich Faces SVN: r12292 - tags/3.3.0.GA/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Thu Jan 15 11:34:47 EST 2009
Author: artdaw
Date: 2009-01-15 11:34:46 -0500 (Thu, 15 Jan 2009)
New Revision: 12292
Modified:
tags/3.3.0.GA/docs/userguide/en/src/main/docbook/included/editor.desc.xml
tags/3.3.0.GA/docs/userguide/en/src/main/docbook/included/editor.xml
tags/3.3.0.GA/docs/userguide/en/src/main/docbook/included/queue.xml
Log:
https://jira.jboss.org/jira/browse/RF-5704 - mistakes were corrected
Modified: tags/3.3.0.GA/docs/userguide/en/src/main/docbook/included/editor.desc.xml
===================================================================
--- tags/3.3.0.GA/docs/userguide/en/src/main/docbook/included/editor.desc.xml 2009-01-15 16:34:01 UTC (rev 12291)
+++ tags/3.3.0.GA/docs/userguide/en/src/main/docbook/included/editor.desc.xml 2009-01-15 16:34:46 UTC (rev 12292)
@@ -32,7 +32,7 @@
<listitem><para>Seam text support</para></listitem>
<listitem><para>Manageable global configurations</para></listitem>
<listitem><para>Possibility to use custom plug-ins</para></listitem>
- <listitem><para>Support of all TinyMCE's parameters through <f:param></para></listitem>
+ <listitem><para>Support of all TinyMCE's parameters through <emphasis role="bold"><property><f:param></property></emphasis></para></listitem>
</itemizedlist>
Modified: tags/3.3.0.GA/docs/userguide/en/src/main/docbook/included/editor.xml
===================================================================
--- tags/3.3.0.GA/docs/userguide/en/src/main/docbook/included/editor.xml 2009-01-15 16:34:01 UTC (rev 12291)
+++ tags/3.3.0.GA/docs/userguide/en/src/main/docbook/included/editor.xml 2009-01-15 16:34:46 UTC (rev 12292)
@@ -75,9 +75,7 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
-<programlisting role="XML"><![CDATA[
- <rich:editor value="#{bean.editorValue}" />
-]]></programlisting>
+<programlisting role="XML"><![CDATA[<rich:editor value="#{bean.editorValue}" />]]></programlisting>
<para>
Implementation of <emphasis role="bold"><property><rich:editor></property></emphasis> provides three ways to define the properties of the component:
</para>
@@ -106,7 +104,7 @@
<para>
Another useful property that is implemented at attribute level is <emphasis><property>"viewMode"</property></emphasis>.
The attribute switches between "visual" and "source" modes, toggling between modes is performed setting the attribute to "visual" and "source" respectively.
- Implementation of <emphasis role="bold"><property><rich:editor></property></emphasis> also implies that you can change the modes dynamically setting the value of the <property>"viewMode"</property> attribute using EL-expression.
+ Implementation of <emphasis role="bold"><property><rich:editor></property></emphasis> also implies that you can change the modes dynamically setting the value of the <emphasis><property>"viewMode"</property></emphasis> attribute using EL-expression.
</para>
<para>
@@ -265,7 +263,7 @@
</listitem>
<listitem>
<para>
- Use the <property>"customPlugins"</property> attribute to specify the .properties file with a plugin name and a path to it.
+ Use the <emphasis><property>"customPlugins"</property></emphasis> attribute to specify the .properties file with a plugin name and a path to it.
</para>
<para>
If your .properties file is named "myPlugins", then your will have this code on the page.
@@ -306,7 +304,7 @@
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
-<rich:editor value="#{bean.editorValue}"onchange="myCustomOnChangeHandler()" ... />
+<rich:editor value="#{bean.editorValue}" onchange="myCustomOnChangeHandler()" />
...]]></programlisting>
</listitem>
<listitem>
@@ -321,7 +319,7 @@
</para>
<programlisting role="XML"><![CDATA[...
<rich:editor value="#{bean.editorValue}">
- <f:param name="onchange" value="myCustomOnChangeHandler">
+ <f:param name="onchange" value="myCustomOnChangeHandler" />
</rich:editor>
...]]></programlisting>
</listitem>
@@ -331,7 +329,7 @@
component has a build-in converter that renders HTML code generated by the editor
to Seam text (you can read more Seam text <ulink url="http://docs.jboss.org/seam/1.1.5.GA/reference/en/html/text.html">here</ulink>.), it also interprets Seam text
passed to the <emphasis role="bold"> <property><rich:editor></property></emphasis> and renders it to HTML.
- The converter can be enable with the <emphasis><property>"seamTest"</property></emphasis> attribute.</para>
+ The converter can be enable with the <emphasis><property>"useSeamText"</property></emphasis> attribute.</para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
Modified: tags/3.3.0.GA/docs/userguide/en/src/main/docbook/included/queue.xml
===================================================================
--- tags/3.3.0.GA/docs/userguide/en/src/main/docbook/included/queue.xml 2009-01-15 16:34:01 UTC (rev 12291)
+++ tags/3.3.0.GA/docs/userguide/en/src/main/docbook/included/queue.xml 2009-01-15 16:34:46 UTC (rev 12292)
@@ -45,9 +45,10 @@
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[<h:form>
- ...
- <a4j:queue/>
- ...
+ <a4j:queue />
+ <h:inputText value="#{bean.a}">
+ <a4j:support event="onkeyup" />
+ </h:inputText>
</h:form>
]]></programlisting>
</section>
@@ -101,18 +102,18 @@
</para>
<programlisting role="XML"><![CDATA[...
<h:form>
-<a4j:queue size="2" requestDelay="500" sizeExceededBehavior="dropNext" onsizeexceeded="alert('The size of the queue is exceeded')" />
-<h:inputText value="#{bean.a}" >
-<a4j:support event="onkeyup" />
-</h:inputText>
-<h:inputText value="#{bean.b}" >
-<a4j:support event="onblur" />
-<h:selectBooleanCheckbox value="#{bean.check}" id="checkboxID" >
-<a4j:support id="checkboxSupport" event="onchange" />
-</h:selectBooleanCheckbox>
+ <a4j:queue size="2" requestDelay="500" sizeExceededBehavior="dropNext" onsizeexceeded="alert('The size of the queue is exceeded')" />
+ <h:inputText value="#{bean.a}">
+ <a4j:support event="onkeyup" />
+ </h:inputText>
+ <h:inputText value="#{bean.b}">
+ <a4j:support event="onblur" />
+ </h:inputText>
+ <h:selectBooleanCheckbox value="#{bean.check}" id="checkboxID">
+ <a4j:support id="checkboxSupport" event="onchange" />
+ </h:selectBooleanCheckbox>
</h:form>
...]]></programlisting>
-
<para>
In this example if the queue has more than 2 requests waiting to be processed the next event will be dropped and a message (the <emphasis><property>"onsizeexceeded"</property></emphasis> attribute fires a JavaScript function ) saying that the queues is exceeded will be displayed.
</para>
@@ -127,34 +128,31 @@
</para>
<programlisting role="XML"><![CDATA[...
<h:form>
-<a4j:queue requestDelay="500" ignoreDupResponses="true" />
-<h:inputText value="#{bean.a}" >
-<a4j:support event="onkeyup" />
+ <a4j:queue requestDelay="500" ignoreDupResponses="true" />
+ <h:inputText value="#{bean.a}">
+ <a4j:support event="onkeyup" />
+ </h:inputText>
</h:form>
...]]></programlisting>
-
-
<para>In this example, the requests are glued together and only the last one is submitted.</para>
-
-
<para>Another key attribute that easies revers load is <emphasis><property
>"timeout"</property></emphasis>.
The attribute specifies the amount of time an item can be in the queue before the sent event is be aborted and dropped from the queue.
</para>
- <para>
- <emphasis role="bold"> Example: </emphasis>
- </para>
<para>If the request is sent and response is not returned within the
time frame defined in this attribute - the request is aborted, and the next one is sent.
</para>
-
+ <para>
+ <emphasis role="bold"> Example: </emphasis>
+ </para>
<programlisting role="XML"><![CDATA[...
<h:form>
-<a4j:queue timeout="1000" />
-<h:inputText value="#{bean.a}" >
-<a4j:support event="onkeyup" />
+ <a4j:queue timeout="1000" />
+ <h:inputText value="#{bean.a}" >
+ <a4j:support event="onkeyup" />
+ </h:inputText>
</h:form>
...]]></programlisting>
@@ -178,13 +176,13 @@
</para>
<programlisting role="XML"><![CDATA[...
<h:form >
-<a4j:queue oncomplete="alert(request.queue.getSize())" requestDelay="1000" />
-
-<h:inputText value="#{bean.a}" >
-<a4j:support event="onkeyup" />
-<h:selectBooleanCheckbox value="#{bean.check}" >
-<a4j:support event="onchange"/>
-</h:selectBooleanCheckbox>
+ <a4j:queue oncomplete="alert(request.queue.getSize())" requestDelay="1000" />
+ <h:inputText value="#{bean.a}">
+ <a4j:support event="onkeyup" />
+ </h:inputText>
+ <h:selectBooleanCheckbox value="#{bean.check}">
+ <a4j:support event="onchange"/>
+ </h:selectBooleanCheckbox>
</h:form>
...]]></programlisting>
@@ -210,7 +208,6 @@
<row>
<entry>Function</entry>
<entry>Description</entry>
-
</row>
</thead>
<tbody>
@@ -223,12 +220,7 @@
<row>
<entry>getMaximumSize()</entry>
<entry>Returns the maximum size to the queue, specified in the "size" attribute</entry>
-
</row>
-
-
-
-
</tbody>
</tgroup>
</table>
More information about the richfaces-svn-commits
mailing list