From richfaces-svn-commits at lists.jboss.org Sun Apr 10 21:15:33 2011
Content-Type: multipart/mixed; boundary="===============6578149639381723616=="
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: r22400 -
 modules/docs/trunk/Component_Reference/src/main/docbook/en-US.
Date: Sun, 10 Apr 2011 21:15:33 -0400
Message-ID: <201104110115.p3B1FXGj008277@svn01.web.mwc.hst.phx2.redhat.com>

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

Author: SeanRogers
Date: 2011-04-10 21:15:32 -0400 (Sun, 10 Apr 2011)
New Revision: 22400

Modified:
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo=
nent_Reference-Actions.xml
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo=
nent_Reference-Menus_and_toolbars.xml
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo=
nent_Reference-Panels.xml
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo=
nent_Reference-Trees.xml
Log:
Added placeholder descriptions for missing listener tags: RFPL-1419

Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha=
p-Component_Reference-Actions.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
--- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Actions.xml	2011-04-08 08:21:54 UTC (rev 22399)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Actions.xml	2011-04-11 01:15:32 UTC (rev 22400)
@@ -209,6 +209,12 @@
 				The documentation for this tag is still under development. Refer to th=
e generated documentation mentioned in <xref linkend=3D"chap-Component_Refe=
rence-Introduction" /> for reference details.
 			</para>
 		</note>
+		<para>
+			Use the <sgmltag>&lt;a4j:actionListener&gt;</sgmltag> tag to register a=
n <classname>ActionListener</classname> class on a parent action component.=
 The class provided as a listener must implement the <interfacename>javax.f=
aces.event.ActionListener</interfacename> interface. Multiple listener meth=
ods can be registered on an action component in this way.
+		</para>
+		<para>
+			The <sgmltag>&lt;a4j:actionListener&gt;</sgmltag> tag differs from the =
standard JSF tag by allowing a listener method to be defined instead of jus=
t a class. Use the <varname>listener</varname> attribute to define the list=
ener method.
+		</para>
 	</section>
 	=

 	<section id=3D"sect-Component_Reference-Actions-a4jcommandButton">

Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha=
p-Component_Reference-Menus_and_toolbars.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
--- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Menus_and_toolbars.xml	2011-04-08 08:21:54 UTC (rev 22399)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Menus_and_toolbars.xml	2011-04-11 01:15:32 UTC (rev 22400)
@@ -642,7 +642,7 @@
 		<section id=3D"sect-Component_Reference-richpanelMenu-richpanelMenu_serv=
er-side_events">
 			<title><sgmltag>&lt;rich:panelMenu&gt;</sgmltag> server-side events</ti=
tle>
 			<para>
-				The <sgmltag>&lt;rich:panelMenu&gt;</sgmltag> component fires the <lit=
eral>ItemChangeEvent</literal> event on the server side when the menu is ch=
anged. The event only fires in the <literal>server</literal> and <literal>a=
jax</literal> submission modes. The event provides the <varname>itemChangeL=
istener</varname> attribute to reference the event listener.
+				The <sgmltag>&lt;rich:panelMenu&gt;</sgmltag> component fires the <lit=
eral>ItemChangeEvent</literal> event on the server side when the menu is ch=
anged. The event only fires in the <literal>server</literal> and <literal>a=
jax</literal> submission modes. The event provides the <varname>itemChangeL=
istener</varname> attribute to reference the event listener. Refer to <xref=
 linkend=3D"sect-Component_Reference-Panels-richitemChangeListener" /> for =
details on the <sgmltag>&lt;rich:itemChangeListener&gt;</sgmltag> tag.
 			</para>
 		</section>
 		=


Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha=
p-Component_Reference-Panels.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
--- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Panels.xml	2011-04-08 08:21:54 UTC (rev 22399)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Panels.xml	2011-04-11 01:15:32 UTC (rev 22400)
@@ -200,7 +200,7 @@
 			<itemizedlist>
 				<listitem>
 					<para>
-						The <varname>ItemChangeEvent</varname> event occurs on the server si=
de when an item is changed through Ajax using the <literal>server</literal>=
 mode. It can be processed using the <varname>ItemChangeListener</varname> =
attribute.
+						The <varname>ItemChangeEvent</varname> event occurs on the server si=
de when an item is changed through Ajax using the <literal>server</literal>=
 mode. It can be processed using the <varname>ItemChangeListener</varname> =
attribute. Refer to <xref linkend=3D"sect-Component_Reference-Panels-richit=
emChangeListener" /> for details on the <sgmltag>&lt;rich:itemChangeListene=
r&gt;</sgmltag> tag.
 					</para>
 				</listitem>
 			</itemizedlist>
@@ -519,6 +519,19 @@
 			<title>Style classes and skin parameters</title>
 			<xi:include href=3D"skinning/tabl-richcollapsiblePanel.xml" xmlns:xi=3D=
"http://www.w3.org/2001/XInclude" />
 		</section>
+
+		<section id=3D"sect-Component_Reference-Panels-richpanelToggleListener">
+			<title><sgmltag>&lt;rich:panelToggleListener&gt;</sgmltag></title>
+			<note>
+				<title>Documentation in development</title>
+				<para>
+					The documentation for this tag is still under development. Refer to t=
he generated documentation mentioned in <xref linkend=3D"chap-Component_Ref=
erence-Introduction" /> for reference details.
+				</para>
+			</note>
+			<para>
+				Use the <sgmltag>&lt;rich:panelToggleListener&gt;</sgmltag> tag to reg=
ister a <classname>PanelToggleListener</classname> class on a parent <sgmlt=
ag>&lt;rich:collapsiblePanel&gt;</sgmltag> component. The class provided as=
 a listener must implement the <interfacename>org.richfaces.event.PanelTogg=
leListener</interfacename> interface. The <methodname>processPanelToggle</m=
ethodname> method accepts an <classname>org.richface.event.PanelToggleEvent=
</classname> event as a parameter.
+			</para>
+		</section>
 		=

 	</section>
 	=

@@ -911,7 +924,7 @@
 			<itemizedlist>
 				<listitem>
 					<para>
-						The <varname>ItemChangeEvent</varname> event occurs on the server si=
de when an item is changed through Ajax using the <literal>server</literal>=
 mode. It can be processed using the <varname>ItemChangeListener</varname> =
attribute.
+						The <varname>ItemChangeEvent</varname> event occurs on the server si=
de when an item is changed through Ajax using the <literal>server</literal>=
 mode. It can be processed using the <varname>ItemChangeListener</varname> =
attribute. Refer to <xref linkend=3D"sect-Component_Reference-Panels-richit=
emChangeListener" /> for details on the <sgmltag>&lt;rich:itemChangeListene=
r&gt;</sgmltag> tag.
 					</para>
 				</listitem>
 			</itemizedlist>
@@ -1253,6 +1266,45 @@
 				</listitem>
 			</itemizedlist>
 		</section>
+
+		<!-- <rich:itemChangeListener> -->
+		<section id=3D"sect-Component_Reference-Panels-richitemChangeListener">
+			<title><sgmltag>&lt;rich:itemChangeListener&gt;</sgmltag></title>
+			<note>
+				<title>Documentation in development</title>
+				<para>
+					The documentation for this tag is still under development. Refer to t=
he generated documentation mentioned in <xref linkend=3D"chap-Component_Ref=
erence-Introduction" /> for reference details.
+				</para>
+			</note>
+			<para>
+				Use the <sgmltag>&lt;rich:itemChangeListener&gt;</sgmltag> tag to regi=
ster an <classname>ItemChangeListener</classname> class on a parent panel c=
omponent. The class provided as a listener must implement the <interfacenam=
e>org.richfaces.event.ItemChangeListener</interfacename> interface. The <me=
thodname>processItemChange</methodname> method accepts an <classname>org.ri=
chface.event.ItemChangeEvent</classname> event as a parameter.
+			</para>
+			<para>
+				The <sgmltag>&lt;rich:itemChangeListener&gt;</sgmltag> tag can be used=
 with any of the switchable panel components:
+			</para>
+			<itemizedlist>
+				<listitem>
+					<para>
+						<sgmltag>&lt;rich:togglePanel&gt;</sgmltag> (refer to <xref linkend=
=3D"sect-Component_Reference-Panels-richtogglePanel" />)
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<sgmltag>&lt;rich:accordion&gt;</sgmltag> (refer to <xref linkend=3D=
"sect-Component_Reference-Panels-richaccordion" />)
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<sgmltag>&lt;rich:tabPanel&gt;</sgmltag> (refer to <xref linkend=3D"=
sect-Component_Reference-Panels-richtabPanel" />)
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<sgmltag>&lt;rich:panelMenu&gt;</sgmltag> (refer to <xref linkend=3D=
"sect-Component_Reference-Menus_and_toolbars-richpanelMenu" />)
+					</para>
+				</listitem>
+			</itemizedlist>
+		</section>
 		=

 		<!--<rich:toggleControl>-->
 		<section id=3D"sect-Component_Reference-Panels-richtoggleControl">
@@ -1377,26 +1429,6 @@
 		</section>
 	=

 	</section>
-
-	<section id=3D"sect-Component_Reference-Actions-richitemChangeListener">
-		<title><sgmltag>&lt;rich:itemChangeListener&gt;</sgmltag></title>
-		<note>
-			<title>Documentation in development</title>
-			<para>
-				The documentation for this tag is still under development. Refer to th=
e generated documentation mentioned in <xref linkend=3D"chap-Component_Refe=
rence-Introduction" /> for reference details.
-			</para>
-		</note>
-	</section>
-
-	<section id=3D"sect-Component_Reference-Actions-richpanelToggleListener">
-		<title><sgmltag>&lt;rich:panelToggleListener&gt;</sgmltag></title>
-		<note>
-			<title>Documentation in development</title>
-			<para>
-				The documentation for this tag is still under development. Refer to th=
e generated documentation mentioned in <xref linkend=3D"chap-Component_Refe=
rence-Introduction" /> for reference details.
-			</para>
-		</note>
-	</section>
 	=

 </chapter>
 =


Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha=
p-Component_Reference-Trees.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
--- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Trees.xml	2011-04-08 08:21:54 UTC (rev 22399)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Trees.xml	2011-04-11 01:15:32 UTC (rev 22400)
@@ -354,7 +354,20 @@
 			<xi:include href=3D"skinning/vlst-richtree.xml" xmlns:xi=3D"http://www.=
w3.org/2001/XInclude" />
 		</section>
 =

-		<!-- <rich:tree> -->
+		<section id=3D"sect-Component_Reference-Actions-richtreeSelectionChangeL=
istener">
+			<title><sgmltag>&lt;rich:treeSelectionChangeListener&gt;</sgmltag></tit=
le>
+			<note>
+				<title>Documentation in development</title>
+				<para>
+					The documentation for this tag is still under development. Refer to t=
he generated documentation mentioned in <xref linkend=3D"chap-Component_Ref=
erence-Introduction" /> for reference details.
+				</para>
+			</note>
+			<para>
+				Use the <sgmltag>&lt;rich:treeSelectionChangeListener&gt;</sgmltag> ta=
g to register a <classname>TreeSelectionChangeListener</classname> class on=
 a parent <sgmltag>&lt;rich:tree&gt;</sgmltag> component. The class provide=
d as a listener must implement the <interfacename>org.richfaces.event.TreeS=
electionChangeListener</interfacename> interface. The <methodname>processTr=
eeSelectionChange</methodname> method accepts an <classname>org.richface.ev=
ent.TreeSelectionChangeEvent</classname> event as a parameter.
+			</para>
+		</section>
+
+		<!-- <rich:treeNode> -->
 		<section id=3D"sect-Component_Reference-Trees-richtreeNode">
 			<title><sgmltag>&lt;rich:treeNode&gt;</sgmltag></title>
 			<para>
@@ -445,6 +458,19 @@
 				<title>Style classes and skin parameters</title>
 				<xi:include href=3D"skinning/tabl-richtreeNode.xml" xmlns:xi=3D"http:/=
/www.w3.org/2001/XInclude" />
 			</section>
+
+			<section id=3D"sect-Component_Reference-Actions-richtreeToggleListener">
+				<title><sgmltag>&lt;rich:treeToggleListener&gt;</sgmltag></title>
+				<note>
+					<title>Documentation in development</title>
+					<para>
+						The documentation for this tag is still under development. Refer to =
the generated documentation mentioned in <xref linkend=3D"chap-Component_Re=
ference-Introduction" /> for reference details.
+					</para>
+				</note>
+				<para>
+					Use the <sgmltag>&lt;rich:treeToggleListener&gt;</sgmltag> tag to reg=
ister a <classname>TreeToggleListener</classname> class on a parent <sgmlta=
g>&lt;rich:treeNode&gt;</sgmltag> component. The class provided as a listen=
er must implement the <interfacename>org.richfaces.event.TreeToggleListener=
</interfacename> interface. The <methodname>processTreeToggle</methodname> =
method accepts an <classname>org.richface.event.TreeToggleEvent</classname>=
 event as a parameter.
+				</para>
+			</section>
 		</section>
 	</section>
 =

@@ -615,26 +641,6 @@
 		</section>
 		=

 	</section>
-
-	<section id=3D"sect-Component_Reference-Actions-richtreeSelectionChangeLi=
stener">
-		<title><sgmltag>&lt;rich:treeSelectionChangeListener&gt;</sgmltag></titl=
e>
-		<note>
-			<title>Documentation in development</title>
-			<para>
-				The documentation for this tag is still under development. Refer to th=
e generated documentation mentioned in <xref linkend=3D"chap-Component_Refe=
rence-Introduction" /> for reference details.
-			</para>
-		</note>
-	</section>
-
-	<section id=3D"sect-Component_Reference-Actions-richtreeToggleListener">
-		<title><sgmltag>&lt;rich:treeToggleListener&gt;</sgmltag></title>
-		<note>
-			<title>Documentation in development</title>
-			<para>
-				The documentation for this tag is still under development. Refer to th=
e generated documentation mentioned in <xref linkend=3D"chap-Component_Refe=
rence-Introduction" /> for reference details.
-			</para>
-		</note>
-	</section>
 	=

 </chapter>
 =



--===============6578149639381723616==--