From richfaces-svn-commits at lists.jboss.org Thu Nov 18 02:25:03 2010 Content-Type: multipart/mixed; boundary="===============0049606652635504302==" 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: r20082 - in modules/docs/trunk/Component_Reference/src/main/docbook/en-US: extras and 1 other directory. Date: Thu, 18 Nov 2010 02:25:02 -0500 Message-ID: <201011180725.oAI7P21a001864@svn01.web.mwc.hst.phx2.redhat.com> --===============0049606652635504302== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: SeanRogers Date: 2010-11-18 02:24:59 -0500 (Thu, 18 Nov 2010) New Revision: 20082 Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exa= m-Component_Reference-richselect-Selection_items-0.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exa= m-Component_Reference-richselect-Selection_items-1.xml_sample Removed: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exa= m-Component_Reference-richselect-Selection_items.xml_sample Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo= nent_Reference-Rich_inputs.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo= nent_Reference-Tables_and_grids.xml Log: Re-draft of rich:select based on tech review Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha= p-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/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Rich_inputs.xml 2010-11-18 02:05:03 UTC (rev 20081) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Rich_inputs.xml 2010-11-18 07:24:59 UTC (rev 20082) @@ -822,7 +822,7 @@
<sgmltag><rich:select></sgmltag> - The <rich:select> component provides a drop-do= wn list box for selecting a single value from multiple options. The compone= nt supports keyboard navigation and can optionally accept typed input as a = combo-box. + The <rich:select> component provides a drop-do= wn list box for selecting a single value from multiple options. The compone= nt supports keyboard navigation and can optionally accept typed input. The = <rich:select> component functions similarly to the= JavaServer Faces <h:selectOneMenu> component. =
@@ -833,7 +833,7 @@ - A <rich:select> component used as a combo-b= ox. + A <rich:select> component. @@ -842,28 +842,54 @@
Basic usage - Simple usage of the <rich:select> component d= oes not need any attributes declared, but child tags to manage the list of = selections are required. An <f:selectItem> tag man= ages the currently selected value, while an <f:selectItems><= /sgmltag> tag points to the list of selection items. + Simple usage of the <rich:select> component d= oes not need any attributes declared, but child tags to manage the list of = selections are required. The child tags can either be a number of = <f:selectItem> tags or a <f:selectItems> tag which points to a data model containing a list of selection item= s. The value attribute is used to store the current sele= ction. Selection items - + + + Using multiple <f:selectItem> tag= s + + + + + + Using a single <f:selectItems> ta= g + + + + + - 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 Enter ke= y is pressed, the highlighted option is chosen as the value and the list is= closed. Pressing the Esc key will clo= se the list but not change the value. + The arrow keys on a keyboard can be used to highlight different items = in the list. If the control loses focus or the E= nter key is pressed, the highlighted option is chosen as the value= and the list is closed. Pressing the Esc key will close the list but not change the value.
= -
- Using <sgmltag><rich:select></sgmltag> as a combo-box</tit= le> + <section id=3D"sect-Component_Reference-richselect-Advanced_options"> + <title>Advanced options - 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 <= rich:select> component functions as a drop-down list. To add k= eyboard support to make it function like a combo-box, set enableManua= lInput=3D"true". + Use the defaultLabel attribute to set a place-holde= r label, such as defaultLabel=3D"select an option". + Server-side processing occurs in the same manner as for an = <h:selectOneMenu> component. As such, custom objects used f= or selection items should use the same converters as for an <h:= selectOneMenu> component. + +
+ +
+ Using manual input + + Selection lists can allow the user to type into a text field to scroll= through or filter the list. By default, the <rich:select> component functions as a drop-down list with no manual input. To a= dd keyboard support for manual input, set enableManualInput=3D"true"<= /code>. + + 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. + +
=
Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha= p-Component_Reference-Tables_and_grids.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-Tables_and_grids.xml 2010-11-18 02:05:03 UTC (rev 20081) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Tables_and_grids.xml 2010-11-18 07:24:59 UTC (rev 20082) @@ -1265,18 +1265,18 @@ Tables entries can be sorted by the user through either the basic metho= d built in to the <rich:column> component, or by d= efining external sorting algorithms. Refer to for details on using the <rich:column> component in tables. + + Sorting non-English tables + + To sort a table whose contents are not in English, add the org.richfaces.datatableUsesViewLocale context parameter to the = project's web.xml settings file. Set the value of the = context parameter to true. + + =
Basic sorting The built-in sorting functionality of the <rich:column>= component allows a user to click the header of a column to sort = it in ascending or descending order. - - Sorting non-English tables - - To sort a table whose contents are not in English, add the org.richfaces.datatableUsesViewLocale context parameter to the= project's web.xml settings file. Set the value of the= context parameter to true. - - Set the sortBy attribute to indicate which value to= use when sorting the column. Expressions in the sortBy = attribute must refer to the variable declared in the table's var attribute, which is used to fill the contents of the table. Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extra= s/exam-Component_Reference-richselect-Selection_items-0.xml_sample (from re= v 20081, modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extr= as/exam-Component_Reference-richselect-Selection_items.xml_sample) =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=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/extras/ex= am-Component_Reference-richselect-Selection_items-0.xml_sample = (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex= am-Component_Reference-richselect-Selection_items-0.xml_sample 2010-11-18 0= 7:24:59 UTC (rev 20082) @@ -0,0 +1,7 @@ + + + + + + + Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras= /exam-Component_Reference-richselect-Selection_items-1.xml_sample =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=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/extras/ex= am-Component_Reference-richselect-Selection_items-1.xml_sample = (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex= am-Component_Reference-richselect-Selection_items-1.xml_sample 2010-11-18 0= 7:24:59 UTC (rev 20082) @@ -0,0 +1,3 @@ + + + Deleted: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extr= as/exam-Component_Reference-richselect-Selection_items.xml_sample =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=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/extras/ex= am-Component_Reference-richselect-Selection_items.xml_sample 2010-11-18 02:= 05:03 UTC (rev 20081) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex= am-Component_Reference-richselect-Selection_items.xml_sample 2010-11-18 07:= 24:59 UTC (rev 20082) @@ -1,4 +0,0 @@ - - - - --===============0049606652635504302==--