From richfaces-svn-commits at lists.jboss.org Thu Jan 13 21:24:52 2011
Content-Type: multipart/mixed; boundary="===============0043492971593716680=="
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: r21014 -
 modules/docs/trunk/Component_Reference/src/main/docbook/en-US.
Date: Thu, 13 Jan 2011 21:24:52 -0500
Message-ID: <201101140224.p0E2Oqve004721@svn01.web.mwc.hst.phx2.redhat.com>

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

Author: SeanRogers
Date: 2011-01-13 21:24:51 -0500 (Thu, 13 Jan 2011)
New Revision: 21014

Modified:
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo=
nent_Reference-Menus_and_toolbars.xml
Log:
Revised dropdownmenu based on review RFPL-973

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-01-14 01:03:54 UTC (rev 21013)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Menus_and_toolbars.xml	2011-01-14 02:24:51 UTC (rev 21014)
@@ -48,10 +48,10 @@
 		<section id=3D"sect-Component_Reference-richdropDownMenu-Basic_usage">
 			<title>Basic usage</title>
 			<para>
-				The <sgmltag>&lt;rich:dropDownMenu&gt;</sgmltag> component only requir=
es the <varname>value</varname> attribute for basic usage. Use the <varname=
>value</varname> attribute to define the text label that appears as the tit=
le of the menu. Clicking on the title drops the menu down.
+				The <sgmltag>&lt;rich:dropDownMenu&gt;</sgmltag> component only requir=
es the <varname>label</varname> attribute for basic usage. Use the <varname=
>label</varname> attribute to define the text label that appears as the tit=
le of the menu. Clicking on the title drops the menu down.
 			</para>
 			<para>
-				Alternatively, use the <literal>label</literal> facet to define the me=
nu title. If the <literal>label</literal> facet is used, the <varname>value=
</varname> attribute is not necessary.
+				Alternatively, use the <literal>label</literal> facet to define the me=
nu title. If the <literal>label</literal> facet is used, the <varname>label=
</varname> attribute is not necessary.
 			</para>
 		</section>
 =

@@ -62,23 +62,86 @@
 			</para>
 		</section>
 =

-		<!-- TODO not in M5 -->
-		<!--
 		<section id=3D"sect-Component_Reference-richdropDownMenu-Appearance">
 			<title>Appearance</title>
 			<para>
-				To determine the direction and location of the menu when it appears, u=
se the <varname>direction</varname> and <varname>jointPoint</varname> attri=
butes.
+				Use the <varname>jointPoint</varname> and <varname>direction</varname>=
 attributes to determine the direction and location of the menu when it app=
ears. The <varname>jointPoint</varname> and <varname>direction</varname> at=
tributes both use the following settings:
 			</para>
-			=

+			<variablelist>
+				<varlistentry>
+					<term><literal>topLeft</literal></term>
+					<term><literal>topRight</literal></term>
+					<term><literal>bottomLeft</literal></term>
+					<term><literal>bottomRight</literal></term>
+					<listitem>
+						<para>
+							When used with the <varname>jointPoint</varname> attribute, the men=
u is attached to the top-left, top-right, bottom-left, or bottom-right of t=
he control as appropriate.
+						</para>
+						<para>
+							When used with the <varname>direction</varname> attribute, the menu=
 appears to the top-left, top-right, bottom-left, or bottom-right of the jo=
int location as appropriate.
+						</para>
+					</listitem>
+				</varlistentry>
+				<varlistentry>
+					<term><literal>auto</literal></term>
+					<listitem>
+						<para>
+							The direction or joint location is determined automatically.
+						</para>
+					</listitem>
+				</varlistentry>
+				<varlistentry>
+					<term><literal>autoLeft</literal></term>
+					<term><literal>autoRight</literal></term>
+					<term><literal>autoTop</literal></term>
+					<term><literal>autoBottom</literal></term>
+					<listitem>
+						<para>
+							When used with the <varname>jointPoint</varname> attribute, the joi=
nt location is determined automatically, but defaults to either the left, r=
ight, top, or bottom of the control as appropriate.
+						</para>
+						<para>
+							When used with the <varname>direction</varname> attribute, the menu=
 direction is determined automatically, but defaults to either the left, ri=
ght, top, or bottom of the joint location as appropriate.
+						</para>
+					</listitem>
+				</varlistentry>
+			</variablelist>
 		</section>
-		-->
 		=

 		<section id=3D"sect-Component_Reference-richdropDownMenu-Expanding_and_c=
ollapsing_the_menu">
 			<title>Expanding and collapsing the menu</title>
 			<para>
-				By default, the menu drops down when the title is clicked. To drop dow=
n with a different event, use the <varname>event</varname> attribute to def=
ine the event instead.
+				By default, the menu drops down when the title is clicked. To drop dow=
n with a different event, use the <varname>eventShow</varname> attribute to=
 define the event instead.
 			</para>
 			<para>
+				Menus can be navigated using the keyboard. Additionally, menus can be =
navigated programmatically using the JavaScript <acronym>API</acronym>. The=
 JavaScript API allows the following methods:
+			</para>
+			<variablelist>
+				<varlistentry>
+					<term><methodname>show()</methodname></term>
+					<listitem>
+						<para>
+							The <methodname>show()</methodname> method shows the menu.
+						</para>
+					</listitem>
+				</varlistentry>
+				<varlistentry>
+					<term><methodname>hide()</methodname></term>
+					<listitem>
+						<para>
+							The <methodname>hide()</methodname> method hides the menu.
+						</para>
+					</listitem>
+				</varlistentry>
+				<varlistentry>
+					<term><methodname>activateItem(menuItemId)</methodname></term>
+					<listitem>
+						<para>
+							The <methodname>activateItem(menuItemId)</methodname> activates the=
 menu item with the <parameter>menuItemId</parameter> identifier.
+						</para>
+					</listitem>
+				</varlistentry>
+			</variablelistentry>
+			<para>
 				Use the <varname>mode</varname> attribute to determine how the menu re=
quests are submitted:
 			</para>
 			<itemizedlist>
@@ -94,7 +157,7 @@
 				</listitem>
 				<listitem>
 					<para>
-						<literal>client</literal> causes the <varname>action</varname> and <=
varname>actionListener</varname> items to be ignored, and the behavior is f=
ully defined by the nested components instead of responses from submissions.
+						<literal>client</literal> causes the <varname>action</varname> and <=
varname>actionListener</varname> items to be ignored, and the behavior is f=
ully defined by the nested components or custom JavaScript instead of respo=
nses from submissions.
 					</para>
 				</listitem>
 			</itemizedlist>
@@ -142,13 +205,13 @@
 		<section id=3D"sect-Component_Reference-Menus_and_toolbars-richmenuItem">
 			<title><sgmltag>&lt;rich:menuItem&gt;</sgmltag></title>
 			<para>
-				The <sgmltag>&lt;rich:menuItem&gt;</sgmltag> component represents a si=
ngle item in a menu control.
+				The <sgmltag>&lt;rich:menuItem&gt;</sgmltag> component represents a si=
ngle item in a menu control. The <sgmltag>&lt;rich:menuItem&gt;</sgmltag> c=
omponent can be also be used as a seperate component without a parent menu =
component, such as on a toolbar.
 			</para>
 =

 			<section id=3D"sect-Component_Reference-richmenuItem-Basic_usage">
 				<title>Basic usage</title>
 				<para>
-					The <sgmltag>&lt;rich:menuItem&gt;</sgmltag> component requires the <=
varname>value</varname> attribute for basic usage. The <varname>value</varn=
ame> attribute is the text label for the menu item.
+					The <sgmltag>&lt;rich:menuItem&gt;</sgmltag> component requires the <=
varname>label</varname> attribute for basic usage. The <varname>label</varn=
ame> attribute is the text label for the menu item.
 				</para>
 			</section>
 =

@@ -247,8 +310,12 @@
 				<para>
 					Alternatively, define facets with the names <literal>icon</literal> a=
nd <literal>iconDisabled</literal> to set the icons. If facets are defined,=
 the <varname>icon</varname> and <varname>iconDisabled</varname> attributes=
 are ignored.
 				</para>
+				<para>
+					The <sgmltag>&lt;rich:menuGroup&gt;</sgmltag> component can be positi=
oned using the <varname>jointPoint</varname> and <varname>direction</varnam=
e> attributes, the same as the parent menu control. For details on the <var=
name>jointPoint</varname> and <varname>direction</varname> attributes, refe=
r to <xref linkend=3D"sect-Component_Reference-richdropDownMenu-Appearance"=
/>.
+				</para>
 			</section>
 			=

+			<!--
 			<section id=3D"sect-Component_Reference-richmenuGroup-Submission_modes">
 				<title>Submission modes</title>
 				<para>
@@ -272,6 +339,7 @@
 					</listitem>
 				</itemizedlist>
 			</section>
+			-->
 =

 			<section id=3D"sect-Component_Reference-richmenuGroup-Reference_data">
 				<title>Reference data</title>


--===============0043492971593716680==--