Author: SeanRogers
Date: 2011-02-22 21:12:57 -0500 (Tue, 22 Feb 2011)
New Revision: 21885
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml
Log:
Updated panelMenu docs based on review FRPL-986
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-02-22
19:26:45 UTC (rev 21884)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml 2011-02-23
02:12:57 UTC (rev 21885)
@@ -601,12 +601,19 @@
</listitem>
<listitem>
<para>
- <literal>none</literal>, which causes the
<varname>action</varname> and <varname>actionListener</varname>
items to be ignored, and the behavior is fully defined by the nested components instead of
responses from submissions.
+ <literal>client</literal>, which causes the
<varname>action</varname> and <varname>actionListener</varname>
items to be ignored, and the behavior is fully defined by the nested components instead of
responses from submissions.
</para>
</listitem>
</itemizedlist>
</section>
+ <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.
+ </para>
+ </section>
+
<section id="sect-Component_Reference-richpanelMenu-Reference_data">
<title>Reference data</title>
<itemizedlist>
@@ -648,8 +655,11 @@
<section
id="sect-Component_Reference-richpanelMenuGroup-Basic_usage">
<title>Basic usage</title>
<para>
- The <sgmltag><rich:panelMenuGroup></sgmltag> component
needs the <varname>label</varname> attribute declared, which specifies the
text to show for the menu entry. Additionally, the
<sgmltag><rich:panelMenuGroup></sgmltag> component at least one
<sgmltag><rich:panelMenuGroup></sgmltag> or
<sgmltag><rich:panelMenuItem></sgmltag> components as child
elements.
+ The <sgmltag><rich:panelMenuGroup></sgmltag> component
needs the <varname>label</varname> attribute declared, which specifies the
text to show for the menu entry. Alternatively, the <literal>label</literal>
facet can be used to specify the menu text.
</para>
+ <para>
+ In addition, the <sgmltag><rich:panelMenuGroup></sgmltag>
component at least one <sgmltag><rich:panelMenuGroup></sgmltag>
or <sgmltag><rich:panelMenuItem></sgmltag> components as child
elements.
+ </para>
</section>
<section id="sect-Component_Reference-richpanelMenuGroup-Appearance">
@@ -714,6 +724,13 @@
If the <varname>mode</varname> attribute is unspecified, the submission
behavior for the group is inherited from the parent
<sgmltag><rich:panelMenu></sgmltag>. Otherwise, the
<varname>mode</varname> setting is used instead of the parent's behavior.
Refer to <xref
linkend="sect-Component_Reference-richpanelMenu-Submission_modes" /> for
submission mode settings.
</para>
</section>
+
+ <section
id="sect-Component_Reference-richpanelMenuGroup-richpanelMenuGroup_server-side_events">
+ <title><sgmltag><rich:panelMenuGroup></sgmltag>
server-side events</title>
+ <para>
+ The <sgmltag><rich:panelMenuGroup></sgmltag> component
fires the <literal>ActionEvent</literal> event on the server side when the
menu group receives a user action. The event only fires in the
<literal>server</literal> and <literal>ajax</literal> submission
modes. The event provides the <varname>action</varname> attribute to specify
the user action performed, and the <varname>actionListener</varname> attribute
to reference the event listener.
+ </para>
+ </section>
<section
id="sect-Component_Reference-richpanelMenuGroup-Reference_data">
<title>Reference data</title>
@@ -757,7 +774,7 @@
<section id="sect-Component_Reference-richpanelMenuItem-Basic_usage">
<title>Basic usage</title>
<para>
- The <sgmltag><rich:panelMenuItem></sgmltag> component
needs the <varname>label</varname> attribute declared, which specifies the
text to show for the menu entry.
+ The <sgmltag><rich:panelMenuItem></sgmltag> component
needs the <varname>label</varname> attribute declared, which specifies the
text to show for the menu entry. Alternatively, the <literal>label</literal>
facet can be used to specify the menu text.
</para>
</section>
@@ -819,6 +836,13 @@
If the <varname>mode</varname> is unspecified, the submission behavior
for the item is inherited from the parent
<sgmltag><rich:panelMenu></sgmltag>. Otherwise, the
<varname>mode</varname> setting is used instead of the parent's behavior.
</para>
</section>
+
+ <section
id="sect-Component_Reference-richpanelMenuItem-richpanelMenuItem_server-side_events">
+ <title><sgmltag><rich:panelMenuItem></sgmltag>
server-side events</title>
+ <para>
+ The <sgmltag><rich:panelMenuItem></sgmltag> component
fires the <literal>ActionEvent</literal> event on the server side when the
menu item receives a user action. The event only fires in the
<literal>server</literal> and <literal>ajax</literal> submission
modes. The event provides the <varname>action</varname> attribute to specify
the user action performed, and the <varname>actionListener</varname> attribute
to reference the event listener.
+ </para>
+ </section>
<section
id="sect-Component_Reference-richpanelMenuItem-Reference_data">
<title>Reference data</title>
Show replies by date