[richfaces-svn-commits] JBoss Rich Faces SVN: r14666 - branches/community/3.3.X/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Sat Jun 20 09:14:16 EDT 2009
Author: atsebro
Date: 2009-06-20 09:14:16 -0400 (Sat, 20 Jun 2009)
New Revision: 14666
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/keepAlive.xml
Log:
RF-7377: a4j:keepAlive component description review:
Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/keepAlive.xml
===================================================================
--- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/keepAlive.xml 2009-06-19 19:55:44 UTC (rev 14665)
+++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/keepAlive.xml 2009-06-20 13:14:16 UTC (rev 14666)
@@ -40,13 +40,13 @@
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[<a4j:keepAlive beanName = "testBean"/>]]></programlisting>
- <para>Note, that to be put into the request scope the pointed bean should be
- registered inside faces-config.xml file and marked with
- <property>org.ajax4jsf.model.KeepAlive</property>
- annotation. </para>
<para>
- A bean instance in the request scope could also be saved directly through the declaration of <code>@KeepAlive</code> annotation inside the bean.
+ Note, that to be put into the request scope the pointed bean should be registered inside <code>faces-config.xml</code> file and marked with <code>org.ajax4jsf.model.KeepAlive</code> annotation.
+ A bean instance in the request scope could also be saved directly through the declaration of <code>@KeepAlive</code> annotation inside the bean.
</para>
+ <para>
+
+ </para>
</section>
<!-- There's no AjaxKeepAlive component nor AjaxKeepAlive class and it cannot be created programmatically and there's no need for that.
@@ -64,18 +64,11 @@
-->
<section>
- <title>Key attributes and ways of usage</title>
- <para> If a managed bean is declared with <property>request</property> scope in
- the configuration file with the help of <emphasis role="bold">
- <property><managed-bean-scope></property>
- </emphasis> tag then the life-time of this bean instance is valid only
- for the current request. Any attempts to make a reference to the bean
- instance after the request end will throw in Illegal Argument
- Exception by the server. To avoid these kinds of Exception, component
- <emphasis role="bold">
- <property><a4j:keepAlive></property>
- </emphasis> is used to maintain the state of the whole bean object
- among subsequent request. </para>
+ <title>Details of usage</title>
+ <para>
+ If a managed bean is declared with <property>request</property> scope in the configuration file with the help of <emphasis role="bold"><property><managed-bean-scope></property></emphasis> tag then the life-time of this bean instance is valid only for the current request. Any attempts to make a reference to the bean instance after the request end will throw in Illegal Argument Exception by the server.
+ To avoid these kinds of Exceptions component <emphasis role="bold"><property><a4j:keepAlive></property></emphasis> is used to maintain the state of the whole bean object among subsequent request.
+ </para>
<para>
<emphasis role="bold">Example:</emphasis>
@@ -83,39 +76,32 @@
<programlisting role="XML"><![CDATA[<a4j:keepAlive beanName = "#{myClass.testBean}"/>]]></programlisting>
- <para> The <emphasis>
- <property>"beanName"</property>
- </emphasis> attribute defines the request scope bean name
- you'd like to re-use. Note that this attribute must point to
- a legal JSF EL expression which resolves to a managed mean instance.
- For example for the above code the class definition may look like this
- one: </para>
- <programlisting role="JAVA"><![CDATA[class MyClass{
+ <para> The <emphasis><property>"beanName"</property></emphasis> attribute defines the request scope bean name you'd like to re-use. Note that this attribute must point to a legal JSF EL expression which resolves to a managed mean instance.
+ For example for the above code the class definition may look like this one:
+ </para>
+ <programlisting role="JAVA"><![CDATA[class MyClass{
...
private TestBean testBean;
// Getters and Setters for testBean.
...
}
]]></programlisting>
- <para> The <emphasis>
- <property>"ajaxOnly"</property>
- </emphasis> attribute declares whether the value of the bean should be
- available during a non-Ajax request. If the value of this attribute is
- "true" a request scope bean keeps the same value
- during Ajax requests from the given page. If a non-Ajax request is
- sent from this page the bean is re-created as a regular request scope
- bean. </para>
+
+ <para>
+ The <emphasis><property>"ajaxOnly"</property></emphasis> attribute declares whether the value of the bean should be available during a non-Ajax request.
+ If the value of this attribute is "true" a request scope bean keeps the same value during Ajax requests from the given page.
+ If a non-Ajax request is sent from this page the bean is re-created as a regular request scope bean.
+ </para>
</section>
+
<section>
<title>Relevant resources links</title>
- <para><ulink
- url="http://livedemo.exadel.com/richfaces-demo/richfaces/keepAlive.jsf?c=keepAlive"
- >On the component LiveDemo page</ulink> you can see the example of <emphasis
- role="bold">
- <property><a4j:keepAlive></property>
- </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://jboss.com/index.html?module=bb&op=viewtopic&t=104989"
- >Ajax4JSF Users Forum</ulink>. </para>
+ <para>
+ Vizit <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/keepAlive.jsf?c=keepAlive">KeepAlive page</ulink> at RichFaces Livedemo for examples of component usage and their sources.
+ </para>
+
+ <para>
+ Search the <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=261">RichFaces Users forum</ulink> for some additional information about usage of component.
+ </para>
</section>
</chapter>
More information about the richfaces-svn-commits
mailing list