[richfaces-svn-commits] JBoss Rich Faces SVN: r13475 - trunk/docs/userguide/en/src/main/docbook/included.

richfaces-svn-commits at lists.jboss.org richfaces-svn-commits at lists.jboss.org
Thu Apr 9 11:56:40 EDT 2009


Author: ochikvina
Date: 2009-04-09 11:56:40 -0400 (Thu, 09 Apr 2009)
New Revision: 13475

Modified:
   trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml
   trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml
   trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml
Log:
https://jira.jboss.org/jira/browse/RF-5730 - adding links to RichFaces cookbook articles;

Modified: trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml	2009-04-09 15:52:25 UTC (rev 13474)
+++ trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml	2009-04-09 15:56:40 UTC (rev 13475)
@@ -122,7 +122,7 @@
     <title>Relevant resources links</title>
     <para>
     	<ulink
-    		url="http://wiki.jboss.org/auth/wiki//RichFacesCookbook/JsFunctionJson">
+    	  url="http://www.jboss.org/community/docs/DOC-11856">
     		Here
     	</ulink>
     	you can find additional information and example on how to use

Modified: trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml	2009-04-09 15:52:25 UTC (rev 13474)
+++ trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml	2009-04-09 15:56:40 UTC (rev 13475)
@@ -118,16 +118,16 @@
                                                   <entry>RichFaces.showModalPanel (client
                                                   Id)</entry>
 
-                                                  <entry>Opens a window with a specified
-                                                  client Id</entry>
+                                                  <entry>Opens a window with a specified client
+                                                  Id</entry>
                                                   </row>
 
                                                   <row>
                                                   <entry>RichFaces.hideModalPanel (client
                                                   Id)</entry>
 
-                                                  <entry>Closes a window with a specified
-                                                  client Id</entry>
+                                                  <entry>Closes a window with a specified client
+                                                  Id</entry>
                                                   </row>
                                         </tbody>
                               </tgroup>
@@ -135,21 +135,23 @@
 
                     <important>
                               <title>Important:</title>
-                              <para>To work properly the &lt;rich:modalPanel&gt; should always be placed 
-							  outside the original &lt;h:form&gt; and must include its own &lt;h:form&gt; for such cases like 
-							  performing submissions from within the &lt;rich:modalPanel&gt;.
-							  </para>
-				    </important>
-				    <note>
-					    <title>Note:</title>
-					    <para>In order to avoid a bug in IE, the root node of the dialog is moved on the top of a DOM tree.
-					    </para>
-				    </note>
-							 
+                              <para>To work properly the &lt;rich:modalPanel&gt; should
+                                        always be placed outside the original &lt;h:form&gt;
+                                        and must include its own &lt;h:form&gt; for such
+                                        cases like performing submissions from within the
+                                        &lt;rich:modalPanel&gt;. </para>
+                    </important>
+                    <note>
+                              <title>Note:</title>
+                              <para>In order to avoid a bug in IE, the root node of the dialog is
+                                        moved on the top of a DOM tree. </para>
+                    </note>
 
+
                     <para>It&apos;s possible to add a <emphasis>
                                         <property>&quot;header&quot;</property>
-                              </emphasis> facet to the component to set the content for the header.</para>
+                              </emphasis> facet to the component to set the content for the
+                              header.</para>
 
 
                     <para>
@@ -209,8 +211,9 @@
                     <para>The result:</para>
 
                     <figure>
-                        <title><emphasis role="bold"><property>&lt;rich:modalPanel&gt;</property></emphasis> 
-						with &apos;Close&apos; control</title>
+                              <title><emphasis role="bold">
+                                                  <property>&lt;rich:modalPanel&gt;</property>
+                                        </emphasis> with &apos;Close&apos; control</title>
 
                               <mediaobject>
                                         <imageobject>
@@ -219,25 +222,44 @@
                               </mediaobject>
                     </figure>
 
-                <para>To understand the sence of &quot;<emphasis><property>domElementAttachment</property></emphasis>&quot; attribute 
-					you should understand the <emphasis>stacking context</emphasis> in the division element (<code>&lt;div&gt;</code>) HTML makeup. 
-					Since each positioned or z-indexed element (in CSS <code>position: absolute</code> or <code>relative</code> or <code>z-index: [any integer value different from 0]</code>) 
-					form their own stacking context the <emphasis role="bold"><property>&lt;rich:modalPanel&gt;</property></emphasis> nested into such element 
-					may be overlapped with another elements, which appear later in HTML heirarchy and assimilated with basic stacking context (HTML &lt;body&gt;). 
-					To make the panel rendered in closest to the observer layer and avoid such overlapping, the component was designed in way when 
-					it is always being automatically assimilated with <code>&lt;body&gt;</code> and with a very high rendering layer (<code>z-index</code>). 
-					Due to some side effects the <emphasis role="bold"><property>&lt;rich:modalPanel&gt;</property></emphasis> should not always be 
-                      assimilated with <code>&lt;body&gt;</code> stacking context. The &quot;<emphasis><property>domElementAttachment</property></emphasis>&quot; 
-					attribute helps to reassign the panel to it &apos;<emphasis>parent</emphasis>&apos;	or &apos;<emphasis>form</emphasis>&apos; element. 
-					If &apos;<emphasis>form</emphasis>&apos; is used and no parent form is available the panel is functioning as if it is assimilated with <code>&lt;body&gt;</code>.
-					</para>
-					
-					<note>
-					    <title>Note:</title>
-					      <para>If &quot;<emphasis><property>domElementAttachment</property></emphasis>&quot; value is not &apos;<emphasis>body</emphasis>&apos; then some overlapping may occur. 
-					    </para>
-				    </note>
-					
+                    <para>To understand the sence of &quot;<emphasis>
+                                        <property>domElementAttachment</property>
+                              </emphasis>&quot; attribute you should understand the
+                                        <emphasis>stacking context</emphasis> in the division
+                              element (<code>&lt;div&gt;</code>) HTML makeup. Since each
+                              positioned or z-indexed element (in CSS <code>position:
+                                        absolute</code> or <code>relative</code> or <code>z-index:
+                                        [any integer value different from 0]</code>) form their own
+                              stacking context the <emphasis role="bold">
+                                        <property>&lt;rich:modalPanel&gt;</property>
+                              </emphasis> nested into such element may be overlapped with another
+                              elements, which appear later in HTML heirarchy and assimilated with
+                              basic stacking context (HTML &lt;body&gt;). To make the panel
+                              rendered in closest to the observer layer and avoid such overlapping,
+                              the component was designed in way when it is always being
+                              automatically assimilated with <code>&lt;body&gt;</code> and
+                              with a very high rendering layer (<code>z-index</code>). Due to some
+                              side effects the <emphasis role="bold">
+                                        <property>&lt;rich:modalPanel&gt;</property>
+                              </emphasis> should not always be assimilated with
+                                        <code>&lt;body&gt;</code> stacking context. The &quot;<emphasis>
+                                        <property>domElementAttachment</property>
+                              </emphasis>&quot; attribute helps to reassign the panel to it
+                                        &apos;<emphasis>parent</emphasis>&apos; or
+                                        &apos;<emphasis>form</emphasis>&apos; element. If
+                                        &apos;<emphasis>form</emphasis>&apos; is used and no
+                              parent form is available the panel is functioning as if it is
+                              assimilated with <code>&lt;body&gt;</code>. </para>
+
+                    <note>
+                              <title>Note:</title>
+                              <para>If &quot;<emphasis>
+                                                  <property>domElementAttachment</property>
+                                        </emphasis>&quot; value is not
+                                                  &apos;<emphasis>body</emphasis>&apos; then
+                                        some overlapping may occur. </para>
+                    </note>
+
                     <para>To manage window placement relative to the component, there are <emphasis>
                                         <property>"left"</property>
                               </emphasis> and <emphasis>
@@ -256,13 +278,12 @@
                               </emphasis> and <emphasis>
                                         <property>"minHeight"</property>
                               </emphasis> attributes specifying the minimal window sizes.</para>
-                    <para>
-                              Also you can use <emphasis>
+                    <para> Also you can use <emphasis>
                                         <property>&quot;minWidth&quot;</property>
                               </emphasis> and <emphasis>
                                         <property>&quot;minHeight&quot;</property>
-                              </emphasis> attributes used as <code>showModalPanel()</code> arguments in JavaScript options.
-                    </para>
+                              </emphasis> attributes used as <code>showModalPanel()</code> arguments
+                              in JavaScript options. </para>
                     <para> You can pass your parameters during modalPanel opening or closing. This
                               passing could be performed in the following way: </para>
 
@@ -274,7 +295,8 @@
                               own parameters. </para>
                     <para> Also modalPanel allows to handle its own opening and closing events on
                               the client side. The <emphasis>
-                                        <property>&quot;onshow&quot;</property></emphasis> attribute is used in this case. </para>
+                                        <property>&quot;onshow&quot;</property>
+                              </emphasis> attribute is used in this case. </para>
                     <para> The following example shows how on the client side to define opening and
                               closing event handling in such a way that your own parameters could
                               also be obtained: </para>
@@ -331,7 +353,8 @@
                                                   level up) if it has the form inside.</para>
                               </listitem>
                     </itemizedlist>
-                    <para>Simple example of using commandButton within modalPanel is placed below.</para>
+                    <para>Simple example of using commandButton within modalPanel is placed
+                              below.</para>
                     <para>
                               <emphasis role="bold">Example:</emphasis>
                     </para>
@@ -393,14 +416,12 @@
 
                                                   <row>
                                                   <entry>show()</entry>
-                                                  <entry>Opens the corresponding
-                                                  modalPanel</entry>
+                                                  <entry>Opens the corresponding modalPanel</entry>
                                                   </row>
 
                                                   <row>
                                                   <entry>hide()</entry>
-                                                  <entry>Closes the corresponding
-                                                  modalPanel</entry>
+                                                  <entry>Closes the corresponding modalPanel</entry>
                                                   </row>
 
                                         </tbody>
@@ -408,7 +429,7 @@
                     </table>
 
           </section>
-          
+
           <section>
                     <title>Facets</title>
                     <table>
@@ -416,18 +437,19 @@
                               <tgroup cols="2">
                                         <thead>
                                                   <row>
-                                                            <entry>Facet</entry>
-                                                            <entry>Description</entry>
+                                                  <entry>Facet</entry>
+                                                  <entry>Description</entry>
                                                   </row>
                                         </thead>
                                         <tbody>
                                                   <row>
-                                                            <entry>header</entry>
-                                                            <entry>Define the header content</entry>
+                                                  <entry>header</entry>
+                                                  <entry>Define the header content</entry>
                                                   </row>
                                                   <row>
-                                                            <entry>controls</entry>
-                                                            <entry>Defines the control elements on the header</entry>
+                                                  <entry>controls</entry>
+                                                  <entry>Defines the control elements on the
+                                                  header</entry>
                                                   </row>
                                         </tbody>
                               </tgroup>
@@ -611,7 +633,8 @@
                               </mediaobject>
                     </figure>
 
-                    <para>The screenshot shows the classes names for defining different elements.</para>
+                    <para>The screenshot shows the classes names for defining different
+                              elements.</para>
 
                     <table id="mPC">
                               <title>Classes names that define a component appearance</title>
@@ -630,37 +653,36 @@
                                                   <entry>rich-modalpanel</entry>
 
                                                   <entry>Defines styles for a wrapper
-                                                  &lt;div&gt; element of
-                                                  a modalPanel</entry>
+                                                  &lt;div&gt; element of a
+                                                  modalPanel</entry>
                                                   </row>
 
                                                   <row>
                                                   <entry>rich-mpnl-mask-div</entry>
 
                                                   <entry>Defines styles for a wrapper
-                                                  &lt;div&gt; element of
-                                                  a mask</entry>
+                                                  &lt;div&gt; element of a mask</entry>
                                                   </row>
-                                                  
+
                                                   <row>
-                                                            <entry>rich-mpnl_panel</entry>
-                                                            
-                                                            <entry>Defines styles for a
-                                                                      modalPanel</entry>
+                                                  <entry>rich-mpnl_panel</entry>
+
+                                                  <entry>Defines styles for a modalPanel</entry>
                                                   </row>
-                                                  
+
                                                   <row>
-                                                            <entry>rich-mp-container </entry>
-                                                            
-                                                            <entry>Defines styles for a modalPanel container</entry>
+                                                  <entry>rich-mp-container </entry>
+
+                                                  <entry>Defines styles for a modalPanel
+                                                  container</entry>
                                                   </row>
 
                                                   <row>
                                                   <entry>rich-mpnl-resizer</entry>
 
                                                   <entry>Defines styles for a wrapper
-                                                  &lt;div&gt; element of
-                                                  a resizing element</entry>
+                                                  &lt;div&gt; element of a resizing
+                                                  element</entry>
                                                   </row>
 
                                                   <row>
@@ -669,11 +691,12 @@
                                                   <entry>Defines styles for a modalPanel
                                                   shadow</entry>
                                                   </row>
-                                                  
+
                                                   <row>
-                                                            <entry>rich-mp-content-table</entry>
-                                                            
-                                                            <entry>Defines styles for a &lt;table&gt; element of a modalPanel</entry>
+                                                  <entry>rich-mp-content-table</entry>
+
+                                                  <entry>Defines styles for a &lt;table&gt;
+                                                  element of a modalPanel</entry>
                                                   </row>
 
                                                   <row>
@@ -686,31 +709,30 @@
                                                   <row>
                                                   <entry>rich-mpnl-header-cell</entry>
 
-                                                  <entry>Defines styles for a header
-                                                  cell</entry>
+                                                  <entry>Defines styles for a header cell</entry>
                                                   </row>
 
                                                   <row>
                                                   <entry>rich-mpnl-text</entry>
 
                                                   <entry>Defines styles for a wrapper
-                                                  &lt;div&gt; element of
-                                                  a header text</entry>
+                                                  &lt;div&gt; element of a header
+                                                  text</entry>
                                                   </row>
 
                                                   <row>
                                                   <entry>rich-mpnl-body</entry>
 
-                                                  <entry>Defines styles for a content
-                                                  inside a modalPanel</entry>
+                                                  <entry>Defines styles for a content inside a
+                                                  modalPanel</entry>
                                                   </row>
 
                                                   <row>
                                                   <entry>rich-mpnl-controls</entry>
 
                                                   <entry>Defines styles for a wrapper
-                                                  &lt;div&gt; element of
-                                                  a modalPanel control</entry>
+                                                  &lt;div&gt; element of a modalPanel
+                                                  control</entry>
                                                   </row>
                                         </tbody>
                               </tgroup>
@@ -767,7 +789,8 @@
                                         <property>&quot;headerClass&quot;</property>
                               </emphasis> attribute for <emphasis role="bold">
                                         <property>&lt;rich:modalPanel&gt;</property>
-                              </emphasis> is defined as it&apos;s shown in the example below:</para>
+                              </emphasis> is defined as it&apos;s shown in the example
+                              below:</para>
 
                     <para>
                               <emphasis role="bold">Example:</emphasis>
@@ -795,46 +818,74 @@
           </section>
           <section>
                     <title>Relevant Resources Links</title>
-                    <para>Vizit <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/modalPanel.jsf?c=modalPanel">
-					ModalPanel page</ulink> at RichFaces Livedemo for examples of component usage and their sources.
-					</para>
-							  
-                    <para>Read the &quot;<ulink url="http://eclipse.dzone.com/articles/an-introduction-to-jboss-richf?page=0%2C0">
-					An Introduction To JBoss RichFaces</ulink>&quot; tutorial by Max Katz to find out how 
-					the <emphasis role="bold"><property>&lt;rich:modalPanel&gt;</property></emphasis> 
-					helps to edit and save changes for table entries. 
-					</para>
-					
-					<para>Some articles at JBoss portal describing different aspects of <emphasis role="bold"><property>&lt;rich:modalPanel&gt;</property></emphasis> usage:
-					</para>
-					
-					<itemizedlist>
-					    <listitem>
-						    <para>
-							   &quot;<ulink url="http://www.jboss.org/community/docs/DOC-11436">ModalPanelWizards</ulink>&quot; article describes 
-							   how to create a typical wizard with the help of <emphasis role="bold"><property>&lt;rich:modalPanel&gt;</property></emphasis> component 
-							   (the same could also be found in the &quot;<ulink url="http://www.jboss.org/file-access/default/members/jbossrichfaces/freezone/docs/devguide/en/faq/faq.html#Organizewizards">
-							   How to organize wizards using the &lt;rich:modalPanel&gt; component?</ulink>&quot; chapter of RichFaces FAQ guide);
-							</para>
-						</listitem>
-                        <listitem>
-                            <para>
-							    &quot;<ulink url="http://www.jboss.org/community/docs/DOC-11435">ModalPanelValidation</ulink>&quot; article 
-								gives examples of validation in <emphasis role="bold"><property>&lt;rich:modalPanel&gt;</property></emphasis> 
-								(the same in the <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&amp;p=4061517">corresponding topic</ulink> 
-								at RichFaces Users Forum);
-                            </para>
-						</listitem>
-						<listitem>
-                            <para>
-							    &quot;<ulink url="http://www.jboss.org/community/docs/DOC-11863">RichFacesPleaseWaitBox</ulink>&quot; article 
-								describes how to show a &quot;Please wait&quot; box and block the input while the Ajax request is being processed 
-								using combination of <emphasis role="bold"><property>&lt;a4j:status&gt;</property></emphasis> and 
-								<emphasis role="bold"><property>&lt;rich:modalPanel&gt;</property></emphasis> components.
-                            </para>
-						</listitem>    
-					</itemizedlist>
-					                    
+                    <para>Vizit <ulink
+                                        url="http://livedemo.exadel.com/richfaces-demo/richfaces/modalPanel.jsf?c=modalPanel"
+                                        > ModalPanel page</ulink> at RichFaces Livedemo for examples
+                              of component usage and their sources. </para>
+
+                    <para>Read the &quot;<ulink
+                                        url="http://eclipse.dzone.com/articles/an-introduction-to-jboss-richf?page=0%2C0"
+                                        > An Introduction To JBoss RichFaces</ulink>&quot;
+                              tutorial by Max Katz to find out how the <emphasis role="bold">
+                                        <property>&lt;rich:modalPanel&gt;</property>
+                              </emphasis> helps to edit and save changes for table entries. </para>
+
+                    <para>Some articles at JBoss portal describing different aspects of <emphasis
+                                        role="bold">
+                                        <property>&lt;rich:modalPanel&gt;</property>
+                              </emphasis> usage: </para>
+
+                    <itemizedlist>
+                              <listitem>
+                                        <para> &quot;<ulink
+                                                  url="http://www.jboss.org/community/docs/DOC-11436"
+                                                  >ModalPanelWizards</ulink>&quot; article
+                                                  describes how to create a typical wizard with the
+                                                  help of <emphasis role="bold">
+                                                  <property>&lt;rich:modalPanel&gt;</property>
+                                                  </emphasis> component (the same could also be
+                                                  found in the &quot;<ulink
+                                                  url="http://www.jboss.org/file-access/default/members/jbossrichfaces/freezone/docs/devguide/en/faq/faq.html#Organizewizards"
+                                                  > How to organize wizards using the
+                                                  &lt;rich:modalPanel&gt;
+                                                  component?</ulink>&quot; chapter of RichFaces
+                                                  FAQ guide); </para>
+                              </listitem>
+                              <listitem>
+                                        <para>Refer to the &quot;<ulink
+                                                  url="http://www.jboss.org/community/docs/DOC-11853"
+                                                  >How to do a detail view modalPanel in a
+                                                  table</ulink>&quot; article in the RichFaces cookbook at JBoss Portal to find out how to
+                                                  build a table with details link clicking on which
+                                                  will display a modal panel with information loaded from the server.</para>
+                              </listitem>
+                              <listitem>
+                                        <para>&quot;<ulink
+                                                  url="http://www.jboss.org/community/docs/DOC-11435"
+                                                  >ModalPanelValidation</ulink>&quot; article
+                                                  gives examples of validation in <emphasis
+                                                  role="bold">
+                                                  <property>&lt;rich:modalPanel&gt;</property>
+                                                  </emphasis> (the same in the <ulink
+                                                  url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&amp;p=4061517"
+                                                  >corresponding topic</ulink> at RichFaces Users
+                                                  Forum);</para>
+                              </listitem>
+                              <listitem>
+                                        <para>&quot;<ulink
+                                                  url="http://www.jboss.org/community/docs/DOC-11863"
+                                                  >RichFacesPleaseWaitBox</ulink>&quot; article
+                                                  describes how to show a &quot;Please
+                                                  wait&quot; box and block the input while the
+                                                  Ajax request is being processed using combination
+                                                  of <emphasis role="bold">
+                                                  <property>&lt;a4j:status&gt;</property>
+                                                  </emphasis> and <emphasis role="bold">
+                                                  <property>&lt;rich:modalPanel&gt;</property>
+                                                  </emphasis> components. </para>
+                              </listitem>
+                    </itemizedlist>
+
           </section>
 
 

Modified: trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml	2009-04-09 15:52:25 UTC (rev 13474)
+++ trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml	2009-04-09 15:56:40 UTC (rev 13475)
@@ -29,15 +29,11 @@
 				</row>
 				<row>
 					<entry>component-class</entry>
-					<entry>
-						org.ajax4jsf.component.html.HtmlAjaxOutputPanel
-					</entry>
+					<entry> org.ajax4jsf.component.html.HtmlAjaxOutputPanel </entry>
 				</row>
 				<row>
 					<entry>renderer-type</entry>
-					<entry>
-						org.ajax4jsf.components.AjaxOutputPanelRenderer
-					</entry>
+					<entry> org.ajax4jsf.components.AjaxOutputPanelRenderer </entry>
 				</row>
 			</tbody>
 		</tgroup>
@@ -45,9 +41,7 @@
 
 	<section>
 		<title>Creating on a page</title>
-		<para>
-			Here is the simplest way for a component creation on a page.
-		</para>
+		<para> Here is the simplest way for a component creation on a page. </para>
 
 		<para>
 			<emphasis role="bold">Example:</emphasis>
@@ -74,25 +68,16 @@
 		<para>
 			<emphasis role="bold">
 				<property>&lt;a4j:outputPanel&gt;</property>
-			</emphasis>
-			allows marking of a page area, which is updated on Ajax
-			response. Anyway,
-			<emphasis role="bold">
+			</emphasis> allows marking of a page area, which is updated on Ajax response. Anyway,
+				<emphasis role="bold">
 				<property>&lt;a4j:outputPanel&gt;</property>
-			</emphasis>
-			usage is optional, as in RichFaces it&apos;s possible to
-			indicate any existing component id on a component view in
-			order to define updating areas.
-
-			To speed up the performance, RichFaces updates only a
-			component tree.
-			<emphasis role="bold">
+			</emphasis> usage is optional, as in RichFaces it&apos;s possible to indicate any
+			existing component id on a component view in order to define updating areas. To speed up
+			the performance, RichFaces updates only a component tree. <emphasis role="bold">
 				<property>&lt;a4j:outputPanel&gt;</property>
-			</emphasis>
-			usage is recommended for wrapping components that
-			aren&apos;t rendered during the primary non-ajax response,
-			as the components don&apos;t present in a component tree.
-		</para>
+			</emphasis> usage is recommended for wrapping components that aren&apos;t rendered
+			during the primary non-ajax response, as the components don&apos;t present in a
+			component tree. </para>
 		<para>
 			<emphasis role="bold">Example:</emphasis>
 		</para>
@@ -103,42 +88,27 @@
 		...
 	</h:panelGrid>
 </a4j:outputPanel>]]></programlisting>
-		<para>
-			In addition to the areas directly indicated in
-			<emphasis>
+		<para> In addition to the areas directly indicated in <emphasis>
 				<property>&quot;reRender&quot;</property>
-			</emphasis>
-			attribute of Ajax components,
-			<emphasis role="bold">
+			</emphasis> attribute of Ajax components, <emphasis role="bold">
 				<property>&lt;a4j:outputPanel&gt;</property>
-			</emphasis>
-			allows to update a part of a page basing on its own flag.
-			The flag is defined by the
-			<emphasis>
+			</emphasis> allows to update a part of a page basing on its own flag. The flag is
+			defined by the <emphasis>
 				<property>&quot;ajaxRendered&quot;</property>
-			</emphasis>
-			attribute. The flag is commonly used when a part of a page
-			must be updated or can be updated on any response.
-		</para>
+			</emphasis> attribute. The flag is commonly used when a part of a page must be updated
+			or can be updated on any response. </para>
 		<para>
 			<emphasis role="bold">Example:</emphasis>
 		</para>
 		<programlisting role="XML"><![CDATA[<a4j:outputPanel ajaxRendered="true">
 	<h:messages/>
 </a4j:outputPanel>]]></programlisting>
-		<para>
-			On default
-			<emphasis role="bold">
+		<para> On default <emphasis role="bold">
 				<property>&lt;a4j:outputPanel&gt;</property>
-			</emphasis>
-			is output as a pair of opening and closing html
-			<emphasis role="bold">
+			</emphasis> is output as a pair of opening and closing html <emphasis role="bold">
 				<property>&lt;span&gt;</property>
-			</emphasis>
-			tag, but with the help of the layout attribute this output
-			way could be changed. There are three variants for this
-			component value:
-		</para>
+			</emphasis> tag, but with the help of the layout attribute this output way could be
+			changed. There are three variants for this component value: </para>
 		<itemizedlist>
 			<listitem>
 				<para>&quot;inline&quot; (default)</para>
@@ -150,40 +120,25 @@
 				<para>&quot;none&quot;</para>
 			</listitem>
 		</itemizedlist>
-		<para>
-			If
-			<code>layout=&quot;block&quot;</code>
-			is chosen, the component is rendered as a pair of opening
-			and closing
-			<emphasis role="bold">
+		<para> If <code>layout=&quot;block&quot;</code> is chosen, the component is rendered
+			as a pair of opening and closing <emphasis role="bold">
 				<property>&lt;div&gt;</property>
-			</emphasis>
-			tag, to which it&apos;s possible to apply any available
-			style attributes available for block tags.
-		</para>
+			</emphasis> tag, to which it&apos;s possible to apply any available style attributes
+			available for block tags. </para>
 		<para>
-			<code>layout =&quot;none&quot;</code>
-			helps to avoid an unnecessary tag round a context that could
-			or couldn&apos;t be rendered according to the defined
-			<emphasis>
+			<code>layout =&quot;none&quot;</code> helps to avoid an unnecessary tag round a
+			context that could or couldn&apos;t be rendered according to the defined <emphasis>
 				<property>&quot;rendered&quot;</property>
-			</emphasis>
-			attribute conditions. If an inner context isn&apos;t rendered,
-			<emphasis role="bold">
+			</emphasis> attribute conditions. If an inner context isn&apos;t rendered, <emphasis
+				role="bold">
 				<property>&lt;a4j:outputPanel&gt;</property>
-			</emphasis>
-			is rendered as a
-			<emphasis role="bold">
+			</emphasis> is rendered as a <emphasis role="bold">
 				<property>&lt;span&gt;</property>
-			</emphasis>
-			tag with the id equal to an id of a child component and
-			<code>display:none</code>
-			style. If a child component is rendered,
-			<emphasis role="bold">
+			</emphasis> tag with the id equal to an id of a child component and
+				<code>display:none</code> style. If a child component is rendered, <emphasis
+				role="bold">
 				<property>&lt;a4j:outputPanel&gt;</property>
-			</emphasis>
-			doesn&apos;t present at all in a final code.
-		</para>
+			</emphasis> doesn&apos;t present at all in a final code. </para>
 		<para>
 			<emphasis role="bold">Example:</emphasis>
 		</para>
@@ -194,97 +149,63 @@
 		...
   	</h:panelGrid>
 </a4j:outputPanel>]]></programlisting>
-		<para>
-			As you see, the code is very similar to the one shown above,
-			but
-			<emphasis>
+		<para> As you see, the code is very similar to the one shown above, but <emphasis>
 				<property>&quot;reRender &quot;</property>
-			</emphasis>
-			attribute refers directly to the updating panelGrid and not
-			to the framing outputPanel, and it&apos;s more semantically
-			correct.
-		</para>
+			</emphasis> attribute refers directly to the updating panelGrid and not to the framing
+			outputPanel, and it&apos;s more semantically correct. </para>
 		<para>
 			<emphasis role="bold">
 				<property>&lt;a4j:outPanel&gt;</property>
-			</emphasis>
-			should be used for non-JSF component part framing, which is
-			to be updated on Ajax response, as RichFaces specifies the
-			list of updating areas as a list of an existing JSF
-			component.
-		</para>
-		<para>
-			On default non-JSF context isn&apos;t saved in a component
-			tree, but is rendered anew every time. To accelerate the
-			processing speed and Ajax response input speed, RichFaces
-			saves non-JSF context in a component tree on default. This
-			option could be canceled by
-			<emphasis>
+			</emphasis> should be used for non-JSF component part framing, which is to be updated on
+			Ajax response, as RichFaces specifies the list of updating areas as a list of an
+			existing JSF component. </para>
+		<para> On default non-JSF context isn&apos;t saved in a component tree, but is rendered
+			anew every time. To accelerate the processing speed and Ajax response input speed,
+			RichFaces saves non-JSF context in a component tree on default. This option could be
+			canceled by <emphasis>
 				<property>&quot;keepTransient&quot;</property>
-			</emphasis>
-			attribute that cancels transient flag forced setting for
-			child components. This flag setting keeps the current value
-			set by child components.
-		</para>
+			</emphasis> attribute that cancels transient flag forced setting for child components.
+			This flag setting keeps the current value set by child components. </para>
 		<note>
 			<title>Note:</title>
-			<para>
-				In JSF 1.1 implementation and lower, where non-JSF
-				context should be framed with the
-				<emphasis role="bold">
+			<para> In JSF 1.1 implementation and lower, where non-JSF context should be framed with
+				the <emphasis role="bold">
 					<property>&lt;f:verbatim&gt;</property>
-				</emphasis>
-				component,
-				<emphasis role="bold">
+				</emphasis> component, <emphasis role="bold">
 					<property>&lt;a4j:outputPanel&gt;</property>
-				</emphasis>
-				doesn&apos;t improve this JSF implementation option in
-				any way, so you still have to use this tag where
-				it&apos;s necessary without RichFaces usage.
-			</para>
+				</emphasis> doesn&apos;t improve this JSF implementation option in any way, so
+				you still have to use this tag where it&apos;s necessary without RichFaces
+				usage. </para>
 		</note>
-		<para>
-			RichFaces allows setting Ajax responses rendering directly
-			basing on component tree nodes without referring to the JSP
-			(XHTML) page code. It could be defined by <emphasis><property>&quot;selfRendered&quot;</property></emphasis>
-			attribute setting to
-			&quot;true&quot;
-
-			on
-			<emphasis role="bold">
+		<para> RichFaces allows setting Ajax responses rendering directly basing on component tree
+			nodes without referring to the JSP (XHTML) page code. It could be defined by <emphasis>
+				<property>&quot;selfRendered&quot;</property>
+			</emphasis> attribute setting to &quot;true&quot; on <emphasis role="bold">
 				<property>&lt;a4j:region&gt;</property>
-			</emphasis>
-			and could help considerably speed up a response output.
-			However, if a transient flag is kept as it is, this rapid
-			processing could cause missing of transient components that
-			present on view and don&apos;t come into a component tree. Hence,
-			for any particular case you could choose a way for you
-			application optimization: speed up processing or redundant
-			memory for keeping tree part earlier defined a transient.
+			</emphasis> and could help considerably speed up a response output. However, if a
+			transient flag is kept as it is, this rapid processing could cause missing of transient
+			components that present on view and don&apos;t come into a component tree. Hence,
+			for any particular case you could choose a way for you application optimization: speed
+			up processing or redundant memory for keeping tree part earlier defined a transient.
 		</para>
 	</section>
 	<section>
 		<title>Relevant resources links</title>
 		<para>
 			<ulink
-				url="http://livedemo.exadel.com/richfaces-demo/richfaces/outputPanel.jsf?c=outputPanel">
-				Here
-			</ulink>
-			you can see the example of
-			<emphasis role="bold">
+				url="http://livedemo.exadel.com/richfaces-demo/richfaces/outputPanel.jsf?c=outputPanel"
+				> Here </ulink> you can see the example of <emphasis role="bold">
 				<property>&lt;a4j:outputPanel&gt;</property>
-			</emphasis>
-			usage and sources for the given example.
+			</emphasis> usage and sources for the given example. </para>
+		<para> Some additional information about usage of component can be found on the <ulink
+				url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&amp;p=4052203#4052203"
+				> Ajax4JSF Users Forum </ulink>
 		</para>
-		<para>
-			Some additional information about usage of component can be on the
-			found
-			<ulink
-				url="http://www.jboss.com/index.html?module=bb&amp;op=viewtopic&amp;p=4052203#4052203">
-				Ajax4JSF Users Forum
-			</ulink>
-			.
-
+		<para> See how the <emphasis role="bold">
+			<property>&lt;a4j:outputPanel&gt;</property>
+		</emphasis> component can be used in the <ulink
+			url="http://www.jboss.org/auth/wiki//RichFacesCookbook/FormOldNew">Ajax Input form with detection of Old/New
+			Values</ulink> example in the RichFaces cookbook.
 		</para>
 	</section>
-</chapter>
\ No newline at end of file
+</chapter>




More information about the richfaces-svn-commits mailing list