Author: artdaw
Date: 2008-06-16 08:22:15 -0400 (Mon, 16 Jun 2008)
New Revision: 9051
Modified:
trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml
Log:
http://jira.jboss.com/jira/browse/RF-3701 - Description was checked. Info about
'ajaxOnly' attribute was added
Modified: trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml 2008-06-16 12:17:06
UTC (rev 9050)
+++ trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml 2008-06-16 12:22:15
UTC (rev 9051)
@@ -59,32 +59,39 @@
<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
<property>managed-bean-scope</property> tag then the life-time of
+ 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.
+ 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>
- <para><emphasis
role="bold">Example:</emphasis></para>
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
<programlisting role="XML"><![CDATA[<a4j:keepAlive beanName =
"#{myClass.testBean}"/>]]></programlisting>
<para>
- Note that the attribute
<emphasis><property>"beanName"</property></emphasis>
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:</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{
+class MyClass{
...
private TestBean testBean;
// Getters and Setters for testBean.
...
}
- ]]></programlisting>
-
-
+]]></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>
</section>
<section>
<title>Relevant resources links</title>