From richfaces-svn-commits at lists.jboss.org Tue Aug 4 10:00:54 2009
Content-Type: multipart/mixed; boundary="===============6186597048585700623=="
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: r15107 -
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included.
Date: Tue, 04 Aug 2009 10:00:54 -0400
Message-ID: <200908041400.n74E0s8r012364@svn01.web.mwc.hst.phx2.redhat.com>
--===============6186597048585700623==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Author: atsebro
Date: 2009-08-04 10:00:54 -0400 (Tue, 04 Aug 2009)
New Revision: 15107
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/com=
ponentControl.xml
Log:
RF-7587:rich:componentControl component description review
Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/inclu=
ded/componentControl.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/co=
mponentControl.xml 2009-08-04 12:32:33 UTC (rev 15106)
+++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/co=
mponentControl.xml 2009-08-04 14:00:54 UTC (rev 15107)
@@ -58,10 +58,6 @@
=
To create the simplest variant on a page use the following synta=
x:
=
-
-
- Example:
-
...]]>
@@ -81,73 +77,52 @@
=
=
=
-
-
-
Details of Usage
- <rich:componentControl> =
- is a command component, that allows to call JavaScript API function =
on some defined event. =
- Look at the example:
-
-
+ <rich:componentControl><=
/property> is a command component, that allows to call JavaScrip=
t API function on some defined event. =
+ Look at the example:
+
+
...
]]>
- In other words it means "clicking on the component with ID &apo=
s;doExpandCalendarID', =
- expands the component with ID 'ccCalendarID'". =
- It can be said, that <rich:comp=
onentControl> =
- connects two components with the help of JavaScript API function.
+ In other words it means "clicking on the component with ID =
doExpandCalendarID expands the component with ID ccCalen=
darID". =
+ It can be said, that <rich:=
componentControl> makes interact two components wi=
th the help of JavaScript API function.
- Component ID, to wich the event, that invokes JavaScript API functio=
n is applied, =
- is defined with "attachTo"<=
/emphasis> attribute =
- (see the exapmle above). =
- If "attachTo" at=
tribute is not defined, =
- the component will be attached to the parent component.
+ The ID of the component the event that invokes JavaScript API fu=
nction is applied, is defined with "attachTo"=
attribute (see the exapmle above). =
+ If "attachTo" attribute is not specified, the <ric=
h:componentControl> is supposed to be attached to =
it's parent.
+ =
+
+
+ =
+]]>
- Example:
+ It is possible to invoke the &=
lt;rich:componentControl> handler operation as usu=
al JavaScript function. =
+ For this purpose it is necessary to specify the name of the JS f=
unction with the help of the "name" attribute:
-
-
-
-...]]>
-
- On the result page the component is rendered to JavaScript code. =
- This means, that it is possible to invoke the <rich:componentControl> =
- handler operation as usual JavaScript function. =
- This function is called by name, specified in the component "name" attribute. =
- The definition of "name" attribute is shown on the example below:
-
-
-...]]>
-
- The generated JavaScript function will look as shown below:
-
-
+ Example:
+ =
+
+ ]]>
+ =
- An important <rich:componentC=
ontrol> feature, =
- is that it allows transferring parameters, with the help of specia=
l attribute "params".
+ An important <rich:compon=
entControl> feature, is that it allows transferrin=
g parameters, with the help of special attribute "=
params":
-
- Example:
-
+ =
+
...]]>
The alternative way for parameters transferring uses <f:param> attribute. =
- As the code above, the following code will represent the same functi=
onality.
+ As the code above, the following code will represent the same functi=
onality:
-
- Example:
-
+ =
@@ -264,17 +239,17 @@
- "immediate" - attached during execution of <rich:componentControl> =
script
+ immediate =E2=80=94 attached during execution o=
f <rich:componentControl> script
- "onavailable" - attached after the target component is=
initialized
+ onavailable =E2=80=94 attached after the target=
component is initialized
- "onload" - attached after the page is loaded
+ onload =E2=80=94 attached after the page is loa=
ded
@@ -298,46 +273,29 @@
=
- In order to use
- <rich:componentControl>
- with another component you should place the id of this com=
ponent into
- "for"
- attribute field. All operations with defined component you=
can find in the JavaScript API section of defined component.
- Example:
+ In order to use <rich:comp=
onentControl> with another component you should pl=
ace the id of this component into "for" attribute field. =
+ All operations with defined component you can find in the JavaSc=
ript API section of defined component.
-
-
-
-
-
-
-
-
-
-...]]>
+ =
+
+
+
+
+
+]]>This is a result:
- <emphasis role=3D"bold">
- <property><rich:toolTip></property>
- </emphasis> shows with the help of <emphasis role=3D"bold">
- <property><rich:componentControl></property>
- </emphasis>.
+
+ <emphasis role=3D"bold"><property><rich:toolTip></proper=
ty></emphasis> is shown with the help of <emphasis role=3D"bold"><property>=
<rich:componentControl></property></emphasis>.
+
- =
-
- As it could be seen in the picture above, the
- <rich:toolTip>
- shows after you click the button.
-
- =
+ =