[richfaces-svn-commits] JBoss Rich Faces SVN: r18744 - in modules/docs/branches/draft/Component_Reference: src/main/docbook/en-US and 2 other directories.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Wed Aug 18 01:35:45 EDT 2010
Author: SeanRogers
Date: 2010-08-18 01:35:44 -0400 (Wed, 18 Aug 2010)
New Revision: 18744
Added:
modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomboBox-Defining_list_items_for_richinplaceSelect.xml_sample
modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomboBox-Defining_suggestion_values.xml_sample
modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richcomboBox-richcomboBox.png
Modified:
modules/docs/branches/draft/Component_Reference/Component_Reference_chapters.txt
modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml
Log:
Updated comboBox (RF-8872)
Modified: modules/docs/branches/draft/Component_Reference/Component_Reference_chapters.txt
===================================================================
--- modules/docs/branches/draft/Component_Reference/Component_Reference_chapters.txt 2010-08-18 03:44:09 UTC (rev 18743)
+++ modules/docs/branches/draft/Component_Reference/Component_Reference_chapters.txt 2010-08-18 05:35:44 UTC (rev 18744)
@@ -54,8 +54,8 @@
- chap-Component_Reference-Panels_and_containers
x- rich:modalPanel
-xx rich:panel
-xx rich:panelBar
+-- rich:panel
+-- rich:panelBar
xx rich:panelBarItem
x- rich:simpleTogglePanel
-- rich:tabPanel
@@ -68,11 +68,11 @@
-- rich:column
-- rich:columnGroup
-- rich:columns
-x- rich:dataDefinitionList
+-- rich:dataDefinitionList
x- rich:dataFilterSlider
-- rich:dataGrid
-x- rich:dataList
-x- rich:dataOrderedList
+-- rich:dataList
+-- rich:dataOrderedList
xx rich:dataScroller
-- rich:dataTable
-- rich:extendedDataTable
@@ -117,7 +117,7 @@
x chap-Component_Reference-Layout_and_appearance
xx rich:effect
-xx rich:jQuery
+-- rich:jQuery
xx rich:separator
xx rich:spacer
xx rich:page
Modified: modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml
===================================================================
--- modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-08-18 03:44:09 UTC (rev 18743)
+++ modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-08-18 05:35:44 UTC (rev 18744)
@@ -114,67 +114,118 @@
The <sgmltag><rich:colorPicker></sgmltag> component has the unique event handler <varname>onbeforeshow</varname>, which is triggered immediately before the color picker is opened. The <varname>showEvent</varname> attribute can be used to bind the opening of the color picker to a specific event; it is bound to the <varname>onclick</varname> event by default.
</para>
</section>
+ -->
+ <!--<rich:comboBox>-->
<section id="sect-Component_Reference-Rich_inputs-richcomboBox">
<title><sgmltag><rich:comboBox></sgmltag></title>
<para>
- The <sgmltag><rich:comboBox></sgmltag> component is a typical combo-box with built-in Ajax capabilities. It supports client-side suggestions, browser-like selection, Seam entity converter support, and customization of the look and feel.
+ The <sgmltag><rich:comboBox></sgmltag> component is an auto-completing combo-box with built-in Ajax capabilities. It supports client-side suggestions, browser-like selection, Seam entity converter support, and customization of the look and feel.
</para>
- <para>
- The <varname>value</varname> attribute stores the selected value for the combo-box. Suggestions shown in the drop-down list for the combo-box can be specified in one of two ways:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- Using the <varname>suggestionValues</varname> attribute, and defining a collection of suggestions:
- </para>
- <example id="exam-Component_Reference-richcomboBox-Defining_suggestion_values">
- <title>Defining suggestion values</title>
-
-<programlisting language="XML" role="XML">
-<rich:comboBox value="#{bean.state}" suggestionValues="#{bean.suggestions}"
-</programlisting>
- </example>
- </listitem>
- <listitem>
- <para>
- Using the JSF components <sgmltag><f:selectItem></sgmltag> and <sgmltag><f:selectItems></sgmltag> to define a list of items:
- </para>
- <example id="exam-Component_Reference-richcomboBox-Defining_list_items_for_richinplaceSelect">
- <title>Defining list items for <sgmltag><rich:inplaceSelect></sgmltag></title>
-
-<programlisting language="XML" role="XML">
-<rich:comboBox value="#{bean.item}" valueChangeListener="#{bean.selectionChanged}" >
- <f:selectItems value="#{bean.selectItems}" />
- <f.selectItem itemValue="Item 1" />
- <f.selectItem itemValue="Item 2" />
- <f.selectItem itemValue="Item 3" />
- <f.selectItem itemValue="Item 4" />
-</rich:comboBox>
-</programlisting>
- </example>
- </listitem>
- </itemizedlist>
- <para>
- Users can type into the combo-box's text field to enter a value, which also searches through the suggestion items in the drop-down box. By default, the first suggestion item is selected as the user types. This behavior can be deactivated by setting <code>selectFirstOnUpdate="false"</code>. Setting <code>directInputSuggestions="true"</code> causes the combo-box to fill the text field box with a matching suggestion as the user types. Alternatively, the text field can be disabled by setting <code>enableManualInput="false"</code>, which forces the users to pick from items in the drop-down box.
- </para>
- <para>
- The <sgmltag><rich:comboBox></sgmltag> component has two unique event handlers:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <varname>onlistcall</varname> triggers before the drop-down list is shown, allowing the operation to be canceled.
- </para>
- </listitem>
- <listitem>
- <para>
- <varname>onselect</varname> triggers when a suggestion is selected from the drop-down list, before the update request is sent.
- </para>
- </listitem>
- </itemizedlist>
+ <figure id="figu-Component_Reference-richcomboBox-richcomboBox">
+ <title><sgmltag><rich:comboBox></sgmltag></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/figu-Component_Reference-richcomboBox-richcomboBox.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <para>
+ A <sgmltag><rich:comboBox></sgmltag> component. The letter <wordasword>A</wordasword> has been entered, such that the suggestion list only shows those options beginning with <wordasword>A</wordasword>.
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <section id="sect-Component_Reference-richcomboBox-Basic_usage">
+ <title>Basic usage</title>
+ <para>
+ The <varname>value</varname> attribute stores the selected value for the combo-box. Suggestions shown in the drop-down list for the combo-box can be specified in one of two ways:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Using the <varname>suggestionValues</varname> attribute, and defining a collection of suggestions:
+ </para>
+ <example id="exam-Component_Reference-richcomboBox-Defining_suggestion_values">
+ <title>Defining suggestion values</title>
+ <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcomboBox-Defining_suggestion_values.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
+ </example>
+ </listitem>
+ <listitem>
+ <para>
+ Using the JSF components <sgmltag><f:selectItem></sgmltag> and <sgmltag><f:selectItems></sgmltag> to define a list of items:
+ </para>
+ <example id="exam-Component_Reference-richcomboBox-Defining_list_items_for_richinplaceSelect">
+ <title>Defining list items for <sgmltag><rich:inplaceSelect></sgmltag></title>
+ <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcomboBox-Defining_list_items_for_richinplaceSelect.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
+ </example>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="sect-Component_Reference-richcomboBox-Interactivity_options">
+ <title>Interactivity options</title>
+ <para>
+ The input box can display an instructional label before text is entered. This can be set through the <varname>defaultLabel</varname> attribute.
+ </para>
+ <para>
+ Users can type into the combo-box's text field to enter a value, which also searches through the suggestion items in the drop-down box. By default, the first suggestion item is selected as the user types. This behavior can be deactivated by setting <code><varname>selectFirstOnUpdate</varname>="false"</code>.
+ </para>
+ <para>
+ Setting <code><varname>directInputSuggestions</varname>="true"</code> causes the combo-box to fill the text field box with a matching suggestion as the user types. Alternatively, the text field can be disabled by setting <code><varname>enableManualInput</varname>="false"</code>, which forces the users to pick from items in the drop-down box.
+ </para>
+ </section>
+
+ <section id="sect-Component_Reference-richcomboBox-richcomboBox_events">
+ <title><sgmltag><rich:comboBox></sgmltag> events</title>
+ <para>
+ The <sgmltag><rich:comboBox></sgmltag> component has two unique event handlers:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <varname>onlistcall</varname> triggers before the drop-down list is shown, allowing the operation to be canceled.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <varname>onselect</varname> triggers when a suggestion is selected from the drop-down list, before the update request is sent.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="sect-Component_Reference-richcomboBox-Reference_data">
+ <title>Reference data</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <parameter>component-type</parameter>: <classname>org.richfaces.ComboBox</classname>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlComboBox</classname>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>component-family</parameter>: <classname>org.richfaces.ComboBox</classname>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>renderer-type</parameter>: <classname>org.richfaces.renderkit.ComboBoxRenderer</classname>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ComboBoxTag</classname>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
</section>
- -->
<!-- TODO not in M2 -->
<!--
@@ -268,6 +319,7 @@
</section>
-->
+ <!--<rich:inplaceInput>-->
<section id="sect-Component_Reference-Rich_inputs-richinplaceInput">
<title><sgmltag><rich:inplaceInput></sgmltag></title>
<para>
@@ -356,6 +408,7 @@
</section>
</section>
+ <!--<rich:inplaceSelect>-->
<section id="sect-Component_Reference-Rich_inputs-richinplaceSelect">
<title><sgmltag><rich:inplaceSelect></sgmltag></title>
<para>
@@ -447,6 +500,7 @@
</section>
</section>
+ <!--<rich:inputNumberSlider>-->
<section id="sect-Component_Reference-Rich_inputs-richinputNumberSlider">
<title><sgmltag><rich:inputNumberSlider></sgmltag></title>
<para>
@@ -524,7 +578,10 @@
The ability to change the value by typing into the text field can be disabled by setting <code>enableManualInput="false"</code>.
</para>
</section>
+ -->
+ <!--<rich:suggestionBox>-->
+ <!--
<section id="sect-Component_Reference-Rich_inputs-richsuggestionBox">
<title><sgmltag><rich:suggestionBox></sgmltag></title>
<para>
Added: modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomboBox-Defining_list_items_for_richinplaceSelect.xml_sample
===================================================================
--- modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomboBox-Defining_list_items_for_richinplaceSelect.xml_sample (rev 0)
+++ modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomboBox-Defining_list_items_for_richinplaceSelect.xml_sample 2010-08-18 05:35:44 UTC (rev 18744)
@@ -0,0 +1,7 @@
+<rich:comboBox value="#{bean.state}" valueChangeListener="#{bean.selectionChanged}" >
+ <f:selectItems value="#{bean.selectItems}" />
+ <f.selectItem itemValue="Oregon" />
+ <f.selectItem itemValue="Pennsylvania" />
+ <f.selectItem itemValue="Rhode Island" />
+ <f.selectItem itemValue="South Carolina" />
+</rich:comboBox>
Added: modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomboBox-Defining_suggestion_values.xml_sample
===================================================================
--- modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomboBox-Defining_suggestion_values.xml_sample (rev 0)
+++ modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcomboBox-Defining_suggestion_values.xml_sample 2010-08-18 05:35:44 UTC (rev 18744)
@@ -0,0 +1 @@
+<rich:comboBox value="#{bean.state}" suggestionValues="#{bean.suggestions}" />
Added: modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richcomboBox-richcomboBox.png
===================================================================
(Binary files differ)
Property changes on: modules/docs/branches/draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richcomboBox-richcomboBox.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
More information about the richfaces-svn-commits
mailing list