From richfaces-svn-commits at lists.jboss.org Wed Jul 16 07:43:39 2008
Content-Type: multipart/mixed; boundary="===============0169954583521509711=="
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: r9630 -
 trunk/docs/userguide/en/src/main/docbook/included.
Date: Wed, 16 Jul 2008 07:43:39 -0400
Message-ID: <E1KJ5Q3-0000Y8-GM@committer01.frg.pub.inap.atl.jboss.com>

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

Author: atsebro
Date: 2008-07-16 07:43:39 -0400 (Wed, 16 Jul 2008)
New Revision: 9630

Modified:
   trunk/docs/userguide/en/src/main/docbook/included/componentControl.xml
Log:
RF-3100:rich:componentControl rewrite

Modified: trunk/docs/userguide/en/src/main/docbook/included/componentContro=
l.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
--- trunk/docs/userguide/en/src/main/docbook/included/componentControl.xml	=
2008-07-16 07:22:19 UTC (rev 9629)
+++ trunk/docs/userguide/en/src/main/docbook/included/componentControl.xml	=
2008-07-16 11:43:39 UTC (rev 9630)
@@ -80,16 +80,98 @@
 ]]></programlisting>
   </section>
 =

+
+
+
+
+
   <section>
     <title>Details of Usage</title>
     <para>
-      In order to use the <emphasis role=3D"bold"><property>&lt;rich:compo=
nentControl&gt;</property></emphasis> with another components you need to t=
ake the following steps:
+      <emphasis role=3D"bold"><property>&lt;rich:componentControl&gt;</pro=
perty></emphasis> =

+      is a command component, that allows to call JavaScript API function =
on some defined event. =

+      Look at the example:
+      </para>
+      <programlisting role=3D"XML"><![CDATA[...
+<rich:componentControl attachTo=3D"doExpandCalendarID" event=3D"onclick" f=
or=3D"ccCalendarID" operation=3D"Expand"/>
+...
+]]></programlisting>
+    <para>
+      In other words it means &quot;clicking on the component with ID &apo=
s;doExpandCalendarID&apos;, =

+      expands the component with ID &apos;ccCalendarID&apos;&quot;. =

+      It can be said, that <emphasis role=3D"bold"><property>&lt;rich:comp=
onentControl&gt;</property></emphasis> =

+      connects two components with the help of JavaScript API function.
+    </para>
+    <para>
+      Component ID, to wich the event, that invokes JavaScript API functio=
n is applied, =

+      is defined with <emphasis><property>&quot;attachTo&quot;</property><=
/emphasis> attribute =

+      (see the exapmle above). =

+      If <emphasis><property>&quot;attachTo&quot;</property></emphasis> at=
tribute is not defined, =

+      the component will be attached to the parent component.
+    </para>
+    <para>
+      <emphasis role=3D"bold">Example:</emphasis>
+    </para>
+    <programlisting role=3D"XML"><![CDATA[...
+<h:commandButton value=3D"Show Modal Panel">
+    <rich:componentControl for=3D"ccModalPanelID" event=3D"onclick" operat=
ion=3D"show"/> <!--attached to the commandButton-->
+</h:commandButton>
+...
+]]></programlisting>
+    <para>
+      On the result page the component is rendered to JavaScript code. =

+      This means, that it is possible to invoke the <emphasis role=3D"bold=
"><property>&lt;rich:componentControl&gt;</property></emphasis> =

+      handler operation as usual JavaScript function.  =

+      This function is called by name, specified in the component <emphasi=
s><property>&quot;name&quot;</property></emphasis> attribute. =

+      The definition of <emphasis><property>&quot;name&quot;</property></e=
mphasis> attribute is shown on the example below:
+    </para>
+    <programlisting role=3D"XML"><![CDATA[...
+<rich:componentControl name=3D"func" event=3D"onRowClick" for=3D"menu" ope=
ration=3D"show" />
+...
+]]></programlisting>
+    <para>
+      The generated JavaScript function will look as shown below:
+    </para>
+    <programlisting role=3D"XML"><![CDATA[function func (event) {
+}
+]]></programlisting>
+      <para>
+        An important <emphasis role=3D"bold"><property>&lt;rich:componentC=
ontrol&gt;</property></emphasis> feature, =

+        is that it allows transferring parameters, with the help of specia=
l attribute <emphasis><property>&quot;params&quot;</property></emphasis>.
+      </para>
+    <para>
+      <emphasis role=3D"bold">Example:</emphasis>
+    </para>
+    <programlisting role=3D"XML"><![CDATA[...
+<rich:componentControl name=3D"func" event=3D"onRowClick" for=3D"menu" ope=
ration=3D"show" params=3D=E2=80=9D#{car.model}"/>
+...
+]]></programlisting>
+    <para>
+      The alternative way for parameters transferring uses <emphasis role=
=3D"bold"><property>&lt;f:param&gt;</property></emphasis> attribute. =

+      As the code above, the following code will represent the same functi=
onality.
+    </para>
+    <para>
+      <emphasis role=3D"bold">Example:</emphasis>
+    </para>
+    <programlisting role=3D"XML"><![CDATA[...
+<rich:componentControl event=3D"onRowClick" for=3D"menu" operation=3D"show=
">
+                <f:param value=3D"#{car.model}" name=3D"model"/>
+</rich:componentControl>
+...
+]]></programlisting>
     =

-    <!--
-      There are three ways to use the <emphasis role=3D"bold">
-        <property>&lt;rich:componentControl&gt;</property>
-      </emphasis> to another component.
-      -->
+      =

+      =

+      =

+     =

+      =

+      =

+      =

+      =

+      =

+ <!--     In order to use the <emphasis role=3D"bold"><property>&lt;rich:c=
omponentControl&gt;</property></emphasis> with another components you need =
to take the following steps:
+    =

+  =

     </para>
     <itemizedlist>
       <listitem><para>Define a name of a function that is generated (defin=
ition is similar to a
@@ -176,7 +258,11 @@
         <property>&quot;operation&quot;</property>
       </emphasis> attribute contains a name of JavaScript API function. Th=
us, clicking on the link
       represents the next year on the calendar.
-    </para>
+      </para> -->
+    =

+    =

+    =

+    =

     <para>
       With the help of the <emphasis><property>&quot;attachTiming&quot;</p=
roperty></emphasis> attribute you can define the page loading phase when
       <emphasis role=3D"bold"><property>&lt;rich:componentControl&gt;</pro=
perty></emphasis> is attached to source component. Possible values are: =



--===============0169954583521509711==--