JBoss Rich Faces SVN: r2549 - trunk/docs/userguide/en/src/main/docbook/modules. - richfaces-svn-commits

Tuesday, 28 August 2007

Author: vkorluzhenko
Date: 2007-08-28 13:28:51 -0400 (Tue, 28 Aug 2007)
New Revision: 2549

Modified:
   trunk/docs/userguide/en/src/main/docbook/modules/RFCGettingStarted.xml
   trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml
   trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml
Log:
http://jira.jboss.com/jira/browse/RF-656 - the content was changed according to the
merging of two projects

Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCGettingStarted.xml
===================================================================

--- trunk/docs/userguide/en/src/main/docbook/modules/RFCGettingStarted.xml	2007-08-28
16:54:08 UTC (rev 2548)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCGettingStarted.xml	2007-08-28
17:28:51 UTC (rev 2549)
@@ -45,7 +45,11 @@
       </note-->
       <listitem> Add the following content into the <emphasis>
           <property>&quot;WEB-INF/web.xml&quot;</property>
-        </emphasis> file of your application: <programlisting
role="XML"><![CDATA[
+        </emphasis> file of your application: <programlisting
role="XML"><![CDATA[...
+    <context-param>
+        <param-name>org.richfaces.SKIN</param-name>
+        <param-value>blueSky</param-value>
+    </context-param>
     <filter> 
         <display-name>RichFaces Filter</display-name> 
         <filter-name>richfaces</filter-name> 
@@ -73,12 +77,12 @@
 <%@ taglib uri="http://richfaces.org/rich" prefix="rich"%>
]]></programlisting>
         <para>For XHTML pages:</para>
         <programlisting
role="XML"><![CDATA[<xmlns:a4j="http://richfaces....
-<xmlns:a4j="http://richfaces.org/rich">]]></programlisting>
+<xmlns:rich="http://richfaces.org/rich">]]></programlisting>
       </listitem>
     </itemizedlist>
     <note>
       <title>Note:</title>
-      <para>The previous URIs (https://ajax4jsf.dev.java.net/ajax and
+      <para>The previous namespaces URIs (https://ajax4jsf.dev.java.net/ajax and
         http://richfaces.ajax4jsf.org/rich) are also available for backward
compatibility.</para>
     </note>
   </section>
@@ -111,17 +115,31 @@
       <body>
         <f:view>
           <h:form>
-            <h:inputText size="50" value="#{bean.text}" > 
-              <a4j:support event="onkeyup" reRender="rep"/>
-            </h:inputText>
-            <h:outputText value="#{bean.text}" id="rep"/>
+              <rich:panel header="Simple Echo">
+                <h:inputText size="50" value="#{bean.text}" > 
+                  <a4j:support event="onkeyup"
reRender="rep"/>
+                </h:inputText>
+                <h:outputText value="#{bean.text}" id="rep"/>
+              </rich:panel>
           </h:form>
         </f:view>
       </body>
     </html>]]></programlisting>
-      <para>The only line that distinguishes this page from a
&quot;regular&quot; JSF one is</para>
-      <programlisting role="XML"><![CDATA[<a4j:support
event="onkeyup" reRender="rep"/>]]></programlisting>
-      <para>The line adds an Ajax support to the parent <emphasis
role="bold">
+      <para>Only two tags distinguish this page from a &quot;regular&quot;
JSF
+        one. There are <emphasis role="bold">
+          <property>&lt;rich:panel&gt;</property>
+        </emphasis> and <emphasis role="bold">
+          <property>&lt;a4j:support&gt;</property>
+        </emphasis>.</para>
+
+      <para>The <emphasis role="bold">
+          <property>&lt;rich:panel&gt;</property>
+      </emphasis>allows to place the page elements in rectangle panel that can be
skinned.</para>
+
+      <para>The <emphasis role="bold">
+          <property>&lt;a4j:support&gt;</property>
+        </emphasis> with corresponding attributes (as it was shown in the previous
example) adds an
+        Ajax support to the parent <emphasis role="bold">
           <property>&lt;h:inputText&gt;</property>
         </emphasis> tag. This support is bound to &quot;onkeyup&quot;
JavaScript event, so
         that each time when this event is fired on the parent tag, our application sends
an Ajax
@@ -188,15 +206,18 @@
     <section id="Web.xml">
       <?dbhtml filename="Web.xml.html"?>
       <title>Web.xml</title>
-      <para>It is also necessary to add jar files (see <link
linkend="Installation"
-          >installation chapter</link>) and modify the
&quot;web.xml&quot; file: </para>
+      <para>It is also necessary to add jar files (see <link
linkend="Installation">installation
+          chapter</link>) and modify the &quot;web.xml&quot; file:
</para>
       <programlisting role="XML">    <![CDATA[<?xml
version="1.0"?>
     <web-app version="2.4"
xmlns="http://java.sun.com/xml/ns/j2ee"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee 
http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
-      
     <display-name>a4jEchoText</display-name>
     <context-param>
+        <param-name>org.richfaces.SKIN</param-name>
+        <param-value>blueSky</param-value>
+    </context-param>
+    <context-param>
         <param-name>javax.faces.STATE_SAVING_METHOD</param-name>
         <param-value>server</param-value>
     </context-param>

Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml	2007-08-28 16:54:08
UTC (rev 2548)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml	2007-08-28 17:28:51
UTC (rev 2549)
@@ -35,7 +35,7 @@
   <section id="ApacheMyFaces">
     <?dbhtml filename="ApacheMyFaces.html"?>
     <title>Apache MyFaces</title>
-    <para>RichFaces works with all <property>Apache MyFaces</property>
versions (1.1.1 - 1.1.5)
+    <para>RichFaces works with all <property>Apache MyFaces</property>
versions (1.1.1 - 1.1.6)
       including specific libraries like Tomahawk Sandbox and Trinidad (the previous ADF
Faces).
       However, there are some considerations to take into account for configuring
applications to
       work with <property>MyFaces</property> and RichFaces.</para>
@@ -190,7 +190,7 @@
   </section>
   <section id="Portlet Support">
     <title>Portlet Support</title>
-    <para><property>Portlets</property> have support since version
Ajax4jsf 1.1.1. This support is
+    <para><property>JBoss Portlets</property> have support since
version Ajax4jsf 1.1.1. This support is
       improved in Richfaces 3.1.0. Provide your feedback on compatible with RichFaces if
you face
       some problems.</para>
   </section>

Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml	2007-08-28
16:54:08 UTC (rev 2548)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml	2007-08-28
17:28:51 UTC (rev 2549)
@@ -50,13 +50,12 @@
     </mediaobject>
     <formalpara>
       <title>Ajax Filter.</title>
-      <para>To get all benefits of  <property>RichFaces</property>, you
should  register an Ajax Filter in web.xml 
-      file of your application.The Ajax Filter recognizes multiple request types. The
sequence diagram on Figure 3 
+      <para>To get all benefits of  <property>RichFaces</property>, you
should  register a Filter in web.xml 
+      file of your application. The Filter recognizes multiple request types. The
sequence diagram on Figure 3 
       shows the difference in processing of a &quot;regular&quot; JSF request and
an Ajax request.</para>
     </formalpara>
     <para>In the first case the whole JSF tree will be encoded,
-      in the second one option it depends on the &quot;size&quot; of the Ajax
region (you can define Ajax region 
-      by using the <emphasis
role="bold"><property>&lt;a4j:region&gt;</property></emphasis>).
As you can see, in the second case the filter parses 
+      in the second one option it depends on the &quot;size&quot; of the Ajax
region. As you can see, in the second case the filter parses 
       the content of an Ajax response before sending it to the client side.</para>
     <para>Have a look at the next picture to understand these two
ways:</para>
     <figure>
@@ -69,10 +68,10 @@
     </mediaobject>
     <para>In both cases, the information about required static or dynamic resources
that your application 
       requests is registered in the ResourseBuilder class.</para>
-    <para>When a request for a resource comes (Figure 4), the Ajax filter checks
the Resource Cache 
+    <para>When a request for a resource comes (Figure 4), the RichFaces filter
checks the Resource Cache 
       for this resource and if it is there, the resource is sent to the client.
Otherwise, 
       the filter searches for the resource among those that are registered by the 
-      ResourceBuilder. If the resource is registered, the Ajax filter will send a request
to the 
+      ResourceBuilder. If the resource is registered, the RichFaces filter will send a
request to the 
       ResourceBuilder to create (deliver) the resource.</para>
     <para>Next Figure shows the ways of  resource request processing.</para>
     <figure>
@@ -86,7 +85,7 @@
     <formalpara>
       <title>AJAX Action Components</title>
       <para>
-      There are four Ajax Action Components: AjaxCommandButton,  AjaxCommandLink,
AjaxPoll and AjaxSupport. 
+      There are Ajax Action Components: AjaxCommandButton,  AjaxCommandLink, AjaxPoll and
AjaxSupport and etc. 
       You can use them to send Ajax requests from the client side. 
     </para>
     </formalpara>
@@ -111,7 +110,7 @@
     <para>In order to create RichFaces applications properly,  keep the following
points in mind:</para>
     <itemizedlist>
       <listitem>
-        The Ajax framework should not append or delete, but only replace elements on the
page. For successful updates, an element with the same ID as in the response must exist on
the page. If you&apos;d like to append any code to a page, put in a placeholder for it
(any empty element). For the same reason, it&apos;s recommended to place messages in
the<emphasis >
+        Any Ajax framework should not append or delete, but only replace elements on the
page. For successful updates, an element with the same ID as in the response must exist on
the page. If you&apos;d like to append any code to a page, put in a placeholder for it
(any empty element). For the same reason, it&apos;s recommended to place messages in
the<emphasis >
             <property>&quot;AjaxOutput&quot;</property>
           </emphasis> component (as no messages is also a message).
       </listitem>
@@ -131,12 +130,12 @@
     <section id="SendAnAJAXRequest">
     <?dbhtml filename="SendAnAJAXRequest.html"?>
       <title>Send an Ajax request</title>
-      <para>There are different ways to send Ajax requests from your JSF page. You
may use 
+      <para>There are different ways to send Ajax requests from your JSF page. For
example you can use 
           <emphasis
role="bold"><property>&lt;a4j:commandButton&gt;</property></emphasis>,
<emphasis role="bold">
           <property>&lt;a4j:commandLink&gt;</property>, <emphasis
role="bold"><property>&lt;a4j:poll&gt;</property></emphasis>
         </emphasis> or <emphasis role="bold">
           <property>&lt;a4j:support&gt;</property>
-        </emphasis> tags.           
+        </emphasis> tags or any other.           
         </para>
       <para>All these tags hide the usual JavaScript activities that are required
for an XMHttpRequest 
           object building and  an Ajax request sending. Also, they allow you to decide
which components of 
@@ -202,8 +201,18 @@
             </emphasis> attributes specify regions to be sent with a request, 
               if &quot;false&quot; it is a full region, in other case
it&apos;s is only a control caused 
               event.
-</listitem>
-      </itemizedlist>
+        </listitem>
+        
+          <listitem> <emphasis >
+            <property>&quot;timeout&quot;</property>
+          </emphasis>attribute is used for response waiting time on a particular
request. If a response is not received during this time, the request is aborted.
+          </listitem>
+         
+          <listitem> <emphasis >
+            <property>&quot;ignoreDupResponses&quot;</property>
+          </emphasis> is used to abort  unfinished request on new event.
+           </listitem>
+       </itemizedlist>
     </section>
     <section id="DecideWhatToSend">
     <?dbhtml filename="DecideWhatToSend.html"?>
@@ -226,7 +235,7 @@
         </emphasis> tag. 
         </para>
       <para>If you wish to render the content of an Ajax response outside of the
active region then 
-          the value of the &quot;renderRegionOnly&quot; attribute should be set
to &quot;false&quot;. Otherwise, your 
+        the value of the &quot;renderRegionOnly&quot; attribute should be set to
&quot;false&quot; (&quot;false&quot; is default value). Otherwise, your 
           Ajax updates are limited to elements of the active region.
         </para>
     </section>


    

2026

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

JBoss Rich Faces SVN: r2549 - trunk/docs/userguide/en/src/main/docbook/modules.