[richfaces-svn-commits] JBoss Rich Faces SVN: r2269 - trunk/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Wed Aug 15 10:06:00 EDT 2007
Author: vkukharchuk
Date: 2007-08-15 10:06:00 -0400 (Wed, 15 Aug 2007)
New Revision: 2269
Modified:
trunk/docs/userguide/en/src/main/docbook/included/actionparam.xml
trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml
trunk/docs/userguide/en/src/main/docbook/included/commandButton.xml
trunk/docs/userguide/en/src/main/docbook/included/commandLink.xml
trunk/docs/userguide/en/src/main/docbook/included/form.xml
trunk/docs/userguide/en/src/main/docbook/included/htmlCommandLink.xml
trunk/docs/userguide/en/src/main/docbook/included/include.xml
trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml
trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml
trunk/docs/userguide/en/src/main/docbook/included/loadBundle.xml
trunk/docs/userguide/en/src/main/docbook/included/loadScript.xml
trunk/docs/userguide/en/src/main/docbook/included/loadStyle.xml
trunk/docs/userguide/en/src/main/docbook/included/log.xml
trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml
trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml
trunk/docs/userguide/en/src/main/docbook/included/page.xml
trunk/docs/userguide/en/src/main/docbook/included/poll.xml
trunk/docs/userguide/en/src/main/docbook/included/portlet.xml
trunk/docs/userguide/en/src/main/docbook/included/push.xml
trunk/docs/userguide/en/src/main/docbook/included/region.xml
trunk/docs/userguide/en/src/main/docbook/included/repeat.xml
trunk/docs/userguide/en/src/main/docbook/included/status.xml
trunk/docs/userguide/en/src/main/docbook/included/support.xml
Log:
http://jira.jboss.com/jira/browse/RF-597
Modified: trunk/docs/userguide/en/src/main/docbook/included/actionparam.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/actionparam.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/actionparam.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -54,7 +54,7 @@
<title>Key attributes and ways of usage</title>
<para>The component <emphasis role="bold">
<property><a4j:actionparam></property>
- </emphasis> is a combination of the functionalityity of two JSF tags: <emphasis role="bold">
+ </emphasis> is a combination of the functionality of two JSF tags: <emphasis role="bold">
<property><f:param></property>
</emphasis> and <emphasis role="bold">
<property><f:actionListener></property>
@@ -88,8 +88,11 @@
<section>
<title>Relevant resources links</title>
- <para>More information can be found on the <ulink
- url="http://www.jboss.com/index.html?module=bb&op=viewtopic&p=4063764"
+ <para>More information can be found on the <ulink url="http://www.jboss.com/index.html?module=bb&op=viewtopic&p=4063764"
>Ajax4JSF Users Forum</ulink>.</para>
+ <para>
+ To see how component works on practice, look at a4j-actionparam example from
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/actionparam.jsf?c=actionparam">RichFaces Live Demo</ulink>.
+ </para>
</section>
</chapter>
Modified: trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -28,7 +28,7 @@
</tgroup>
</table>
- <!--
+
<section>
<title>Creating on a page</title>
<para>Simple Component definition on a page:</para>
@@ -37,14 +37,14 @@
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="XML"><![CDATA[<a4j:ajaxListenet type=""/>
+ <programlisting role="XML"><![CDATA[...
+ <a4j:ajaxListener type="demo.Bean"/>
+...
]]></programlisting>
</section>
- -->
-
+
<section>
<title>Dynamical creation of a component from Java code</title>
-
<para>
<emphasis role="bold">Example:</emphasis>
<programlisting role="JAVA"><![CDATA[import org.ajax4jsf.component.html.AjaxListener;
@@ -66,9 +66,51 @@
a good place for update the list of re-rendered components, for example.
Ajax Listener is not invoked for non-Ajax request and when RichFaces works in "Ajax Request generates
Non-Ajax Response" mode. Therefore, Ajax Listener invocation is a good indicator that Ajax response is going to be processed.
-Attribute 'type' defines the fully qualified Java class name for listener. This class should implement org.ajax4jsf.events.AjaxListener interface.
-You can access to the source of the event (Ajax component) using event.getSource() call.
+Attribute 'type' defines the fully qualified Java class name for listener. This class should implement org.ajax4jsf.framework.ajax.AjaxListener
+interface. You can access to the source of the event (Ajax component) using event.getSource() call.
</para>
+ </section>
+ <section>
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+
+ <programlisting role="XML"><![CDATA[...
+
+ <a4j:commandLink id="cLink" value="Click it To Send Ajax Request">
+ <a4j:ajaxListener type="demo.Bean"/>
+ </a4j:commandLink>
+...
+]]></programlisting>
+
+<para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+
+ <programlisting role="XML"><![CDATA[
+package demo;
+
+import org.ajax4jsf.framework.ajax.AjaxEvent;
+
+public class Bean implements org.ajax4jsf.framework.ajax.AjaxListener{
+
+...
+ public void processAjax(AjaxEvent arg0){
+ //Custom Developer Code
+ }
+...
+}
+]]></programlisting>
+ </section>
+
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/ajaxListener.jsf?c=ajaxListener">here.
+ </ulink>
+ </para>
</section>
+
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/src/main/docbook/included/commandButton.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/commandButton.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/commandButton.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -52,12 +52,20 @@
<para>The component <emphasis role="bold"><property><a4j:commandButton></property></emphasis> placed on a page generates the following HTML code:</para>
<programlisting role="XHTML"><![CDATA[<input type="submit" onclick="A4J.AJAX.Submit(...request parameters);return false;" value="sort"/>
]]></programlisting>
- <para>Hence, the utility method "A4J.AJAX.Submit" is called on a click, the method performs Ajax request as the <emphasis role="bold"><property><a4j:support></property></emphasis> component</para>
+ <para>Hence, the utility method "A4J.AJAX.Submit" is called on a click, the method performs AJAX request as the <emphasis role="bold"><property><a4j:support></property></emphasis> component</para>
<note>
<title>Note:</title>
<para>AJAX support is built in and it's not necessary to add nested <emphasis role="bold"><property><a4j:support></property></emphasis> to the component.</para>
</note>
<para>Common JSF navigation could be performed after an AJAX submit and partial rendering, but Navigation Case must be defined as <emphasis role="bold"><property><redirect/></property></emphasis> in order to avoid problems with some browsers.</para>
- <para>As any Ajax4jsf component sending Ajax requests and processing server responses <emphasis role="bold"><property><a4j:commandButton></property></emphasis> has all attributes described above (see <emphasis role="bold"><property><a4j:support></property></emphasis> chapter) that provide the required behavior of requests sending (delay, limitation of submit area and rendering, and etc.)</para>
+ <para>As any Ajax4jsf component sending AJAX requests and processing server responses <emphasis role="bold"><property><a4j:commandButton></property></emphasis> has all attributes described above (see <emphasis role="bold"><property><a4j:support></property></emphasis> chapter) that provide the required behavior of requests sending (delay, limitation of submit area and rendering, and etc.)</para>
</section>
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/commandButton.jsf?c=commandButton">here.
+ </ulink>
+ </para>
+ </section>
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/src/main/docbook/included/commandLink.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/commandLink.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/commandLink.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -61,12 +61,22 @@
<span style="color: black;">Link Value</span>
</a>
]]></programlisting>
- <para>Hence, the utility method "A4J.AJAX.Submit" is called on a click, the method performs Ajax request as the <emphasis role="bold"><property><a4j:support></property></emphasis> component</para>
+ <para>Hence, the utility method "A4J.AJAX.Submit" is called on a click, the method performs AJAX request as the <emphasis role="bold"><property><a4j:support></property></emphasis> component</para>
<note>
<title>Note:</title>
<para>AJAX support is built in and it's not necessary to add nested <emphasis role="bold"><property><a4j:support></property></emphasis> to the component.</para>
</note>
<para>Common JSF navigation could be performed after AJAX submit and partial rendering, but Navigation Case must be defined as <emphasis role="bold"><property><redirect/></property></emphasis> in order to avoid problems with some browsers.</para>
- <para>As any Ajax4jsf component sending Ajax requests and processing server responses <emphasis role="bold"><property><a4j:commandLink></property></emphasis> has all attributes described above (see <emphasis role="bold"><property><a4j:support></property></emphasis> chapter) that provide the required behavior of requests sending (delay, limitation of submit area and rendering, etc.)</para>
+ <para>As any Ajax4jsf component sending AJAX requests and processing server responses <emphasis role="bold"><property><a4j:commandLink></property></emphasis> has all attributes described above (see <emphasis role="bold"><property><a4j:support></property></emphasis> chapter) that provide the required behavior of requests sending (delay, limitation of submit area and rendering, etc.)</para>
</section>
+
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/commandLink.jsf?c=commandLink">here.
+ </ulink>
+ </para>
+ </section>
+
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/src/main/docbook/included/form.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/form.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/form.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -53,7 +53,7 @@
</section>
<section>
<title>Key attributes and ways of usage</title>
- <para>The difference with the original component is that all hidden fields required for command links are always rendered and it doesn't depend on links rendering on the initial page. It solves the problem with invalid links that weren't rendered on a page immediately, but after some Ajax request.</para>
+ <para>The difference with the original component is that all hidden fields required for command links are always rendered and it doesn't depend on links rendering on the initial page. It solves the problem with invalid links that weren't rendered on a page immediately, but after some AJAX request.</para>
<para>Beginning with release 1.0.5 additional attributes that make this form variant universal have appeared. With a new attribute definition as ajax=<emphasis >
<property>"true"</property>
</emphasis>, it becomes possible to set AJAX submission way for any components inside, i.e. not a page URL is used as an <emphasis >
@@ -84,4 +84,12 @@
<property><a4j:support></property>
</emphasis>.</para>
</section>
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/form.jsf?c=form">here.
+ </ulink>
+ </para>
+ </section>
</chapter>
Modified: trunk/docs/userguide/en/src/main/docbook/included/htmlCommandLink.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/htmlCommandLink.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/htmlCommandLink.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -57,7 +57,7 @@
<title>Key attributes and ways of usage</title>
<para>The difference with the original component is that all hidden fields required for command links with the child <emphasis role="bold">
<property><f:param></property>
- </emphasis> elements are always rendered and it doesn't depend on links rendering on the initial page. It solves the problem with invalid links that weren't rendered on a page immediately, but after some Ajax request.</para>
+ </emphasis> elements are always rendered and it doesn't depend on links rendering on the initial page. It solves the problem with invalid links that weren't rendered on a page immediately, but after some AJAX request.</para>
<para>
<emphasis role="bold">Example:</emphasis>
@@ -74,6 +74,15 @@
<property><a4j:htmlCommandLink></property>
</emphasis>works as standard <emphasis role="bold">
<property><h:commandLink></property>
- </emphasis>, but here hidden fields required for correct functionalityity are rendered before the first downloading of a page, though it doesn't happen if its attribute isn't set to "false".</para>
+ </emphasis>, but here hidden fields required for correct functionality are rendered before the first downloading of a page, though it doesn't happen if its attribute isn't set to "false".</para>
</section>
+ <!--
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/htmlCommandLink.jsf?c=htmlCommandLink">here.
+ </ulink>
+ </para>
+ </section> -->
</chapter>
Modified: trunk/docs/userguide/en/src/main/docbook/included/include.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/include.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/include.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -42,7 +42,7 @@
<a4j:include viewId="/pages/include/first.xhtml" />
</h:panelGroup>
]]></programlisting>
-<para>For navigation inside a page defined in viewId any components responsible for Ajax requests to the server generation are used.</para>
+<para>For navigation inside a page defined in viewId any components responsible for AJAX requests to the server generation are used.</para>
<para>For example, the following component on the page "/pages/include/first.xhtml"</para>
<para>
@@ -65,7 +65,7 @@
</navigation-case>
</navigation-rule>
]]></programlisting>
-<para>In this case after a click on a button defined inside "first.xhtml" view, navigation is performed after an Ajax request (the same as standard JSF one) only inside this view.</para>
+<para>In this case after a click on a button defined inside "first.xhtml" view, navigation is performed after an AJAX request (the same as standard JSF one) only inside this view.</para>
</section>
<section>
<title>Dynamical creation of a component from Java code</title>
@@ -75,7 +75,7 @@
]]></programlisting>
<para>If <emphasis role="bold">
<property><a4j:include></property>
- </emphasis> is defined this way, any Ajax request returning outcome inside generates navigation with this <emphasis role="bold">
+ </emphasis> is defined this way, any AJAX request returning outcome inside generates navigation with this <emphasis role="bold">
<property><a4j:include></property>
</emphasis>.</para>
<para>Ajax Action for navigation implementation inside view must be placed inside <emphasis role="bold">
@@ -97,6 +97,8 @@
<title>Relevant resources links</title>
<para>
Some additional information can be found on the <ulink url="http://jboss.com/index.html?module=bb&op=viewtopic&t=104158">Ajax4Jsf Users Forum.</ulink>
- </para>
+ </para><!--
+ To see how component works on practice, look at a4j-include example from
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/include.jsf?c=include">RichFaces Live Demo</ulink>. -->
</section>
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -72,9 +72,9 @@
the page fired after calling function. </para>
<para> When using the <emphasis role="bold">
<property><a4j:jsFunction></property>
- </emphasis> it's possible to initiate the Ajax request from the JavaScript and
+ </emphasis> it's possible to initiate the AJAX request from the JavaScript and
perform partial update of a page and/or invoke the JavaScript function with data returned by
- Ajax response. </para>
+ AJAX response. </para>
<programlisting role="XML"><![CDATA[...
<body onload="callScript()">
...
@@ -96,13 +96,13 @@
<property><a4j:actionparam></property>
</emphasis> or pure <emphasis role="bold">
<property><f:param></property>
- </emphasis> for passing any number of parameters of the JavaScript function into Ajax request.
+ </emphasis> for passing any number of parameters of the JavaScript function into AJAX request.
<emphasis role="bold">
<property><a4j:jsFunction></property>
</emphasis> is similar to <emphasis role="bold">
<property><a4j:commandButton></property>
</emphasis>, but it could be activated from the JavaScript code. It allows to invoke some
- server side functionalityity and use the returned data in the JavaScript function invoked from
+ server side functionality and use the returned data in the JavaScript function invoked from
"oncomplete" attribute. So it's possible to use <emphasis
role="bold">
<property><a4j:jsFunction></property>
@@ -116,6 +116,6 @@
<para> To see how <emphasis role="bold">
<property><a4j:jsFunction></property>
</emphasis> works on practice, look at a4j-jsFunction example from <ulink
- url="http://labs.jboss.com/jbossajax4jsf/demo/index.html">here</ulink>.</para>
+ url="http://livedemo.exadel.com/richfaces-demo/richfaces/jsFunction.jsf?c=jsFunction">here</ulink>.</para>
</section>
</chapter>
Modified: trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -84,7 +84,7 @@
<section>
<title>Relevant resources links</title>
<para>
- Some additional information about usage of components can be found <ulink url="http://jboss.com/index.html?module=bb&op=viewtopic&t=104989">here.
+ Some additional information about usage of component can be found <ulink url="http://jboss.com/index.html?module=bb&op=viewtopic&t=104989">here.
</ulink>
</para>
</section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/loadBundle.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/loadBundle.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/loadBundle.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -44,7 +44,7 @@
<emphasis role="bold">Example:</emphasis>
<programlisting role="JAVA"><![CDATA[import org.ajax4jsf.component.html.AjaxLoadBundle;
...
-LoadBundle myBundle = new LoadBundle();
+AjaxLoadBundle myBundle = new AjaxLoadBundle();
...
]]></programlisting>
</para>
@@ -68,7 +68,7 @@
</emphasis> are unavailable.
Instead of
<emphasis role="bold"><property><f:loadBundle></property>
- </emphasis> that could be located anywhere on the page, the
+ </emphasis> that might be located anywhere on the page, the
<emphasis role="bold"><property><a4j:loadBundle></property>
</emphasis> should be declared inside the
@@ -82,4 +82,12 @@
</para>
</section>
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/bundle.jsf?c=loadBundle">here.
+ </ulink>
+ </para>
+ </section>
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/src/main/docbook/included/loadScript.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/loadScript.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/loadScript.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -68,4 +68,14 @@
page while using <property>facelets templates</property> .
</para>
</section>
+
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/script.jsf?c=loadScript">here.
+ </ulink>
+ </para>
+ </section>
+
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/src/main/docbook/included/loadStyle.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/loadStyle.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/loadStyle.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -55,7 +55,7 @@
<section>
<title>Key attributes and ways of usage</title>
<para>
- As it was mentioned <link linkend="loadStyle">before</link> this component returns its value passing it to the
+ As it was mentioned <link linkend="loadStyle">before</link> this componment returns its value passing it to the
getResourceUR() method of the ViewHandler for this application, and passing
the result via the encodeResourceURL() method of the ExternalContext.
</para>
@@ -68,5 +68,13 @@
page while using <property>facelets templates</property> .
</para>
</section>
-
+
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/log.jsf?c=log">here.
+ </ulink>
+ </para>
+ </section>
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/src/main/docbook/included/log.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/log.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/log.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -66,7 +66,16 @@
<para>The component defined this way is decoded on a page as <emphasis role="bold"><property><div></property></emphasis> inside a page, where all the information beginning with informational message is generated.</para>
<note>
<title>Note:</title>
- <para><emphasis role="bold"><a4j:log></emphasis> is getting renewed automatically after execution of Ajax requests. Don't renew <emphasis role="bold"><a4j:log></emphasis> by using reRender!</para>
+ <para><emphasis role="bold"><a4j:log></emphasis> is getting renewed automatically after execution of ajax requests. Don't renew <emphasis role="bold"><a4j:log></emphasis> by using reRender!</para>
</note>
</section>
+ <!--
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/log.jsf?c=log">here.
+ </ulink>
+ </para>
+ </section> -->
</chapter>
Modified: trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -94,6 +94,15 @@
</itemizedlist>
<note><title>Note:</title>A bean class transmitted into value should implement Serializable interface.
</note>
- <para>Hence, when using the component it's possible to output user data of any type on a page with Ajax requests.</para>
+ <para>Hence, when using the component it's possible to output user data of any type on a page with AJAX requests.</para>
</section>
+ <!--
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/mediaOutput.jsf?c=mediaOutput">here.
+ </ulink>
+ </para>
+ </section> -->
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -66,7 +66,7 @@
To speed up the performance, Ajax4jsf updates only a component tree. <emphasis role="bold">
<property><a4j:outputPanel></property>
- </emphasis> usage is recommended for wrapping components that aren't rendered during the primary non-Ajax response, as the components don't present in a component tree.
+ </emphasis> usage is recommended for wrapping components that aren't rendered during the primary non-ajax response, as the components don't present in a component tree.
</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting role="XML"><![CDATA[<a4j:support ... reRender="mypanel"/>
@@ -130,7 +130,11 @@
<section>
<title>Relevant resources links</title>
<para>
- Some additional information about usage of component can be found <ulink url="http://www.jboss.com/index.html?module=bb&op=viewtopic&p=4052203#4052203">here</ulink>.
+ Some additional information about usage of component can be found
+ <ulink url="http://www.jboss.com/index.html?module=bb&op=viewtopic&p=4052203#4052203">here</ulink>.
+ <!--
+ To see how component works on practice, look at a4j-outputPanel example from
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/outputPanel.jsf?c=outputPanel">RichFaces Live Demo</ulink>. -->
</para>
</section>
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/src/main/docbook/included/page.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/page.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/page.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -87,13 +87,19 @@
<section>
<title>Relevant resources links</title>
- <para>All other component functionalityity is the same as of <emphasis role="bold">
+ <para>All other component functionality is the same as of <emphasis role="bold">
<a4j:region>.
</emphasis> Its desctriprion could be found
<member>
<ulink url="http://webdownload.exadel.com/downloads/ajax4jsf/documentation/tldDoc/">here</ulink>.
</member>
- </para>
+ </para>
+ <!--
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/page.jsf?c=page">here.
+ </ulink>
+ </para> -->
</section>
</chapter>
Modified: trunk/docs/userguide/en/src/main/docbook/included/poll.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/poll.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/poll.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -85,6 +85,11 @@
The aditional information about component usage you can find here:<ulink url="http://jboss.com/index.html?module=bb&op=viewtopic&t=103909">Ajax4Jsf Users Forum.
</ulink>
</para>
+
+ <para>
+ To see how component works on practice, look at a4j-poll example from
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/poll.jsf?c=poll">RichFaces Live Demo</ulink>.
+ </para>
</section>
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/src/main/docbook/included/portlet.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/portlet.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/portlet.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -1,4 +1,4 @@
-<?xml version='1.0' encoding='UTF-8'?>
+<?xml version='1.0' encoding='UTF-8'?>
<chapter>
<table>
@@ -56,7 +56,7 @@
<para>
Portal page can include some instances of the same portlet but clientId of elements should be different for each window.
In that case 'namespace' is used for each portlet. The <emphasis role="bold"><property><a4j:portlet></property></emphasis>
- implements NaimingContainer interface and adds namespace to all components on a page.
+ implemets NaimingContainer interface and adds namespace to all componets on a page.
All portlet content should be wrapped by <emphasis role="bold"><property><a4j:portlet></property></emphasis> for resolving problems mentioned
before.
</para>
@@ -65,7 +65,7 @@
<section>
<title>Relevant resources links</title>
<para>
- The additional information about component usage you can find here:
+ The aditional information about component usage you can find here:
<ulink url="http://www.jboss.com/index.html?module=bb&op=viewtopic&t=107325">Ajax4Jsf Users Forum.
</ulink>
</para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/push.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/push.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/push.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -61,7 +61,9 @@
'interval' - Interval (in ms) for call push requests. Default value 1000 (1 sec).
<!-- If "0" a connection is permanent. Also user can set different value for parameter 'timeout'. -->
</para>
+<para>
Code for registration of listener:
+</para>
<programlisting role="JAVA"><![CDATA[
public void addListener(EventListener listener) {
synchronized (listener) {
@@ -70,16 +72,26 @@
}
]]></programlisting>
-
+<para>
Component can get message using current code:
+</para>
<programlisting role="JAVA"><![CDATA[
System.out.println("event occurs");
synchronized (listener) {
listener.onEvent(new EventObject(this));
}
]]></programlisting>
-
+<para>
Thus, component 'push' uses asynchronous model instead of polls.
-
+</para>
</section>
+ <!--
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/push.jsf?c=push">here.
+ </ulink>
+ </para>
+ </section> -->
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/src/main/docbook/included/region.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/region.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/region.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -117,4 +117,12 @@
region and encode performance time is reduced. This optimization doesn't allow data update out of the
region and should be implemented very carefully. The data out of the region described with "renderRegionOnly"="false" is updated successfully.</para>
</section>
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/region.jsf?c=region">here.
+ </ulink>
+ </para>
+ </section>
</chapter>
Modified: trunk/docs/userguide/en/src/main/docbook/included/repeat.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/repeat.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/repeat.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -59,7 +59,7 @@
<title>Key attributes and ways of usage</title>
<para>The main difference of this component from iterative components of other libraries is a special <emphasis >
<property>"ajaxKeys"</property>
- </emphasis> attribute. This attribute defines strings that are updated after an Ajax request. As a result it becomes easier to update several child components separately without updating the whole page.</para>
+ </emphasis> attribute. This attribute defines strings that are updated after an AJAX request. As a result it becomes easier to update several child components separately without updating the whole page.</para>
<programlisting role="JSP"><![CDATA[<a4j:poll intervall="1000" action="#{repeater.action}" reRender="list">
...
<table>
@@ -80,7 +80,7 @@
</emphasis> is output.</para>
<para>In the above-mentioned example the component <emphasis role="bold">
<property><a4j:poll></property>
- </emphasis> sends Ajax requests every second, calling the <emphasis >
+ </emphasis> sends AJAX requests every second, calling the <emphasis >
<property>"action"</property>
</emphasis> method of the <emphasis >
<property>"repeater"</property>
@@ -115,4 +115,13 @@
<property><ui:repeat></property>
</emphasis>) and are used in the same way.</para>
</section>
+ <!--
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/repeat.jsf?c=repeat">here.
+ </ulink>
+ </para>
+ </section> -->
</chapter>
\ No newline at end of file
Modified: trunk/docs/userguide/en/src/main/docbook/included/status.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/status.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/status.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -71,7 +71,7 @@
</section>
<section>
<title>Key attributes and ways of usage</title>
- <para>There are two ways for components or containers definition, which Ajax requests status is tracked by a component.<itemizedlist>
+ <para>There are two ways for components or containers definition, which AJAX requests status is tracked by a component.<itemizedlist>
<listitem>
Definition with the <emphasis >
<property>"for"</property>
@@ -95,7 +95,7 @@
</emphasis> component shows the status for the request fired from this action component.
</listitem>
</itemizedlist></para>
- <para>The component creates two <emphasis role="bold"><property><span></property></emphasis> elements with content defined for each status, one of the elements (start) is initially hidden. At the beginning of an Ajax request, elements state is inversed, hence the second element is shown and the first is hidden. At the end of a response processing, elements display states return to its initial values.</para>
+ <para>The component creates two <emphasis role="bold"><property><span></property></emphasis> elements with content defined for each status, one of the elements (start) is initially hidden. At the beginning of an AJAX request, elements state is inversed, hence the second element is shown and the first is hidden. At the end of a response processing, elements display states return to its initial values.</para>
<para>Example:</para>
<programlisting role="XML"><![CDATA[<a4j:status startText="Started" stopText="stopped" layout="block"/>]]></programlisting>
<para>is decoded on a page as:</para><programlisting role="XML"><![CDATA[<span id="j_id20:status.start" style="display: none">
@@ -104,7 +104,7 @@
<span id="j_id20:status.stop">
Stopped
</span>]]></programlisting>
- <para>And after the generation of an Ajax response is changed to:</para>
+ <para>And after the generation of an AJAX response is changed to:</para>
<programlisting role="XML"><![CDATA[<span id="j_id20:status.start">
Started
</span>
@@ -116,4 +116,12 @@
</emphasis>
attribute from "incline"(default) to "block".</para>
</section>
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/status.jsf?c=status">here.
+ </ulink>
+ </para>
+ </section>
</chapter>
Modified: trunk/docs/userguide/en/src/main/docbook/included/support.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/support.xml 2007-08-15 13:36:54 UTC (rev 2268)
+++ trunk/docs/userguide/en/src/main/docbook/included/support.xml 2007-08-15 14:06:00 UTC (rev 2269)
@@ -35,8 +35,8 @@
<title>Creating on a page</title>
<para>To use a component, place <emphasis role="bold">
<property><a4j:support></property>
- </emphasis> as nested to the component requesting AJAX functionalityity and specify an event of a
- parent component that generates Ajax request and the components to be rerendered after a response
+ </emphasis> as nested to the component requesting AJAX functionality and specify an event of a
+ parent component that generates AJAX request and the components to be rerendered after a response
from the server.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting role="XML"><![CDATA[<h:inputText value="#{bean.text}">
@@ -81,11 +81,11 @@
<property><a4j:poll></property>
</emphasis> and others from Ajax4jsf library are already supplied with <emphasis role="bold">
<property><a4j:support></property>
- </emphasis> functionalityity and there is no necessity to add the support to them. </para>
+ </emphasis> functionality and there is no necessity to add the support to them. </para>
</note>
<para>With the help of <emphasis >
<property>"onsubmit"</property></emphasis> and <emphasis >
- <property>"oncomplete"</property></emphasis> attributes the component allows using JavaScript before (for request sending conditions checking) and after an Ajax response processing termination (for performance of user-defined activities on the client) </para>
+ <property>"oncomplete"</property></emphasis> attributes the component allows using JavaScript before (for request sending conditions checking) and after an AJAX response processing termination (for performance of user-defined activities on the client) </para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting role="XML"><![CDATA[<h:selectOneMenu value="#{bean.text}">
<f:selectItem itemValue="First Item " itemLabel="First Item"/>
@@ -95,7 +95,7 @@
{form.reset(); return false;}" oncomplete="alert('Value succesfully stored')"/>
</h:selectOneMenu>]]></programlisting>
<para>In example there is the condition checking (confirm) is used before request sending and message printing after the request processing is over. </para>
- <para>The components allows different Ajax request managing ways for its various optimization in particular conditions such as:
+ <para>The components allows different AJAX request managing ways for its various optimization in particular conditions such as:
<itemizedlist>
<listitem>
<emphasis role="bold">Limitation of the submit area and updating area for the request.</emphasis>
@@ -123,7 +123,7 @@
</h:inputText>
<h:outputText value="#{person.name}" id="test"/>
</form>]]></programlisting>
- <para>In this example the component "h:messages" is always updated (as it capturing all Ajax requests, located in ajaxRendered <emphasis role="bold"><property><a4j:outputPanel></property></emphasis>), except the case when a response is sent from the input component from the example. On sending this component marks that updating area is limited to the defined in it components, it means that on its usage with "limitToList"="true" the only component updated is the one with "d"="test".</para>
+ <para>In this example the component "h:messages" is always updated (as it capturing all AJAX requests, located in ajaxRendered <emphasis role="bold"><property><a4j:outputPanel></property></emphasis>), except the case when a response is sent from the input component from the example. On sending this component marks that updating area is limited to the defined in it components, it means that on its usage with "limitToList"="true" the only component updated is the one with "d"="test".</para>
<itemizedlist>
<listitem>
<emphasis role="bold">Limitation of requests frequency and updates quantity after the responses. </emphasis>
@@ -133,7 +133,7 @@
<para><emphasis ><property>"eventQueue"</property></emphasis> is an attribute for naming of the queue where the next response is kept in till its processing, but if the next event comes in till this time is over, the waiting event is taken away, replacing with a new one.
</para>
- <para><emphasis ><property>"ignoreDupResponces"</property></emphasis> is an attribute that allows to disable any updates on the client after an Ajax request if another Ajax request is already sent.
+ <para><emphasis ><property>"ignoreDupResponces"</property></emphasis> is an attribute that allows to disable any updates on the client after an AJAX request if another AJAX request is already sent.
</para>
<para><emphasis ><property>"timeout"</property></emphasis> is an attribute that allows to set a time interval in millisecond to define a maximum time period of response wait time. In case of the interval interaction, a new request is sent and the previous one is canceled. Postprocessing of a response isn't performed.
</para>
@@ -151,4 +151,13 @@
</listitem>
</itemizedlist>
</section>
+
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Some additional information about usage of component can be found
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/support.jsf?c=support">here.
+ </ulink>
+ </para>
+ </section>
</chapter>
\ No newline at end of file
More information about the richfaces-svn-commits
mailing list