Author: atsebro
Date: 2009-07-10 11:48:33 -0400 (Fri, 10 Jul 2009)
New Revision: 14893
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/actionparam.desc.xml
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/actionparam.xml
Log:
RF-7478: a4j:actionparam component description review
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/actionparam.desc.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/actionparam.desc.xml 2009-07-10
13:52:02 UTC (rev 14892)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/actionparam.desc.xml 2009-07-10
15:48:33 UTC (rev 14893)
@@ -1,25 +1,16 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter>
<section role="NotInToc">
- <sectioninfo>
- <keywordset>
- <keyword>a4j:actionparam</keyword>
- </keywordset>
- </sectioninfo>
- <title>Description</title>
- <para>The <emphasis role="bold">
- <property><a4j:actionparam></property>
- </emphasis> component combines the functionality of both JSF components:
<emphasis role="bold">
- <property><f:param></property>
- </emphasis> and <emphasis role="bold">
- <property><f:actionListener></property>
- </emphasis>.</para>
- <para>More information about <emphasis role="bold">
- <property><f:param></property>
- </emphasis> and <emphasis role="bold">
- <property><f:actionListener></property>
- </emphasis>can be found <ulink
-
url="http://java.sun.com/javaee/javaserverfaces/1.2/docs/tlddocs/ind...
- >in Sun JSF TLD documentation</ulink>.</para>
+ <sectioninfo>
+ <keywordset>
+ <keyword>a4j:actionparam</keyword>
+ </keywordset>
+ </sectioninfo>
+ <title>Description</title>
+ <para>
+ The <emphasis
role="bold"><property><a4j:actionparam></property></emphasis>
component combines the functionality of both JSF <emphasis
role="bold"><property><f:param></property></emphasis>
and <emphasis
role="bold"><property><f:actionListener></property></emphasis>
+ and allows to assign the value to the property of the manager bean directly
using the <emphasis><property>assignTo</property></emphasis>
attribute.
+ </para>
+
</section>
-</chapter>
+</chapter>
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/actionparam.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/actionparam.xml 2009-07-10
13:52:02 UTC (rev 14892)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/actionparam.xml 2009-07-10
15:48:33 UTC (rev 14893)
@@ -30,7 +30,7 @@
</table>
</para>
<section>
- <title>Creating on a page</title>
+ <title>Creating the Component with a Page Tag</title>
<para>Simple component definition example:</para>
<para>
<emphasis role="bold">Example:</emphasis>
@@ -48,28 +48,27 @@
...
]]></programlisting>
</section>
- <section>
- <title>Key attributes and ways of usage</title>
- <para>The component <emphasis role="bold">
- <property><a4j:actionparam></property>
- </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>
- </emphasis>.</para>
- <para>At the render phase, it's decoded by parent component
(<emphasis role="bold">
- <property><h:commandLink></property>
- </emphasis> or like) as usual. At the process request phase, if the
parent component
- performs an action event, update the
<emphasis><property>"value"</property></emphasis>
specified in the
<emphasis><property>"assignTo"</property></emphasis>
- attribute as its
<emphasis><property>"value"</property></emphasis>.
If a
<emphasis><property>"converter"</property></emphasis>
attribute is specified, use it to encode and
- decode the
<emphasis><property>"value"</property></emphasis>
to a string stored in the html parameter.
- To make the
<emphasis><property>"assignTo"</property></emphasis>
attribute usable add the <code>actionParam</code> instance to the parent
component as an action listener.</para>
- <para><emphasis role="bold">
- <property><a4j:actionparam></property>
- </emphasis>has a
<emphasis><property>"noEscape"</property></emphasis>
attribute. If it is set to
- <property>"true"</property>, the
<emphasis><property>"value"</property></emphasis>
is evaluated as a JavaScript code. </para>
+
+
+
+
+ <section>
+ <title>Details of usage</title>
+ <para>
+ The component <emphasis
role="bold"><property><a4j:actionparam></property></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></emphasis>.
+ </para>
+ <para>At the render phase, it's decoded by parent component
(<emphasis
role="bold"><property><h:commandLink></property></emphasis>
or like) as usual.
+ At the process request phase, if the parent component performs an action
event, update the
<emphasis><property>"value"</property></emphasis>
specified in the
+
<emphasis><property>"assignTo"</property></emphasis>attribute
as its
<emphasis><property>"value"</property></emphasis>.
+ If a
<emphasis><property>"converter"</property></emphasis>
attribute is specified, use it to encode and decode the
<emphasis><property>"value"</property></emphasis>
to a string stored in the html parameter.
+ To make the
<emphasis><property>"assignTo"</property></emphasis>
attribute usable add the <code>actionParam</code> instance to the parent
component as an action listener.
+ </para>
<para>
- <emphasis role="bold">Example:</emphasis>
+ <emphasis
role="bold"><property><a4j:actionparam></property></emphasis>has
a
<emphasis><property>"noEscape"</property></emphasis>
attribute.
+ If it is set to <property>"true"</property>,
the
<emphasis><property>"value"</property></emphasis>
is evaluated as a JavaScript code. </para>
+ <para>
+ <emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
<script>
@@ -81,20 +80,23 @@
<a4j:actionparam noEscape="true" name="param1"
value="foo" assignTo="#{bean.prop1}" />
...]]></programlisting>
<para>
- The <emphasis
role="bold"><property><a4j:param></property></emphasis>
extends
- <emphasis
role="bold"><property><f:param></property></emphasis>,
so the
<emphasis><property>"name"</property></emphasis>
attribute is mandatory.
- Otherwise, the
<emphasis><property>"value"</property></emphasis>
misses due missing the request parameter name for it.
+ The <emphasis
role="bold"><property><a4j:param></property></emphasis>
extends <emphasis
role="bold"><property><f:param></property></emphasis>,
+ so the
<emphasis><property>"name"</property></emphasis>
attribute is mandatory.
+ Otherwise, the
<emphasis><property>"value"</property></emphasis>
misses due missing the request parameter name for it.
</para>
</section>
<section>
<title>Relevant resources links</title>
- <para>
- <ulink
url="http://livedemo.exadel.com/richfaces-demo/richfaces/actionparam...
the component LiveDemo page</ulink>
- you can see the example of <emphasis role="bold"
-
><property><a4j:actionparam></property></emphasis>
usage and sources for the given example.
- </para>
- <para>More information can be found on the <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewtopic&...
- >Ajax4jsf Users Forum</ulink>.</para>
+ <para>
+ Vizit the <ulink
url="http://livedemo.exadel.com/richfaces-demo/richfaces/actionparam...
page</ulink> at RichFaces LiveDemo for examples of component usage abd their
sources.
+ </para>
+ <para>
+ More information can be found on the <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewtopic&...
Users Forum</ulink>.
+ </para>
+ <para>
+ More information about <emphasis
role="bold"><property><f:param></property></emphasis>
and <emphasis
role="bold"><property><f:actionListener></property></emphasis>can
be found <ulink
url="http://java.sun.com/javaee/javaserverfaces/1.2/docs/tlddocs/ind...
Sun JSF TLD documentation</ulink>.
+ </para>
+
</section>
</chapter>