From richfaces-svn-commits at lists.jboss.org Tue Oct 19 23:30:02 2010
Content-Type: multipart/mixed; boundary="===============5539071605504450983=="
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: r19610 -
 modules/docs/branches/m4/Component_Reference/src/main/docbook/en-US.
Date: Tue, 19 Oct 2010 23:30:01 -0400
Message-ID: <201010200330.o9K3U1E8020160@svn01.web.mwc.hst.phx2.redhat.com>

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

Author: SeanRogers
Date: 2010-10-19 23:30:01 -0400 (Tue, 19 Oct 2010)
New Revision: 19610

Modified:
   modules/docs/branches/m4/Component_Reference/src/main/docbook/en-US/chap=
-Component_Reference-Rich_inputs.xml
Log:
Draft of richselectOne complete

Modified: modules/docs/branches/m4/Component_Reference/src/main/docbook/en-=
US/chap-Component_Reference-Rich_inputs.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/branches/m4/Component_Reference/src/main/docbook/en-US/cha=
p-Component_Reference-Rich_inputs.xml	2010-10-19 23:53:42 UTC (rev 19609)
+++ modules/docs/branches/m4/Component_Reference/src/main/docbook/en-US/cha=
p-Component_Reference-Rich_inputs.xml	2010-10-20 03:30:01 UTC (rev 19610)
@@ -787,14 +787,46 @@
 			The <sgmltag>&lt;rich:selectOne&gt;</sgmltag> component provides a drop=
-down list box for selecting a single value from multiple options. The comp=
onent supports keyboard navigation and can optionally accept typed input as=
 a combo-box.
 		</para>
 =

+		<figure id=3D"figu-Component_Reference-richselectOne-richselectOne">
+			<title><sgmltag>&lt;rich:selectOne&gt;</sgmltag></title>
+			<mediaobject>
+				<imageobject>
+					<imagedata fileref=3D"images/figu-Component_Reference-richselectOne-r=
ichselectOne.png" format=3D"PNG" />
+				</imageobject>
+				<textobject>
+					<para>
+						A <sgmltag>&lt;rich:selectOne&gt;</sgmltag> component used as a comb=
o-box.
+					</para>
+				</textobject>
+			</mediaobject>
+		</figure>
+
 		<section id=3D"sect-Component_Reference-richselectOne-Basic_usage">
 			<title>Basic usage</title>
 			<para>
 				Simple usage of the <sgmltag>&lt;rich:selectOne&gt;</sgmltag> componen=
t does not need any attributes declared, but child tags to manage the list =
of selections are required. An <sgmltag>&lt;f:selectItem&gt;</sgmltag> tag =
manages the currently selected value, while an <sgmltag>&lt;f:selectItems&g=
t;</sgmltag> tag points to the list of selection items.
 			</para>
+			<example id=3D"exam-Component_Reference-richselectOne-Selection_items">
+				<title>Selection items</title>
+				<programlisting language=3D"XML" role=3D"XML"><xi:include parse=3D"tex=
t" href=3D"extras/exam-Component_Reference-richselectOne-Selection_items.xm=
l_sample" xmlns:xi=3D"http://www.w3.org/2001/XInclude" /></programlisting>
+			</example>
+			<para>
+				The arrow keys on a keyboard can be used to highlight different items =
in the list, even if the list is closed with the control still focused. If =
the control loses focus or the <keycap function=3D"enter">Enter</keycap> ke=
y is pressed, the highlighted option is chosen as the value and the list is=
 closed. Pressing the <keycap function=3D"escape">Esc</keycap> key will clo=
se the list but not change the value.
+			</para>
 		</section>
 =

-		<!--FIXME: finish draft -->
+		<section id=3D"sect-Component_Reference-richselectOne-Using_richselectOn=
e_as_a_combo-box">
+			<title>Using <sgmltag>&lt;rich:selectOne&gt;</sgmltag> as a combo-box</=
title>
+			<para>
+				Combo-boxes are drop-down lists that allow the user to type into a tex=
t field to scroll through or filter the list. By default, the <sgmltag>&lt;=
rich:selectOne&gt;</sgmltag> component functions as a drop-down list. To ad=
d keyboard support to make it function like a combo-box, set <code>enableMa=
nualInput=3D"true"</code>.
+			</para>
+			<para>
+				Once the user begins typing, the first available matching option is hi=
ghlighted. If the typed text does not match any values in the list, no valu=
e is chosen and the drop-down list displays as empty. Other keyboard intera=
ction remains the same as the basic drop-down list.
+			</para>
+			<para>
+				Typing text into a combo-box causes the list to scroll to the relevant=
 item by default. This behavior can be changed so that the typed text filte=
rs the contents of the list instead, showing only those items that begin wi=
th the typed text. To use typed text as a filter for combo-box lists, set <=
code>filterOnUpdates=3D"true"</code>.
+			</para>
+		</section>
 		=

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


--===============5539071605504450983==--