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-Component_Reference-Actions.xml
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels.xml
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Trees.xml
Log:
Added placeholder descriptions for missing listener tags: RFPL-1419
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml 2011-04-08
08:21:54 UTC (rev 22399)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_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 the generated
documentation mentioned in <xref
linkend="chap-Component_Reference-Introduction" /> for reference details.
</para>
</note>
+ <para>
+ Use the <sgmltag><a4j:actionListener></sgmltag> tag to
register an <classname>ActionListener</classname> class on a parent action
component. The class provided as a listener must implement the
<interfacename>javax.faces.event.ActionListener</interfacename> interface.
Multiple listener methods can be registered on an action component in this way.
+ </para>
+ <para>
+ The <sgmltag><a4j:actionListener></sgmltag> tag differs from
the standard JSF tag by allowing a listener method to be defined instead of just a class.
Use the <varname>listener</varname> attribute to define the listener method.
+ </para>
</section>
<section id="sect-Component_Reference-Actions-a4jcommandButton">
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_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-Component_Reference-Menus_and_toolbars.xml 2011-04-11
01:15:32 UTC (rev 22400)
@@ -642,7 +642,7 @@
<section
id="sect-Component_Reference-richpanelMenu-richpanelMenu_server-side_events">
<title><sgmltag><rich:panelMenu></sgmltag> server-side
events</title>
<para>
- The <sgmltag><rich:panelMenu></sgmltag> component fires the
<literal>ItemChangeEvent</literal> event on the server side when the menu is
changed. The event only fires in the <literal>server</literal> and
<literal>ajax</literal> submission modes. The event provides the
<varname>itemChangeListener</varname> attribute to reference the event
listener.
+ The <sgmltag><rich:panelMenu></sgmltag> component fires the
<literal>ItemChangeEvent</literal> event on the server side when the menu is
changed. The event only fires in the <literal>server</literal> and
<literal>ajax</literal> submission modes. The event provides the
<varname>itemChangeListener</varname> attribute to reference the event
listener. Refer to <xref
linkend="sect-Component_Reference-Panels-richitemChangeListener" /> for
details on the <sgmltag><rich:itemChangeListener></sgmltag>
tag.
</para>
</section>
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels.xml
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels.xml 2011-04-08
08:21:54 UTC (rev 22399)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_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 side
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 side
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="sect-Component_Reference-Panels-richitemChangeListener" /> for
details on the <sgmltag><rich:itemChangeListener></sgmltag>
tag.
</para>
</listitem>
</itemizedlist>
@@ -519,6 +519,19 @@
<title>Style classes and skin parameters</title>
<xi:include href="skinning/tabl-richcollapsiblePanel.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
+
+ <section id="sect-Component_Reference-Panels-richpanelToggleListener">
+ <title><sgmltag><rich:panelToggleListener></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="chap-Component_Reference-Introduction" /> for reference details.
+ </para>
+ </note>
+ <para>
+ Use the <sgmltag><rich:panelToggleListener></sgmltag> tag
to register a <classname>PanelToggleListener</classname> class on a parent
<sgmltag><rich:collapsiblePanel></sgmltag> component. The class
provided as a listener must implement the
<interfacename>org.richfaces.event.PanelToggleListener</interfacename>
interface. The <methodname>processPanelToggle</methodname> 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 side
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 side
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="sect-Component_Reference-Panels-richitemChangeListener" /> for
details on the <sgmltag><rich:itemChangeListener></sgmltag>
tag.
</para>
</listitem>
</itemizedlist>
@@ -1253,6 +1266,45 @@
</listitem>
</itemizedlist>
</section>
+
+ <!-- <rich:itemChangeListener> -->
+ <section id="sect-Component_Reference-Panels-richitemChangeListener">
+ <title><sgmltag><rich:itemChangeListener></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="chap-Component_Reference-Introduction" /> for reference details.
+ </para>
+ </note>
+ <para>
+ Use the <sgmltag><rich:itemChangeListener></sgmltag> tag to
register an <classname>ItemChangeListener</classname> class on a parent panel
component. The class provided as a listener must implement the
<interfacename>org.richfaces.event.ItemChangeListener</interfacename>
interface. The <methodname>processItemChange</methodname> method accepts an
<classname>org.richface.event.ItemChangeEvent</classname> event as a
parameter.
+ </para>
+ <para>
+ The <sgmltag><rich:itemChangeListener></sgmltag> tag can be
used with any of the switchable panel components:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <sgmltag><rich:togglePanel></sgmltag> (refer to <xref
linkend="sect-Component_Reference-Panels-richtogglePanel" />)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <sgmltag><rich:accordion></sgmltag> (refer to <xref
linkend="sect-Component_Reference-Panels-richaccordion" />)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <sgmltag><rich:tabPanel></sgmltag> (refer to <xref
linkend="sect-Component_Reference-Panels-richtabPanel" />)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <sgmltag><rich:panelMenu></sgmltag> (refer to <xref
linkend="sect-Component_Reference-Menus_and_toolbars-richpanelMenu" />)
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
<!--<rich:toggleControl>-->
<section id="sect-Component_Reference-Panels-richtoggleControl">
@@ -1377,26 +1429,6 @@
</section>
</section>
-
- <section id="sect-Component_Reference-Actions-richitemChangeListener">
- <title><sgmltag><rich:itemChangeListener></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="chap-Component_Reference-Introduction" /> for reference details.
- </para>
- </note>
- </section>
-
- <section id="sect-Component_Reference-Actions-richpanelToggleListener">
- <title><sgmltag><rich:panelToggleListener></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="chap-Component_Reference-Introduction" /> for reference details.
- </para>
- </note>
- </section>
</chapter>
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Trees.xml
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Trees.xml 2011-04-08
08:21:54 UTC (rev 22399)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Trees.xml 2011-04-11
01:15:32 UTC (rev 22400)
@@ -354,7 +354,20 @@
<xi:include href="skinning/vlst-richtree.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
- <!-- <rich:tree> -->
+ <section
id="sect-Component_Reference-Actions-richtreeSelectionChangeListener">
+ <title><sgmltag><rich:treeSelectionChangeListener></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="chap-Component_Reference-Introduction" /> for reference details.
+ </para>
+ </note>
+ <para>
+ Use the
<sgmltag><rich:treeSelectionChangeListener></sgmltag> tag to
register a <classname>TreeSelectionChangeListener</classname> class on a
parent <sgmltag><rich:tree></sgmltag> component. The class
provided as a listener must implement the
<interfacename>org.richfaces.event.TreeSelectionChangeListener</interfacename>
interface. The <methodname>processTreeSelectionChange</methodname> method
accepts an <classname>org.richface.event.TreeSelectionChangeEvent</classname>
event as a parameter.
+ </para>
+ </section>
+
+ <!-- <rich:treeNode> -->
<section id="sect-Component_Reference-Trees-richtreeNode">
<title><sgmltag><rich:treeNode></sgmltag></title>
<para>
@@ -445,6 +458,19 @@
<title>Style classes and skin parameters</title>
<xi:include href="skinning/tabl-richtreeNode.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
+
+ <section
id="sect-Component_Reference-Actions-richtreeToggleListener">
+ <title><sgmltag><rich:treeToggleListener></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="chap-Component_Reference-Introduction" /> for reference details.
+ </para>
+ </note>
+ <para>
+ Use the <sgmltag><rich:treeToggleListener></sgmltag> tag
to register a <classname>TreeToggleListener</classname> class on a parent
<sgmltag><rich:treeNode></sgmltag> component. The class provided
as a listener 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="sect-Component_Reference-Actions-richtreeSelectionChangeListener">
- <title><sgmltag><rich:treeSelectionChangeListener></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="chap-Component_Reference-Introduction" /> for reference details.
- </para>
- </note>
- </section>
-
- <section id="sect-Component_Reference-Actions-richtreeToggleListener">
- <title><sgmltag><rich:treeToggleListener></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="chap-Component_Reference-Introduction" /> for reference details.
- </para>
- </note>
- </section>
</chapter>