[richfaces-svn-commits] JBoss Rich Faces SVN: r4923 - branches/3.1.x/docs/userguide/en/src/main/docbook/included.

richfaces-svn-commits at lists.jboss.org richfaces-svn-commits at lists.jboss.org
Wed Dec 19 10:31:26 EST 2007 

Author: vkorluzhenko
Date: 2007-12-19 10:31:25 -0500 (Wed, 19 Dec 2007)
New Revision: 4923

Modified:
   branches/3.1.x/docs/userguide/en/src/main/docbook/included/componentControl.desc.xml
   branches/3.1.x/docs/userguide/en/src/main/docbook/included/componentControl.xml
Log:
http://jira.jboss.com/jira/browse/RF-1537 - updated description

Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/included/componentControl.desc.xml
===================================================================
--- branches/3.1.x/docs/userguide/en/src/main/docbook/included/componentControl.desc.xml	2007-12-19 15:29:47 UTC (rev 4922)
+++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/componentControl.desc.xml	2007-12-19 15:31:25 UTC (rev 4923)
@@ -9,8 +9,7 @@
         <title>Description</title>
         <para>The <emphasis role="bold">
                 <property>&lt;rich:componentControl&gt;</property>
-            </emphasis> component allows to manage other components or operation on other components
-            via API.</para>
+            </emphasis> allows to call JS API functions on components after defined events.</para>
 
     </section>
     <!--section>

Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/included/componentControl.xml
===================================================================
--- branches/3.1.x/docs/userguide/en/src/main/docbook/included/componentControl.xml	2007-12-19 15:29:47 UTC (rev 4922)
+++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/componentControl.xml	2007-12-19 15:31:25 UTC (rev 4923)
@@ -81,12 +81,14 @@
 
   <section>
     <title>Details of Usage</title>
-    <para>There are three ways to attach the <emphasis role="bold">
+    <para>There are three ways to use the <emphasis role="bold">
         <property>&lt;rich:componentControl&gt;</property>
       </emphasis> to another component.</para>
     <itemizedlist>
-      <listitem>Defining a name of a function that is generated. An &quot;event&quot;
-        argument is passed to this function.</listitem>
+      <listitem>Defining a name of a function that is generated (definition is similar to a
+        definition of <emphasis role="bold">
+          <property>&lt;a4j:jsFunction&gt;</property>
+        </emphasis>). An &quot;event&quot; argument is passed to this function.</listitem>
     </itemizedlist>
     <para>An example is placed below:</para>
     <programlisting role="XML"><![CDATA[...
@@ -94,8 +96,8 @@
 ...
 ]]></programlisting>
     <para>According to this code a function with name <property>&quot;call&quot;</property>
-      is generated. It is used in JavaScript code to trigger an operation on the target
-      component with defined id=<property>&quot;comp_ID&quot;</property>.</para>
+      is generated. It is used in JavaScript code to trigger an operation on the target component
+      with defined id=<property>&quot;comp_ID&quot;</property>.</para>
     <para>The generated function is shown below:</para>
     <programlisting role="JAVA"><![CDATA[function ffunction (event) {
 }
@@ -103,7 +105,7 @@
     <itemizedlist>
       <listitem>Attaching to a parent component (usage is similar to <emphasis role="bold">
           <property>&lt;a4j:support&gt;</property>
-        </emphasis> component)</listitem>
+        </emphasis> component).</listitem>
     </itemizedlist>
     <para>An example is placed below:</para>
 
@@ -112,21 +114,29 @@
         ...
     </rich:modalPanel>
     <h:commandButton value="Show Modal Panel">
-        <rich:componentControl for="ccModalPanelID" event="onclick" disableDefault="true" operation="show" params="show:'componentControl work(show)'" />
+        <rich:componentControl for="ccModalPanelID" event="onclick" disableDefault="true" operation="show">
+                <f:param name="show" value="componentControl work(show)"/>
+        <rich:componentControl/>
     </h:commandButton>
 ...
 ]]></programlisting>
-    <para>In the example is shown a possibility to manage <emphasis role="bold">
-        <property>&lt;rich:modalpanel&gt;</property>
-      </emphasis> component via <emphasis role="bold">
-        <property>&lt;h:commandButton&gt;</property>
-      </emphasis>. The <emphasis>
+    <para>In the example the <emphasis>
         <property>&quot;for&quot;</property>
       </emphasis> attribute contains value of an Id of <emphasis role="bold">
         <property>&lt;rich:modalpanel&gt;</property>
       </emphasis> component. The <emphasis>
         <property>&quot;operation&quot;</property>
-      </emphasis> attribute contains a name of JavaScript API function. The <emphasis>
+      </emphasis> attribute contains a name of JavaScript API function. An <emphasis>
+        <property>&quot;event&quot;</property>
+      </emphasis> attribute is used to trigger an operation defined with the <emphasis>
+        <property>&quot;operation&quot;</property>
+      </emphasis> attribute. A set of parameters is defined with <emphasis role="bold">
+        <property>&lt;f:param&gt;</property>
+      </emphasis>. As an alternative, the <emphasis>
+        <property>&quot;params&quot;</property>
+      </emphasis> attribute can be used. Thus, one of main features is that <emphasis role="bold">
+        <property>&lt;rich:componentControl&gt;</property>
+      </emphasis> allows to transfer parameters. The <emphasis>
         <property>&quot;disableDefault&quot;</property>
       </emphasis> attribute with <property>&quot;true&quot;</property> value is used instead
       of <property>onclick="return false;"</property> attribute for <emphasis role="bold">
@@ -135,7 +145,7 @@
     <itemizedlist>
       <listitem>Attaching with <emphasis>
           <property>&quot;attachTo&quot;</property>
-        </emphasis> attribute</listitem>
+        </emphasis> attribute.</listitem>
     </itemizedlist>
     <para>An example is placed below:</para>
 
@@ -148,9 +158,7 @@
     <rich:componentControl attachTo="doExpandCalendarID" for="ccCalendarID" event="onclick" disableDefault="true" operation="nextYear" />
 ...
 ]]></programlisting>
-    <para>In the example is shown a possibility to manage the <emphasis role="bold">
-        <property>&lt;rich:calendar&gt;</property>
-      </emphasis> component. The <emphasis>
+    <para>In the example the <emphasis>
         <property>&quot;attachTo&quot;</property>
       </emphasis> attribute contais a value of an Id of <property>&lt;a&gt;</property> tag.
       The <emphasis>
@@ -188,22 +196,23 @@
 ]]></programlisting-->
 
   </section>
-  
+
   <section>
     <title>Look-and-Feel Customization</title>
-    
+
     <para><emphasis role="bold">
-      <property>&lt;rich:componentControl&gt;</property>
-    </emphasis> has no skin parameters and custom <property>style classes</property>, as the
+        <property>&lt;rich:componentControl&gt;</property>
+      </emphasis> has no skin parameters and custom <property>style classes</property>, as the
       component isn&apos;t visual.</para>
   </section>
-  
+
   <section>
     <title>Relevant Resources Links</title>
-    <para><ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/componentControl.jsf?c=componentControl"
-      >Here</ulink> you can see an example of <emphasis role="bold">
+    <para><ulink
+        url="http://livedemo.exadel.com/richfaces-demo/richfaces/componentControl.jsf?c=componentControl"
+        >Here</ulink> you can see an example of <emphasis role="bold">
         <property>&lt;rich:componentControl&gt;</property>
       </emphasis> usage and sources for the given example. </para>
   </section>
-  
+
 </section>

More information about the richfaces-svn-commits mailing list