[richfaces-svn-commits] JBoss Rich Faces SVN: r19982 - in modules/docs/trunk/Component_Reference: src/main/docbook/en-US and 1 other directory.

Author: SeanRogers Date: 2010-11-07 23:32:02 -0500 (Sun, 07 Nov 2010) New Revision: 19982 Modified: modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml Log: Added rich:inplaceSelect Modified: modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt =================================================================== --- modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt 2010-11-07 14:37:36 UTC (rev 19981) +++ modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt 2010-11-08 04:32:02 UTC (rev 19982) @@ -1,3 +1,5 @@ +included|written + a4j tag library - chap-Component_Reference-Actions @@ -29,8 +31,8 @@ - chap-Component_Reference-Validation -- rich:ajaxValidator --- rich:ajaxValidator -- rich:beanValidator +-- rich:graphValidator - chap-Component_Reference-Processing_management -- a4j:queue @@ -41,42 +43,40 @@ rich tag library - chap-Component_Reference-Rich_inputs -x- rich:calendar +-- rich:autocomplete +-- rich:calendar x- rich:colorPicker -x- rich:comboBox xx rich:editor x- rich:fileUpload -- rich:inplaceInput -- rich:inplaceSelect -- rich:inputNumberSlider -x- rich:inputNumberSpinner -x- rich:suggestionBox +-- rich:inputNumberSpinner +-- rich:selectOne - chap-Component_Reference-Panels_and_containers -x- rich:modalPanel -- rich:panel --- rich:panelBar -xx rich:panelBarItem -x- rich:simpleTogglePanel +x- rich:panelBar +-- rich:popupPanel +-- rich:accordion +-- rich:accordionItem +-- rich:collapsiblePanel +-- rich:tab -- rich:tabPanel -x- rich:tab +-- rich:toggleControl -- rich:togglePanel -x- rich:toggleControl +-- rich:togglePanelItem - chap-Component_Reference-Tables_and_grids -- a4j:repeat -- rich:column -- rich:columnGroup --- rich:columns --- rich:dataDefinitionList x- rich:dataFilterSlider -- rich:dataGrid --- rich:dataList --- rich:dataOrderedList xx rich:dataScroller -- rich:dataTable -- rich:extendedDataTable -xx rich:subTable +-- rich:list -x Table filtering -x Table sorting @@ -100,12 +100,12 @@ xx rich:toolBar xx rich:toolBarGroup -x chap-Component_Reference-Output_and_messages +- chap-Component_Reference-Output_and_messages x- rich:message x- rich:messages xx rich:paint2D -xx rich:progressBar -xx rich:toolTip +-- rich:progressBar +-- rich:toolTip x chap-Component_Reference-Drag_and_drop xx rich:dragIndicator @@ -115,7 +115,7 @@ xx rich:dropListener xx rich:dndParam -x chap-Component_Reference-Layout_and_appearance +- chap-Component_Reference-Layout_and_appearance xx rich:effect -- rich:jQuery xx rich:separator Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml 2010-11-07 14:37:36 UTC (rev 19981) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml 2010-11-08 04:32:02 UTC (rev 19982) @@ -14,221 +14,6 @@ This chapter details those components which act as panels and containers to hold groups of other components. </para> - <!--<rich:accordion>--> - <section id="sect-Component_Reference-Panels_and_containers-richaccordion"> - <title><sgmltag>&lt;rich:accordion&gt;</sgmltag></title> - <para> - The <sgmltag>&lt;rich:accordion&gt;</sgmltag> is a series of panels stacked on top of each other, each collapsed such that only the header of the panel is showing. When the header of a panel is clicked, it is expanded to show the content of the panel. Clicking on a different header will collapse the previous panel and epand the selected one. Each panel contained in a <sgmltag>&lt;rich:accordion&gt;</sgmltag> component is a <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component. - </para> - <figure id="figu-Component_Reference-richaccordion-richaccordion"> - <title>A <sgmltag>&lt;rich:accordion&gt;</sgmltag> component containing three <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richaccordion-richaccordion.png" format="PNG" /> - </imageobject> - <textobject> - <para> - A <sgmltag>&lt;rich:accordion&gt;</sgmltag> component containing three <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components. Only the first panel is expanded. - </para> - </textobject> - </mediaobject> - </figure> - - <section id="sect-Component_Reference-richaccordion-Basic_usage"> - <title>Basic usage</title> - <para> - The <sgmltag>&lt;rich:accordion&gt;</sgmltag> component requires no attributes for basic usage. The component can contain any number of <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components as children. The headers of the <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components control the expanding and collapsing when clicked. Only a single <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> can be displayed at a time. Refer to <xref linkend="sect-Component_Reference-Panels_and_containers-richaccordionItem" /> for details on the <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component. - </para> - </section> - - <section id="sect-Component_Reference-richaccordion-Switching_panels"> - <title>Switching panels</title> - <para> - The switching mode for performing submissions is determined by the <code>switchType</code> attribute, which can have one of the following three values: - </para> - <variablelist> - <varlistentry> - <term><literal>server</literal></term> - <listitem> - <para> - The default setting. Activation of a <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component causes the parent <sgmltag>&lt;rich:accordion&gt;</sgmltag> component to perform a common submission, completely re-rendering the page. Only one panel at a time is uploaded to the client side. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>ajax</literal></term> - <listitem> - <para> - Activation of a <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component causes the parent <sgmltag>&lt;rich:accordion&gt;</sgmltag> component to perform an Ajax form submission, and the content of the panel is rendered. Only one panel at a time is uploaded to the client side. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>client</literal></term> - <listitem> - <para> - Activation of a <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component causes the parent <sgmltag>&lt;rich:accordion&gt;</sgmltag> component to update on the client side. JavaScript changes the styles such that one panel component becomes hidden while the other is shown. - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <!-- TODO - <section id="sect-Component_Reference-richaccordion-Controlling_panel_size"> - <title>Controlling panel size</title> - <para> - Unlike the <sgmltag>&lt;rich:panel&gt;</sgmltag> component, the size of the <sgmltag>&lt;rich:accordion&gt;</sgmltag> can be specified using <varname>width</varname> and <varname>height</varname> attributes. If unspecified, these values default to 100%. - </para> - </section> - --> - - <section id="sect-Component_Reference-richaccordion-richaccordion_client-side_events"> - <title><sgmltag>&lt;rich:accordion&gt;</sgmltag> client-side events</title> - <para> - In addition to the standard Ajax events and HTML events, the <sgmltag>&lt;rich:accordion&gt;</sgmltag> component uses the client-side events common to all switchable panels: - </para> - <itemizedlist> - <listitem> - <para> - The <varname>onitemchange</varname> event points to the function to perform when the switchable item is changed. - </para> - </listitem> - <listitem> - <para> - The <varname>onbeforeitemchange</varname> event points to the function to perform when before the switchable item is changed. - </para> - </listitem> - </itemizedlist> - </section> - - <section id="sect-Component_Reference-richaccordion-richaccordion_server-side_events"> - <title><sgmltag>&lt;rich:accordion&gt;</sgmltag> server-side events</title> - <para> - The <sgmltag>&lt;rich:accordion&gt;</sgmltag> component uses the server-side events common to all switchable panels: - </para> - <itemizedlist> - <listitem> - <para> - The <varname>ItemChangeEvent</varname> event occurs on the server side when an item is changed through Ajax using the <literal>server</literal> mode. It can be processed using the <varname>ItemChangeListener</varname> attribute. - </para> - </listitem> - </itemizedlist> - </section> - - <section id="sect-Component_Reference-richaccordion-Reference_data"> - <title>Reference data</title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.richfaces.accordion</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlAccordion</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.richfaces.accordion</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.accordionRenderer</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.accordionTag</classname> - </para> - </listitem> - </itemizedlist> - </section> - </section> - - <!--<rich:accordionItem>--> - <section id="sect-Component_Reference-Panels_and_containers-richaccordionItem"> - <title><sgmltag>&lt;rich:accordionItem&gt;</sgmltag></title> - <para> - The <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component is a panel for use with the <sgmltag>&lt;rich:accordion&gt;</sgmltag> component. Refer to <xref linkend="sect-Component_Reference-Panels_and_containers-richaccordion" /> for details on the <sgmltag>&lt;rich:accordion&gt;</sgmltag> component. - </para> - <figure id="figu-Component_Reference-richaccordionItem-richaccordion"> - <title>A <sgmltag>&lt;rich:accordion&gt;</sgmltag> component containing three <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richaccordion-richaccordion.png" format="PNG" /> - </imageobject> - <textobject> - <para> - A <sgmltag>&lt;rich:accordion&gt;</sgmltag> component containing three <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components. Only the first panel is expanded. - </para> - </textobject> - </mediaobject> - </figure> - - <section id="sect-Component_Reference-richaccordionItem-Basic_usage"> - <title>Basic usage</title> - <para> - Basic usage of the <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component requires the <varname>label</varname> attribute, which provides the text on the panel header. The panel header is all that is visible when the accordion item is collapsed. - </para> - <para> - Alternatively the <literal>header</literal> facet could be used in place of the <varname>label</varname> attribute. This would allow for additional styles and custom content to be applied to the tab. - </para> - </section> - - <section id="sect-Component_Reference-richaccordionItem-richaccordionItem_client-side_events"> - <title><sgmltag>&lt;rich:accordionItem&gt;</sgmltag> client-side events</title> - <para> - In addition to the standard HTML events, the <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component uses the client-side events common to all switchable panel items: - </para> - <itemizedlist> - <listitem> - <para> - The <varname>onenter</varname> event points to the function to perform when the mouse enters the panel. - </para> - </listitem> - <listitem> - <para> - The <varname>onleave</varname> attribute points to the function to perform when the mouse leaves the panel. - </para> - </listitem> - </itemizedlist> - </section> - - <section id="sect-Component_Reference-richaccordionItem-Reference_data"> - <title>Reference data</title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.richfaces.accordionItem</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlAccordionItem</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.richfaces.accordionItem</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.accordionItemRenderer</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.accordionItemTag</classname> - </para> - </listitem> - </itemizedlist> - </section> - </section> - <!--<rich:panel>--> <section id="sect-Component_Reference-Panels_and_containers-richpanel"> <title><sgmltag>&lt;rich:panel&gt;</sgmltag></title> @@ -468,6 +253,221 @@ </section> </section> + <!--<rich:accordion>--> + <section id="sect-Component_Reference-Panels_and_containers-richaccordion"> + <title><sgmltag>&lt;rich:accordion&gt;</sgmltag></title> + <para> + The <sgmltag>&lt;rich:accordion&gt;</sgmltag> is a series of panels stacked on top of each other, each collapsed such that only the header of the panel is showing. When the header of a panel is clicked, it is expanded to show the content of the panel. Clicking on a different header will collapse the previous panel and epand the selected one. Each panel contained in a <sgmltag>&lt;rich:accordion&gt;</sgmltag> component is a <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component. + </para> + <figure id="figu-Component_Reference-richaccordion-richaccordion"> + <title>A <sgmltag>&lt;rich:accordion&gt;</sgmltag> component containing three <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richaccordion-richaccordion.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:accordion&gt;</sgmltag> component containing three <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components. Only the first panel is expanded. + </para> + </textobject> + </mediaobject> + </figure> + + <section id="sect-Component_Reference-richaccordion-Basic_usage"> + <title>Basic usage</title> + <para> + The <sgmltag>&lt;rich:accordion&gt;</sgmltag> component requires no attributes for basic usage. The component can contain any number of <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components as children. The headers of the <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components control the expanding and collapsing when clicked. Only a single <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> can be displayed at a time. Refer to <xref linkend="sect-Component_Reference-Panels_and_containers-richaccordionItem" /> for details on the <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component. + </para> + </section> + + <section id="sect-Component_Reference-richaccordion-Switching_panels"> + <title>Switching panels</title> + <para> + The switching mode for performing submissions is determined by the <code>switchType</code> attribute, which can have one of the following three values: + </para> + <variablelist> + <varlistentry> + <term><literal>server</literal></term> + <listitem> + <para> + The default setting. Activation of a <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component causes the parent <sgmltag>&lt;rich:accordion&gt;</sgmltag> component to perform a common submission, completely re-rendering the page. Only one panel at a time is uploaded to the client side. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>ajax</literal></term> + <listitem> + <para> + Activation of a <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component causes the parent <sgmltag>&lt;rich:accordion&gt;</sgmltag> component to perform an Ajax form submission, and the content of the panel is rendered. Only one panel at a time is uploaded to the client side. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>client</literal></term> + <listitem> + <para> + Activation of a <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component causes the parent <sgmltag>&lt;rich:accordion&gt;</sgmltag> component to update on the client side. JavaScript changes the styles such that one panel component becomes hidden while the other is shown. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <!-- TODO + <section id="sect-Component_Reference-richaccordion-Controlling_panel_size"> + <title>Controlling panel size</title> + <para> + Unlike the <sgmltag>&lt;rich:panel&gt;</sgmltag> component, the size of the <sgmltag>&lt;rich:accordion&gt;</sgmltag> can be specified using <varname>width</varname> and <varname>height</varname> attributes. If unspecified, these values default to 100%. + </para> + </section> + --> + + <section id="sect-Component_Reference-richaccordion-richaccordion_client-side_events"> + <title><sgmltag>&lt;rich:accordion&gt;</sgmltag> client-side events</title> + <para> + In addition to the standard Ajax events and HTML events, the <sgmltag>&lt;rich:accordion&gt;</sgmltag> component uses the client-side events common to all switchable panels: + </para> + <itemizedlist> + <listitem> + <para> + The <varname>onitemchange</varname> event points to the function to perform when the switchable item is changed. + </para> + </listitem> + <listitem> + <para> + The <varname>onbeforeitemchange</varname> event points to the function to perform when before the switchable item is changed. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richaccordion-richaccordion_server-side_events"> + <title><sgmltag>&lt;rich:accordion&gt;</sgmltag> server-side events</title> + <para> + The <sgmltag>&lt;rich:accordion&gt;</sgmltag> component uses the server-side events common to all switchable panels: + </para> + <itemizedlist> + <listitem> + <para> + The <varname>ItemChangeEvent</varname> event occurs on the server side when an item is changed through Ajax using the <literal>server</literal> mode. It can be processed using the <varname>ItemChangeListener</varname> attribute. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richaccordion-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.accordion</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlAccordion</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.accordion</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.accordionRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.accordionTag</classname> + </para> + </listitem> + </itemizedlist> + </section> + </section> + + <!--<rich:accordionItem>--> + <section id="sect-Component_Reference-Panels_and_containers-richaccordionItem"> + <title><sgmltag>&lt;rich:accordionItem&gt;</sgmltag></title> + <para> + The <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component is a panel for use with the <sgmltag>&lt;rich:accordion&gt;</sgmltag> component. Refer to <xref linkend="sect-Component_Reference-Panels_and_containers-richaccordion" /> for details on the <sgmltag>&lt;rich:accordion&gt;</sgmltag> component. + </para> + <figure id="figu-Component_Reference-richaccordionItem-richaccordion"> + <title>A <sgmltag>&lt;rich:accordion&gt;</sgmltag> component containing three <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richaccordion-richaccordion.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:accordion&gt;</sgmltag> component containing three <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> components. Only the first panel is expanded. + </para> + </textobject> + </mediaobject> + </figure> + + <section id="sect-Component_Reference-richaccordionItem-Basic_usage"> + <title>Basic usage</title> + <para> + Basic usage of the <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component requires the <varname>label</varname> attribute, which provides the text on the panel header. The panel header is all that is visible when the accordion item is collapsed. + </para> + <para> + Alternatively the <literal>header</literal> facet could be used in place of the <varname>label</varname> attribute. This would allow for additional styles and custom content to be applied to the tab. + </para> + </section> + + <section id="sect-Component_Reference-richaccordionItem-richaccordionItem_client-side_events"> + <title><sgmltag>&lt;rich:accordionItem&gt;</sgmltag> client-side events</title> + <para> + In addition to the standard HTML events, the <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component uses the client-side events common to all switchable panel items: + </para> + <itemizedlist> + <listitem> + <para> + The <varname>onenter</varname> event points to the function to perform when the mouse enters the panel. + </para> + </listitem> + <listitem> + <para> + The <varname>onleave</varname> attribute points to the function to perform when the mouse leaves the panel. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richaccordionItem-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.accordionItem</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlAccordionItem</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.accordionItem</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.accordionItemRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.accordionItemTag</classname> + </para> + </listitem> + </itemizedlist> + </section> + </section> + <!--<rich:collapsiblePanel>--> <section id="sect-Component_Reference-Panels_and_containers-richcollapsiblePanel"> <title><sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag></title> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-11-07 14:37:36 UTC (rev 19981) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-11-08 04:32:02 UTC (rev 19982) @@ -14,6 +14,172 @@ This chapter details rich components for user input and interaction. </para> + <!--<rich:autocomplete>--> + <section id="sect-Component_Reference-Rich_inputs-richautocomplete"> + <title><sgmltag>&lt;rich:autocomplete&gt;</sgmltag></title> + <para> + The <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> component is an auto-completing input-box with built-in Ajax capabilities. It supports client-side suggestions, browser-like selection, and customization of the look and feel. + </para> + <para> + To attach an auto-completion behavior to other components, use the <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior. Refer to <xref linkend="sect-Component_Reference-Rich_inputs-richautocompleteBehavior" /> for full details on the <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior. + </para> + <figure id="figu-Component_Reference-richautocomplete-richautocomplete"> + <title><sgmltag>&lt;rich:autocomplete&gt;</sgmltag></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richautocomplete-richautocomplete.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:autocomplete&gt;</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-richautocomplete-Basic_usage"> + <title>Basic usage</title> + <para> + The <varname>value</varname> attribute stores the text entered by the user for the auto-complete box. Suggestions shown in the auto-complete list can be specified using the <varname>autocompleteMethod</varname> attribute, which points to a collection of suggestions. + </para> + <example id="exam-Component_Reference-richautocomplete-Defining_suggestion_values"> + <title>Defining suggestion values</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richautocomplete-Defining_suggestion_values.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + <!-- + <itemizedlist> + <listitem> + <para> + Using the JSF components <sgmltag>&lt;f:selectItem&gt;</sgmltag> and <sgmltag>&lt;f:selectItems&gt;</sgmltag> to define a list of items: + </para> + <example id="exam-Component_Reference-richautocomplete-Defining_list_items_for_richinplaceSelect"> + <title>Defining list items for <sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag></title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richautocomplete-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-richautocomplete-Interactivity_options"> + <title>Interactivity options</title> + <!-- TODO + <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>selectFirst</varname>="false"</code>. + </para> + <para> + Setting <code><varname>autoFill</varname>="true"</code> causes the combo-box to fill the text field box with a matching suggestion as the user types. + </para> + </section> + + <!-- TODO + <section id="sect-Component_Reference-richautocomplete-richautocomplete_events"> + <title><sgmltag>&lt;rich:autocomplete&gt;</sgmltag> events</title> + <para> + The <sgmltag>&lt;rich:autocomplete&gt;</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-richautocomplete-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.autocomplete</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlAutocomplete</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.autocomplete</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.renderkit.autocompleteRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.autocompleteTag</classname> + </para> + </listitem> + </itemizedlist> + </section> + </section> + + <!-- TODO not in M4 --> + <!--<rich:autocompleteBehavior>--> + <!-- + <section id="sect-Component_Reference-Rich_inputs-richautocompleteBehavior"> + <title><sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag></title> + <para> + The <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior is an auto-completing list of input suggestions that can be attached to other components. + </para> + <para> + Use the <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> component for a standard auto-completing combo-box control. Refer to <xref linkend="sect-Component_Reference-Rich_inputs-richautocomplete" /> for full details on the <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> component. + </para> + + <section id="sect-Component_Reference-richautocompleteBehavior-Basic_usage"> + <title>Basic usage</title> + <para> + Attach the <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior as a sub-element to another component to provide auto-complete suggestions for that component. Suggestions shown in the auto-complete list can be specified using the <varname>autocompleteMethod</varname> attribute, which points to a collection of suggestions. <xref linkend="exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values" /> demonstrates a <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior attached to a standard JSF <sgmltag>&lt;h:inputText&gt;</sgmltag> component. + </para> + <example id="exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values"> + <title>Defining suggestion values</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </section> + + <section id="sect-Component_Reference-richautocompleteBehavior-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.autocompleteBehavior</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlAutocompleteBehavior</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.autocompleteBehavior</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.autocompleteBehaviorTag</classname> + </para> + </listitem> + </itemizedlist> + </section> + </section> + --> + <!-- <rich:calendar> --> <section id="sect-Component_Reference-Rich_inputs-richcalendar"> <title><sgmltag>&lt;rich:calendar&gt;</sgmltag></title> @@ -211,174 +377,8 @@ </section> --> - <!--<rich:autocomplete>--> - <section id="sect-Component_Reference-Rich_inputs-richautocomplete"> - <title><sgmltag>&lt;rich:autocomplete&gt;</sgmltag></title> - <para> - The <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> component is an auto-completing input-box with built-in Ajax capabilities. It supports client-side suggestions, browser-like selection, and customization of the look and feel. - </para> - <para> - To attach an auto-completion behavior to other components, use the <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior. Refer to <xref linkend="sect-Component_Reference-Rich_inputs-richautocompleteBehavior" /> for full details on the <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior. - </para> - <figure id="figu-Component_Reference-richautocomplete-richautocomplete"> - <title><sgmltag>&lt;rich:autocomplete&gt;</sgmltag></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richautocomplete-richautocomplete.png" format="PNG" /> - </imageobject> - <textobject> - <para> - A <sgmltag>&lt;rich:autocomplete&gt;</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-richautocomplete-Basic_usage"> - <title>Basic usage</title> - <para> - The <varname>value</varname> attribute stores the text entered by the user for the auto-complete box. Suggestions shown in the auto-complete list can be specified using the <varname>autocompleteMethod</varname> attribute, which points to a collection of suggestions. - </para> - <example id="exam-Component_Reference-richautocomplete-Defining_suggestion_values"> - <title>Defining suggestion values</title> - <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richautocomplete-Defining_suggestion_values.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </example> - <!-- - <itemizedlist> - <listitem> - <para> - Using the JSF components <sgmltag>&lt;f:selectItem&gt;</sgmltag> and <sgmltag>&lt;f:selectItems&gt;</sgmltag> to define a list of items: - </para> - <example id="exam-Component_Reference-richautocomplete-Defining_list_items_for_richinplaceSelect"> - <title>Defining list items for <sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag></title> - <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richautocomplete-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-richautocomplete-Interactivity_options"> - <title>Interactivity options</title> - <!-- TODO - <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>selectFirst</varname>="false"</code>. - </para> - <para> - Setting <code><varname>autoFill</varname>="true"</code> causes the combo-box to fill the text field box with a matching suggestion as the user types. - </para> - </section> - - <!-- TODO - <section id="sect-Component_Reference-richautocomplete-richautocomplete_events"> - <title><sgmltag>&lt;rich:autocomplete&gt;</sgmltag> events</title> - <para> - The <sgmltag>&lt;rich:autocomplete&gt;</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-richautocomplete-Reference_data"> - <title>Reference data</title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.richfaces.autocomplete</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlAutocomplete</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.richfaces.autocomplete</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.renderkit.autocompleteRenderer</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.autocompleteTag</classname> - </para> - </listitem> - </itemizedlist> - </section> - </section> - <!-- TODO not in M4 --> - <!--<rich:autocompleteBehavior>--> <!-- - <section id="sect-Component_Reference-Rich_inputs-richautocompleteBehavior"> - <title><sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag></title> - <para> - The <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior is an auto-completing list of input suggestions that can be attached to other components. - </para> - <para> - Use the <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> component for a standard auto-completing combo-box control. Refer to <xref linkend="sect-Component_Reference-Rich_inputs-richautocomplete" /> for full details on the <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> component. - </para> - - <section id="sect-Component_Reference-richautocompleteBehavior-Basic_usage"> - <title>Basic usage</title> - <para> - Attach the <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior as a sub-element to another component to provide auto-complete suggestions for that component. Suggestions shown in the auto-complete list can be specified using the <varname>autocompleteMethod</varname> attribute, which points to a collection of suggestions. <xref linkend="exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values" /> demonstrates a <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior attached to a standard JSF <sgmltag>&lt;h:inputText&gt;</sgmltag> component. - </para> - <example id="exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values"> - <title>Defining suggestion values</title> - <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </example> - </section> - - <section id="sect-Component_Reference-richautocompleteBehavior-Reference_data"> - <title>Reference data</title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.richfaces.autocompleteBehavior</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlAutocompleteBehavior</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.richfaces.autocompleteBehavior</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.autocompleteBehaviorTag</classname> - </para> - </listitem> - </itemizedlist> - </section> - </section> - --> - - <!-- TODO not in M4 --> - <!-- <section id="sect-Component_Reference-Rich_inputs-richeditor"> <title><sgmltag>&lt;rich:editor&gt;</sgmltag></title> <para> @@ -566,9 +566,7 @@ </section> </section> - <!-- TODO not in M4 --> <!--<rich:inplaceSelect>--> - <!-- <section id="sect-Component_Reference-Rich_inputs-richinplaceSelect"> <title><sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag></title> <para> @@ -672,7 +670,6 @@ </itemizedlist> </section> </section> - --> <!--<rich:inputNumberSlider>--> <section id="sect-Component_Reference-Rich_inputs-richinputNumberSlider">