From richfaces-svn-commits at lists.jboss.org Thu Sep 10 07:19:51 2009
Content-Type: multipart/mixed; boundary="===============4578941727802548469=="
MIME-Version: 1.0
From: richfaces-svn-commits at lists.jboss.org
To: richfaces-svn-commits at lists.jboss.org
Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r15522 -
 branches/community/3.3.X/docs/userguide/en/src/main/docbook/included.
Date: Thu, 10 Sep 2009 07:19:51 -0400
Message-ID: <200909101119.n8ABJpba000610@svn01.web.mwc.hst.phx2.redhat.com>

--===============4578941727802548469==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: artdaw
Date: 2009-09-10 07:19:50 -0400 (Thu, 10 Sep 2009)
New Revision: 15522

Modified:
   branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4j=
_actionparam.xml
   branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4j=
_ajaxListener.xml
   branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4j=
_form.xml
Log:
https://jira.jboss.org/jira/browse/RF-7275 - <a4j:actionparam> was fixed

Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/inclu=
ded/a4j_actionparam.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4=
j_actionparam.xml	2009-09-10 08:21:49 UTC (rev 15521)
+++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4=
j_actionparam.xml	2009-09-10 11:19:50 UTC (rev 15522)
@@ -1,109 +1,160 @@
 <section role=3D"NotInToc" id=3D"a4j_actionparam">
-   <title>
-				&lt;
-				a4j:actionparam
-				&gt;
-				<emphasis role=3D"since">
-         <superscript> available since <emphasis role=3D"version">3.0.0</e=
mphasis>
-         </superscript>
-      </emphasis>
-   </title>
-   <section role=3D"NotInToc">
-      <sectioninfo>
+    <title>
+        &lt;
+        a4j:actionparam
+        &gt;
+        <emphasis role=3D"since">
+            <superscript>available since
+                <emphasis role=3D"version">3.0.0</emphasis>
+            </superscript>
+        </emphasis>
+    </title>
+    <section role=3D"NotInToc">
+        <sectioninfo>
             <keywordset>
-                  <keyword>a4j:actionparam</keyword>
+                <keyword>a4j:actionparam</keyword>
             </keywordset>
-      </sectioninfo>
-      <title>Description</title>
-      <para>
-            The <emphasis role=3D"bold">
-            <property>&lt;a4j:actionparam&gt;</property>
-         </emphasis> component combines the functionality of both JSF <emp=
hasis role=3D"bold">
-            <property>&lt;f:param&gt;</property>
-         </emphasis> and <emphasis role=3D"bold">
-            <property>&lt;f:actionListener&gt;</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>
+        </sectioninfo>
+        <title>Description</title>
+        <para>
+            The
+            <emphasis role=3D"bold">
+                <property>&lt;a4j:actionparam&gt;</property>
+            </emphasis>
+            component combines the functionality of
+            <emphasis role=3D"bold">
+                <property>&lt;f:param&gt;</property>
+            </emphasis>
+            and
+            <emphasis role=3D"bold">
+                <property>&lt;f:actionListener&gt;</property>
+            </emphasis>
+            and allows to assign the value to the property of the managed =
bean directly using the
+            <emphasis>
+                <property>&quot;assignTo&quot;</property>
+            </emphasis>
+            attribute.
+        </para>
 =

-   </section>
-   <section>
+    </section>
+    <section>
         <title>Details of Usage</title>
-       <para>
-             The component <emphasis role=3D"bold">
-            <property>&lt;a4j:actionparam&gt;</property>
-         </emphasis> is a combination of the functionality of two JSF tags=
: =

-             <emphasis role=3D"bold">
-            <property>&lt;f:param&gt;</property>
-         </emphasis> and <emphasis role=3D"bold">
-            <property>&lt;f:actionListener&gt;</property>
-         </emphasis>.
-       </para>
-        <para>At the render phase, it's decoded by parent component (<emph=
asis role=3D"bold">
-            <property>&lt;h:commandLink&gt;</property>
-         </emphasis> or like) as usual. =

-              At the process request phase, if the parent component perfor=
ms 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 t=
he <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> ins=
tance to the parent component as an action listener.
+        <para>
+            The
+            <emphasis role=3D"bold">
+                <property>&lt;a4j:actionparam&gt;</property>
+            </emphasis>
+            component has 3 main attributes:
         </para>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <emphasis>
+                        <property>&quot;name&quot;</property>
+                    </emphasis>
+                    defines a name of this parameter
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis>
+                        <property>&quot;value&quot;</property>
+                    </emphasis>
+                    defines initial value of this parameter or a value bin=
ding
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis>
+                        <property>&quot;assignTo&quot;</property>
+                    </emphasis>
+                    defines updatable bean property. This property will be=
 updated if the parent
+                    command component performs an actionEvent during the &=
quot;Process Request&quot; phase.
+                </para>
+            </listitem>
+        </itemizedlist>
         <para>
-              <emphasis role=3D"bold">
-            <property>&lt;a4j:actionparam&gt;</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>
+            <emphasis role=3D"bold">Example:</emphasis>
+        </para>
+        <programlisting role=3D"XML"><![CDATA[...
+<h:form id=3D"form">
+    <a4j:commandButton value=3D"Set Name to Alex" reRender=3D"rep">
+        <a4j:actionparam name=3D"username" value=3D"Alex" assignTo=3D"#{ac=
tionparamBean.name}"/>
+    </a4j:commandButton>
+    <br/>
+    <h:outputText id=3D"rep" value=3D"Name: #{actionparamBean.name}"/>
+</h:form>
+...]]></programlisting>
         <para>
-              <emphasis role=3D"bold">Example:</emphasis>
+            There is a managed bean:
         </para>
-            <programlisting role=3D"XML"><![CDATA[...
-<script>
-    ...
-    var foo =3D "bar";
-    ...
-</script>
-...
-<a4j:actionparam noEscape=3D"true" name=3D"param1" value=3D"foo" assignTo=
=3D"#{bean.prop1}" />
+        <programlisting role=3D"JAVA"><![CDATA[...
+public class ActionparamBean {
+    private String name =3D "John";
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name =3D name;
+    }
+}
 ...]]></programlisting>
-	     <para>
-	      The <emphasis role=3D"bold">
-            <property>&lt;a4j:param&gt;</property>
-         </emphasis> extends <emphasis role=3D"bold">
-            <property>&lt;f:param&gt;</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>	=

+        <para>
+            You can use
+            <emphasis role=3D"bold">
+                <property>&lt;a4j:actionparam&gt;</property>
+            </emphasis>
+            not only with Ajax components, but with non-ajax command compo=
nent also.
+            This feature allows to update model values without invoking ev=
en a single line of Java code on the
+            server side. The usage of this feature you can find at
+            <ulink url=3D"http://livedemo.exadel.com/richfaces-demo/richfa=
ces/actionparam.jsf?c=3Dactionparam&amp;tab=3Dusage">
+                ActionParameter Usage
+            </ulink>
+            page of RichFaces LiveDemo.
+        </para>
+        <para>
+            If you need to convert the value before the &quot;Update Model=
&quot; phase
+            you can specify the converter in the
+            <emphasis>
+                <property>&quot;converter&quot;</property>
+            </emphasis>
+            attribute.
+        </para>
+        <note>
+            <title>Note:</title>
+            <para>
+                The property is assigned with a parameter value on the &qu=
ot;Update Model&quot; phase. Therefore if the
+                validation of the form is failed, this phase will be skipp=
ed and the property won&apos;t be updated.
+            </para>
+        </note>
+        <para>
+            It is possible to use JavaScript expression or function in the
+            <emphasis>
+                <property>&quot;value&quot;</property>
+            </emphasis>
+            attribute.
+            In this case the
+            <emphasis>
+                <property>&quot;noEscape&quot;</property>
+            </emphasis>
+            attribute should be set to &quot;true&quot;.
+            The result of this JavaScript invocation is sent to the server=
 as a value of
+            <emphasis role=3D"bold">
+                <property>&lt;a4j:actionparam&gt;</property>
+            </emphasis>
+            .
+        </para>
     </section>
-   <section>
-      <title>Reference Data</title>
-      <para>
-         <ulink url=3D"&tlddoc;a4j/actionparam.html">Table of =

-							&lt;a4j:actionparam&gt; =

-							 attributes</ulink>.
-						</para>
-      <table frame=3D"all">
+    <section>
+        <title>Reference Data</title>
+        <para>
+            <ulink url=3D"&tlddoc;a4j/actionparam.html">Table of
+                &lt;a4j:actionparam&gt;
+                attributes</ulink>.
+        </para>
+        <table frame=3D"all">
             <title>Component Identification Parameters</title>
             <tgroup cols=3D"2">
                 <thead>
@@ -117,31 +168,42 @@
                         <entry>component-type</entry>
                         <entry>org.ajax4jsf.ActionParameter</entry>
                     </row>
-                    =

+
                     <row>
                         <entry>component-class</entry>
                         <entry>org.ajax4jsf.component.html.HtmlActionParam=
eter</entry>
                     </row>
-                    =

+
                 </tbody>
             </tgroup>
         </table>
-   </section>
-   <section>
-      <title>Relevant Resources Links</title>
+    </section>
+    <section>
+        <title>Relevant Resources Links</title>
         <para>
-              Visit the <ulink url=3D"http://livedemo.exadel.com/richfaces=
-demo/richfaces/actionparam.jsf?c=3Dactionparam">ActionParamter page</ulink=
> at RichFaces LiveDemo for examples of component usage abd their sources. =

+            Visit the
+            <ulink url=3D"http://livedemo.exadel.com/richfaces-demo/richfa=
ces/actionparam.jsf?c=3Dactionparam">
+                ActionParameter</ulink>
+            page at RichFaces LiveDemo for examples of component usage and=
 their sources.
         </para>
         <para>
-              More information can be found on the <ulink url=3D"http://ww=
w.jboss.com/index.html?module=3Dbb&amp;op=3Dviewtopic&amp;p=3D4063764">Ajax=
4jsf Users Forum</ulink>.
-        </para>	=

+            More information can be found on the
+            <ulink
+                url=3D"http://www.jboss.com/index.html?module=3Dbb&amp;op=
=3Dviewtopic&amp;p=3D4063764">Ajax4jsf Users
+            Forum</ulink>.
+        </para>
         <para>
-              More information about <emphasis role=3D"bold">
-            <property>&lt;f:param&gt;</property>
-         </emphasis> and <emphasis role=3D"bold">
-            <property>&lt;f:actionListener&gt;</property>
-         </emphasis>can be found <ulink url=3D"http://java.sun.com/javaee/=
javaserverfaces/1.2/docs/tlddocs/index.html">in Sun JSF TLD documentation</=
ulink>.
+            More information about
+            <emphasis role=3D"bold">
+                <property>&lt;f:param&gt;</property>
+            </emphasis>
+            and
+            <emphasis role=3D"bold">
+                <property>&lt;f:actionListener&gt;</property>
+            </emphasis>
+            can be found in
+            <ulink url=3D"http://java.sun.com/javaee/javaserverfaces/1.2/d=
ocs/tlddocs/index.html">Sun JSF
+            TLD documentation</ulink>.
         </para>
-        =

-  </section>
+    </section>
 </section>
\ No newline at end of file

Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/inclu=
ded/a4j_ajaxListener.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4=
j_ajaxListener.xml	2009-09-10 08:21:49 UTC (rev 15521)
+++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4=
j_ajaxListener.xml	2009-09-10 11:19:50 UTC (rev 15522)
@@ -70,9 +70,7 @@
             The object on which the Event initially occurred could be acce=
ssed using the
             <code>
                 <ulink url=3D"http://java.sun.com/j2se/1.4.2/docs/api/java=
/util/EventObject.html">
-                    <property>java.util.EventObject.getSource()</property>
-                </ulink>
-            </code>
+                    <property>java.util.EventObject.getSource()</property>=
</ulink></code>
             method.
         </para>
         <para>
@@ -95,7 +93,7 @@
 =

         <programlisting role=3D"XML"><![CDATA[...
 <rich:messages/>
-<h:form id=3D"form" ajaxSubmit=3D"true">
+<h:form id=3D"form">
     <a4j:commandLink value=3D"Click to send Ajax request">
         <a4j:ajaxListener type=3D"org.docs.richfaces.actionListenerBean"/>
     </a4j:commandLink>
@@ -172,12 +170,12 @@
         <para>
             Visit
             <ulink url=3D"http://livedemo.exadel.com/richfaces-demo/richfa=
ces/ajaxListener.jsf?c=3DajaxListener">
-                AjaxListener
-            </ulink>
+                AjaxListener</ulink>
             page at RichFaces Livedemo for examples of component usage and=
 their sources.
         </para>
         <para>
-            Check Sun JSF TLD documentation for more information on<ulink
+            Check Sun JSF TLD documentation for more information on
+            <ulink
                 url=3D"http://java.sun.com/javaee/javaserverfaces/1.1_01/d=
ocs/tlddocs/f/valueChangeListener.html">&lt;f:valueChangeListener&gt;
             tag</ulink>.
         </para>

Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/inclu=
ded/a4j_form.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4=
j_form.xml	2009-09-10 08:21:49 UTC (rev 15521)
+++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/a4=
j_form.xml	2009-09-10 11:19:50 UTC (rev 15522)
@@ -206,9 +206,10 @@
             at RichFaces Livedemo for examples of component usage and thei=
r sources.
         </para>
         <para>
-            For additional information about attributes of this component =
read<ulink
+            For additional information about attributes of this component =
read
+            <ulink
                 url=3D"http://livedemo.exadel.com/richfaces-demo/richfaces=
/ajaxAttributes.jsf?c=3Dajaxattributes">'Ajax
-            Attribute' section</ulink>.
+            Attribute</ulink> section.
         </para>
     </section>
 </section>
\ No newline at end of file


--===============4578941727802548469==--