Author: SeanRogers Date: 2010-09-28 21:32:39 -0400 (Tue, 28 Sep 2010) New Revision: 19362 Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richcollapsiblePanel-richcollapsiblePanel.png modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richinplaceSelect-richinplaceSelect.png modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richinputNumberSlider-richinputNumberSlider.png modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richinputNumberSpinner-richinputNumberSpinner.png Modified: modules/docs/trunk/ 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 modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocomplete-Defining_suggestion_values.xml_sample modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml Log: Merged revisions 19182-19183,19209,19220,19305,19329,19352 via svnmerge from http://svn.jboss.org/repos/richfaces/modules/docs/branches/M3_draft ....... r19182 | SeanRogers | 2010-09-14 11:39:52 +1000 (Tue, 14 Sep 2010) | 1 line Completed rich:list style details (RF-9140) ....... r19183 | SeanRogers | 2010-09-14 16:27:07 +1000 (Tue, 14 Sep 2010) | 1 line Removed ajaxKeys references and updated to new approach (RF-9139) ....... r19209 | SeanRogers | 2010-09-15 11:09:27 +1000 (Wed, 15 Sep 2010) | 1 line Updated rich:dataGrid description (RF-9141) ....... r19220 | SeanRogers | 2010-09-16 13:46:10 +1000 (Thu, 16 Sep 2010) | 1 line Added rich:collapsiblePanel (RF-8830) ....... r19305 | SeanRogers | 2010-09-22 16:45:55 +1000 (Wed, 22 Sep 2010) | 1 line rich:inputNumberSlider (RF-9202) ....... r19329 | SeanRogers | 2010-09-24 16:13:12 +1000 (Fri, 24 Sep 2010) | 1 line Updated rich:inplaceSelect (RF-9038) ....... r19352 | SeanRogers | 2010-09-28 15:57:06 +1000 (Tue, 28 Sep 2010) | 1 line Added rich:autocompleteBehavior ....... Property changes on: modules/docs/trunk ___________________________________________________________________ Name: svnmerge-integrated - /modules/docs/branches/M3_draft:1-19161 + /modules/docs/branches/M3_draft:1-19361 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-09-29 01:26:56 UTC (rev 19361) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml 2010-09-29 01:32:39 UTC (rev 19362) @@ -468,44 +468,151 @@ </section> </section> - <!-- TODO not in M2 --> - <!-- - <section id="sect-Component_Reference-Panels_and_containers-richsimpleTogglePanel"> - <title><sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag></title> + <!--<rich:collapsiblePanel>--> + <section id="sect-Component_Reference-Panels_and_containers-richcollapsiblePanel"> + <title><sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag></title> <para> - The <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> component is a collapsible panel that shows or hides content when the header bar is activated. It is a simplified version of <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component. + The <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component is a collapsible panel that shows or hides content when the header bar is activated. It is a simplified version of <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component. </para> - <para> - Basic usage requires only the <varname>label</varname> attribute to be specified, which provides the title for the header element. - </para> - <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> - <itemizedlist> - <listitem> - <para> - <literal>server</literal>, the default setting, which causes the <sgmltag>&lt;rich:simpleTogglePanel&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> - <listitem> - <para> - <literal>ajax</literal>, which causes the <sgmltag>&lt;rich:simpleTogglePanel&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> - <listitem> - <para> - <literal>client</literal>, which causes <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> components to update on the client side, re-rendering themselves and any additional components listed with the <code>render</code> attribute. - </para> - </listitem> - </itemizedlist> - <para> - If the <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> component uses <code>opened="true"</code>, the panel is open and expanded, otherwise it is closed and collapsed. - </para> - <para> - The <code>openMarker</code> and <code>closeMarker</code> attributes can be used to define custom icons for the expanding header. - </para> + <figure id="figu-Component_Reference-richcollapsiblePanel-richcollapsiblePanel"> + <title><sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richcollapsiblePanel-richcollapsiblePanel.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component displaying details on a camera model. + </para> + </textobject> + </mediaobject> + </figure> + + <section id="sect-Component_Reference-richcollapsiblePanel-Basic_usage"> + <title>Basic usage</title> + <para> + Basic usage requires only the <varname>label</varname> attribute to be specified, which provides the title for the header element. + </para> + </section> + + <section id="sect-Component_Reference-richcollapsiblePanel-Expanding_and_collapsing_the_panel"> + <title>Expanding and collapsing the panel</title> + <para> + If the <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component uses <code><varname>expanded</varname>="true"</code>, the panel is open and expanded, otherwise it is closed and collapsed. + </para> + <para> + The <varname>toggleElement</varname> attribute is used to specify which user interface element triggers the expansion when clicked. It can have one of the following values: + </para> + <variablelist> + <varlistentry> + <term><literal>heading</literal></term> + <listitem> + <para> + This is the default setting. Clicking anywhere on the header of the panel will cause it to expand or collapse. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>panel</literal></term> + <listitem> + <para> + Clicking anywhere on the entire panel will cause it to expand or collapse. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>control</literal></term> + <listitem> + <para> + The panel can only be expanded or collapsed by clicking on the control in the right-hand side of the header. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + The switching mode for performing submissions is determined by the <varname>switchType</varname> attribute, which can have one of the following three values: + </para> + <variablelist> + <varlistentry> + <term><literal>server</literal></term> + <listitem> + <para> + This is the default setting. The <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component performs 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> + The <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component performs an Ajax form submission, and only 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> + The <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component updates on the client side, re-rendering itself and any additional components listed with the <varname>render</varname> attribute. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section id="sect-Component_Reference-richcollapsiblePanel-Appearance"> + <title>Appearance</title> + <para> + The appearance of the <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component can be customized using facets. The <literal>headerExpanded</literal> and <literal>headerCollapsed</literal> facets are used to style the appearance of the panel when it is expanded and collapsed respectively. The <literal>expandControl</literal> facet styles the control in the panel header used for expanding, and the <literal>collapseControl</literal> facet styles the control for collapsing. + </para> + </section> + + <section id="sect-Component_Reference-richcollapsiblePanel-richcollapsiblePanel_server-side_events"> + <title><sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> server-side events</title> + <para> + The <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component uses the following unique server-side events: + </para> + <itemizedlist> + <listitem> + <para> + The <varname>ChangeExpandEvent</varname> event occurs on the server side when the <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component is expanded or collapsed through Ajax using the <literal>server</literal> mode. It can be processed using the <varname>ChangeExpandListener</varname> attribute. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richcollapsiblePanel-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.collapsiblePanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlcollapsiblePanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.collapsiblePanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.collapsiblePanelRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.collapsiblePanelTag</classname> + </para> + </listitem> + </itemizedlist> + </section> + </section> - --> <!--<rich:tab>--> <section id="sect-Component_Reference-Panels_and_containers-richtab"> @@ -906,30 +1013,6 @@ <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> - <itemizedlist> - <listitem> - <para> - <literal>server</literal>, the default setting, which causes the child components to perform a common submission, completely re-rendering the page. Only one panel at a time is uploaded to the client side. - </para> - </listitem> - <listitem> - <para> - <literal>ajax</literal>, which causes the child components 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> - <listitem> - <para> - <literal>client</literal>, which causes the child components to update on the client side. JavaScript changes the styles such that one component becomes hidden while the other is shown. - </para> - </listitem> - </itemizedlist> - </section> - - <section id="sect-Component_Reference-richtogglePanel-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> 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-09-29 01:26:56 UTC (rev 19361) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-09-29 01:32:39 UTC (rev 19362) @@ -122,6 +122,9 @@ <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> @@ -139,7 +142,7 @@ <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>autocompleteList</varname> attribute, which points to a collection of suggestions: + 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> @@ -228,6 +231,54 @@ </section> </section> + <!--<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 M2 --> <!-- <section id="sect-Component_Reference-Rich_inputs-richeditor"> @@ -418,6 +469,19 @@ <para> The <sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag> component is similar to the <sgmltag>&lt;rich:inplaceInput&gt;</sgmltag> component, except that the <sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag> component uses a drop-down selection box to enter text instead of a regular text field. Changes can be rendered either in-line or for the whole block, and inputs can be focused with keyboard navigation. The component has three functional states: the "view" state, where the component displays its initial setting, such as "click to edit"; the "edit" state, where the user can select a value from a drop-down list; and the "changed" state, where the new value for the component has been confirmed but can be edited again if required. </para> + <figure id="figu-Component_Reference-richinplaceSelect-richinplaceSelect"> + <title><sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richinplaceSelect-richinplaceSelect.png" format="PNG" /> + </imageobject> + <textobject> + <para> + The figure shows the process of interaction with a <sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag> component. The first line shows the component displayed as a <guilabel>click to edit</guilabel> label. Once the label is clicked, the component becomes a drop-down list, shown in the second line. The final line shows the new selection in the text, which can be clicked and changed again if necessary. + </para> + </textobject> + </mediaobject> + </figure> <section id="sect-Component_Reference-richinplaceSelect-Basic_usage"> <title>Basic usage</title> @@ -510,6 +574,20 @@ <para> The <sgmltag>&lt;rich:inputNumberSlider&gt;</sgmltag> component provides a slider for changing numerical values. Optional features include control arrows to step through the values, a tool-tip to display the value while sliding, and a text field for typing the numerical value which can then be validated against the slider's range. </para> + <figure id="figu-Component_Reference-richinputNumberSlider-richinputNumberSlider"> + <title><sgmltag>&lt;rich:inputNumberSlider&gt;</sgmltag></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richinputNumberSlider-richinputNumberSlider.png" format="PNG" /> + </imageobject> + <textobject> + <para> + Two <sgmltag>&lt;rich:inputNumberSlider&gt;</sgmltag> components, one oriented horizontally and the other oriented vertically. + </para> + </textobject> + </mediaobject> + </figure> + <section id="sect-Component_Reference-richinputNumberSlider-Basic_usage"> <title>Basic usage</title> <para> @@ -565,24 +643,77 @@ </section> </section> - <!-- TODO not in M2 --> - <!-- + <!-- <rich:inputNumberSpinner> --> <section id="sect-Component_Reference-Rich_inputs-richinputNumberSpinner"> <title><sgmltag>&lt;rich:inputNumberSpinner&gt;</sgmltag></title> <para> The <sgmltag>&lt;rich:inputNumberSpinner&gt;</sgmltag> component is a single-line input field with buttons to increase and decrease a numerical value. The value can be changed using the corresponding directional keys on a keyboard, or by typing into the field. </para> - <para> - Basic use of the component with no attributes specified will render a number spinner with a minimum value of 1, a maximum value of 100, and a gradient step of 1. These default properties can be re-defined with the attributes <varname>minValue</varname>, <varname>maxValue</varname>, and <varname>step</varname> respectively. The starting value of the spinner is the minimum value unless otherwise specified with the <varname>value</varname> attribute. - </para> - <para> - When changing the value using the buttons, raising the value above the maximum or cause the spinner to restart at the minimum value. Likewise, when lowering below the minimum value the spinner will reset to the maximum value. This behavior can be deactivated by setting <code>cycled="false"</code>, which will cause the buttons to stop responding when the reach the maximum or minimum value. - </para> - <para> - The ability to change the value by typing into the text field can be disabled by setting <code>enableManualInput="false"</code>. - </para> + <figure id="figu-Component_Reference-richinputNumberSpinner-richinputNumberSpinner"> + <title><sgmltag>&lt;rich:inputNumberSpinner&gt;</sgmltag></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richinputNumberSpinner-richinputNumberSpinner.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:inputNumberSpinner&gt;</sgmltag> component. The spinner currently has a value of 20, and the arrow buttons are used to increment or decrement the value. + </para> + </textobject> + </mediaobject> + </figure> + + <section id="sect-Component_Reference-richinputNumberSpinner-Basic_usage"> + <title>Basic usage</title> + <para> + Basic use of the component with no attributes specified will render a number spinner with a minimum value of 1, a maximum value of 100, and a gradient step of 1. + </para> + <para> + These default properties can be re-defined with the attributes <varname>minValue</varname>, <varname>maxValue</varname>, and <varname>step</varname> respectively. The starting value of the spinner is the minimum value unless otherwise specified with the <varname>value</varname> attribute. + </para> + </section> + + <section id="sect-Component_Reference-richinputNumberSpinner-Interactivity_options"> + <title>Interactivity options</title> + <para> + When changing the value using the buttons, raising the value above the maximum or cause the spinner to restart at the minimum value. Likewise, when lowering below the minimum value the spinner will reset to the maximum value. This behavior can be deactivated by setting <code>cycled="false"</code>, which will cause the buttons to stop responding when the reach the maximum or minimum value. + </para> + <para> + The ability to change the value by typing into the text field can be disabled by setting <code>enableManualInput="false"</code>. + </para> + </section> + + <section id="sect-Component_Reference-richinputNumberSpinner-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.inputNumberSpinner</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlInputNumberSpinner</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.inputNumberSpinner</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.renderkit.inputNumberSpinnerRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.inputNumberSpinnerTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> - --> <!--<rich:suggestionBox>--> <!-- Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-09-29 01:26:56 UTC (rev 19361) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-09-29 01:32:39 UTC (rev 19362) @@ -35,24 +35,95 @@ </example> </section> - <!-- TODO <section id="sect-Component_Reference-a4jrepeat-Limited_views_and_partial_updates"> <title>Limited views and partial updates</title> <para> The <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component uses other attributes common to iteration components, such as the <varname>first</varname> attribute for specifying the first item for iteration, and the <varname>rows</varname> attribute for specifying the number of rows of items to display. </para> <para> - After an Ajax request, only the rows specified with the <varname>ajaxKeys</varname> attribute are updated rather than the entire collection. + Specific cells, rows, and columns can be updated without sending Ajax requests for the entire collection. Components that cause the change can specify which part of the table to update through the <varname>render</varname> attribute. The <varname>render</varname> attribute specifies which part of a table to update: </para> - <example id="exam-Component_Reference-a4jrepeat-Limited_views_and_partial_updates"> - <title>Limited views and partial updates</title> - <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-Limited_views_and_partial_updates.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> - The table rows are limited using the <varname>first</varname> and <varname>rows</varname> attributes. Only those rows specified through the <varname>ajaxKeys</varname> are updated after an Ajax request. - </para> - </example> + <variablelist> + <varlistentry> + <term><code><varname>render</varname>=<replaceable>cellId</replaceable></code></term> + <listitem> + <para> + Update the cell with an identifier of <replaceable>cellId</replaceable> within the row that contains the current component. + </para> + <para> + Instead of a specific identifier, the <replaceable>cellId</replaceable> reference could be a variable: <code><varname>render</varname>=#{<replaceable>bean.cellToUpdate</replaceable>}</code>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code><varname>render</varname>=<replaceable>tableId</replaceable>:<replaceable>rowId</replaceable></code></term> + <listitem> + <para> + Update the row with an identifier of <replaceable>rowId</replaceable> within the table with an identifier of <replaceable>tableId</replaceable>. Alternatively, if the current component is contained within the table, use <code><varname>render</varname>=<replaceable>rowId</replaceable></code>. + </para> + <para> + Instead of a specific identifier, the <replaceable>tableId</replaceable> of <replaceable>rowId</replaceable> references could be variables: <code><varname>render</varname>=<replaceable>tableId</replaceable>:#{<replaceable>bean.rowToUpdate</replaceable>}</code>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code><varname>render</varname>=<replaceable>tableId</replaceable>:<replaceable>rowId</replaceable>:<replaceable>cellId</replaceable></code></term> + <listitem> + <para> + Update the cell with an identifier of <replaceable>cellId</replaceable>, within the row with and identifier of <replaceable>rowId</replaceable>, within the table with an identifier of <replaceable>tableId</replaceable>. + </para> + <para> + Instead of a specific identifier, any of the references could be variables: <code><varname>render</varname>=<replaceable>tableId</replaceable>:#{<replaceable>bean.rowToUpdate</replaceable>}:<replaceable>cellId</replaceable></code>. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Alternatively, keywords can be used with the <varname>render</varname> attribute: + </para> + <variablelist> + <varlistentry> + <term><code><varname>render</varname>=@column</code></term> + <listitem> + <para> + Update the column that contains the current component. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code><varname>render</varname>=@row</code></term> + <listitem> + <para> + Update the row that contains the current component. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code><varname>render</varname>=<replaceable>tableId</replaceable>:@body</code></term> + <listitem> + <para> + Update the body of the table with the identifier of <replaceable>tableId</replaceable>. Alternatively, if the current component is contained within the table, use <code><varname>render</varname>=@body</code> instead. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code><varname>render</varname>=<replaceable>tableId</replaceable>:@header</code></term> + <listitem> + <para> + Update the header of the table with the identifier of <replaceable>tableId</replaceable>. Alternatively, if the current component is contained within the table, use <code><varname>render</varname>=@header</code> instead. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code><varname>render</varname>=<replaceable>tableId</replaceable>:@footer</code></term> + <listitem> + <para> + Update the footer of the table with the identifier of <replaceable>tableId</replaceable>. Alternatively, if the current component is contained within the table, use <code><varname>render</varname>=@footer</code> instead. + </para> + </listitem> + </varlistentry> + </variablelist> </section> - --> <section id="sect-Component_Reference-a4jrepeat-Reference_data"> <title>Reference data</title> @@ -396,6 +467,9 @@ <para> The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component is used to arrange data objects in a grid. Values in the grid can be updated dynamically from the data model, and Ajax updates can be limited to specific rows. The component supports <literal>header</literal>, <literal>footer</literal>, and <literal>caption</literal> facets. </para> + <para> + The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component is similar in function to the JavaServer Faces <sgmltag>&lt;h:panelGrid&gt;</sgmltag> component. However, the <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component additionally allows iteration through the data model rather than just aligning child components in a grid layout. + </para> <figure id="figu-Component_Reference-richdataGrid-The_richdataGrid_component"> <title>The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component</title> <mediaobject> @@ -455,12 +529,8 @@ <section id="sect-Component_Reference-richdataGrid-Patial_updates"> <title>Patial updates</title> <para> - As the component is based on the <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component, it can be partially updated with Ajax. The <varname>ajaxKeys</varname> attribute allows row keys to be defined, which are updated after an Ajax request. + As <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> the component is based on the <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component, it can be partially updated with Ajax. Refer to <xref linkend="sect-Component_Reference-a4jrepeat-Limited_views_and_partial_updates" /> for details on partially updating the <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component. </para> - <example id="exam-Component_Reference-richdataGrid-ajaxKeys_example"> - <title><varname>ajaxKeys</varname> example</title> - <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richdataGrid-ajaxKeys_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </example> </section> <section id="sect-Component_Reference-richdataGrid-Reference_data"> @@ -586,7 +656,7 @@ <section id="sect-Component_Reference-richdataTable-Partial_updates"> <title>Partial updates</title> <para> - The <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component is based on the <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component, and as such it can be partially updated using Ajax. The <varname>ajaxKeys</varname> attribute defines the rows to be updated during an Ajax request. + As <sgmltag>&lt;rich:dataTable&gt;</sgmltag> the component is based on the <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component, it can be partially updated with Ajax. Refer to <xref linkend="sect-Component_Reference-a4jrepeat-Limited_views_and_partial_updates" /> for details on partially updating the <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component. </para> </section> @@ -951,7 +1021,7 @@ </variablelist> </section> - <!-- TODO + <!-- <section id="sect-Component_Reference-richlist-Bullet_point_type"> <title>Bullet point type</title> <para> @@ -986,153 +1056,7 @@ </section> --> - <section id="sect-Component_Reference-richlist-Customizing_the_list"> - <title>Customizing the list</title> - <para> - The <varname>first</varname> attribute specifies which item in the data model to start from, and the <varname>rows</varname> attribute specifies the number of items to list. The <varname>title</varname> attribute is used for a floating tool-tip. <xref linkend="exam-Component_Reference-richlist-richlist_example" /> shows a simple example using the <sgmltag>&lt;rich:dataList&gt;</sgmltag> component. - </para> - <example id="exam-Component_Reference-richlist-richlist_example"> - <title><sgmltag>&lt;rich:list&gt;</sgmltag> example</title> - <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-richdataList-richdataList_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <blockquote> - <figure id="figu-Component_Reference-richlist-richlist_example"> - <title><sgmltag>&lt;rich:list&gt;</sgmltag> example</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richdataList-richdataList_example.png" format="PNG" /> - </imageobject> - <textobject> - <para> - A list of cars displayed in a list with bullet points. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> - </example> - </section> - - <section id="sect-Component_Reference-richlist-Reference_data"> - <title>Reference data</title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.richfaces.List</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlList</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.richfaces.List</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.ListRenderer</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ListTag</classname> - </para> - </listitem> - </itemizedlist> - </section> - </section> - - <!--<rich:dataDefinitionList>--> - <!-- TODO - <section id="sect-Component_Reference-Tables_and_grids-richdataDefinitionList"> - <title><sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag></title> - <para> - The <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> component renders a list of items with definitions. The component uses a data model for managing the list items, which can be updated dynamically. - </para> - - <section id="sect-Component_Reference-richdataDefinitionList-Basic_usage"> - <title>Basic usage</title> - <para> - The <varname>var</varname> attribute names a variable for iterating through the items in the data model. The items to iterate through are determined with the <varname>value</varname> attribute by using EL (Expression Lanugage). - </para> - </section> - - <section id="sect-Component_Reference-richdataDefinitionList-Customizing_the_list"> - <title>Customizing the list</title> - <para> - The <varname>first</varname> attribute specifies which item in the data model to start from, and the <varname>rows</varname> attribute specifies the number of items to list. The <varname>title</varname> attribute is used for a floating tool-tip. <xref linkend="exam-Component_Reference-richdataDefinitionList-richdataDefinitionList_example" /> shows a simple example using the <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> component. - </para> - <example id="exam-Component_Reference-richdataDefinitionList-richdataDefinitionList_example"> - <title><sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> example</title> - <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-richdataDefinitionList_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <blockquote> - <figure id="figu-Component_Reference-richdataDefinitionList_example-richdataDefinitionList_example"> - <title><sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> example</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-richdataDefinitionList_example.png" format="PNG" /> - </imageobject> - <textobject> - <para> - A list of cars with their price and mileage displayed as a data definition. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> - </example> - </section> - - <section id="sect-Component_Reference-richdataDefinitionList-Reference_data"> - <title>Reference data</title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.richfaces.DataDefinitionList</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlDataDefinitionList</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.richfaces.DataDefinitionList</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.DataDefinitionListRenderer</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.DataDefinitionListTag</classname> - </para> - </listitem> - </itemizedlist> - </section> - </section> - --> - - <!--<rich:dataOrderedList>--> - <!-- TODO - <section id="sect-Component_Reference-Tables_and_grids-richdataOrderedList"> - <title><sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag></title> - <para> - The <sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag> component renders an ordered list of items from a data model. Specific rows can be updated dynamically without updating the entire list. - </para> - - <section id="sect-Component_Reference-richdataOrderedList-Basic_usage"> - <title>Basic usage</title> - <para> - The <varname>var</varname> attribute names a variable for iterating through the items in the data model. The items to iterate through are determined with the <varname>value</varname> attribute by using EL (Expression Lanugage). - </para> - </section> - + <!-- <section id="sect-Component_Reference-richdataOrderedList-Numeration_type"> <title>Numeration type</title> <para> @@ -1181,25 +1105,33 @@ </varlistentry> </variablelist> </section> + --> - <section id="sect-Component_Reference-richdataOrderedList-Customizing_the_list"> + <section id="sect-Component_Reference-richlist-Bullet_and_numeration_appearance"> + <title>Bullet and numeration appearance</title> + <para> + The appearance of bullet points for unordered lists or numeration for ordered lists can be customized through CSS, using the <property>list-style-type</property> property. + </para> + </section> + + <section id="sect-Component_Reference-richlist-Customizing_the_list"> <title>Customizing the list</title> <para> - The <varname>first</varname> attribute specifies which item in the data model to start from, and the <varname>rows</varname> attribute specifies the number of items to list. The <varname>title</varname> attribute defines a pop-up title. To only update a sub-set of the rows in the list, use the <varname>ajaxKeys</varname> attribute, which points to an object that contains the specified rows. + The <varname>first</varname> attribute specifies which item in the data model to start from, and the <varname>rows</varname> attribute specifies the number of items to list. The <varname>title</varname> attribute is used for a floating tool-tip. <xref linkend="exam-Component_Reference-richlist-richlist_example" /> shows a simple example using the <sgmltag>&lt;rich:dataList&gt;</sgmltag> component. </para> - <example id="exam-Component_Reference-richdataOrderedList-richdataOrderedList_example"> - <title><sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag> example</title> - <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-richdataOrderedList_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <example id="exam-Component_Reference-richlist-richlist_example"> + <title><sgmltag>&lt;rich:list&gt;</sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-richdataList-richdataList_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <blockquote> - <figure id="figu-Component_Reference-richdataOrderedList_example-richdataOrderedList_example"> - <title><sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag> example</title> + <figure id="figu-Component_Reference-richlist-richlist_example"> + <title><sgmltag>&lt;rich:list&gt;</sgmltag> example</title> <mediaobject> <imageobject> - <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-richdataOrderedList_example.png" format="PNG" /> + <imagedata fileref="images/figu-Component_Reference-richdataList-richdataList_example.png" format="PNG" /> </imageobject> <textobject> <para> - A list of cars displayed in a numbered list. + A list of cars displayed in a list with bullet points. </para> </textobject> </mediaobject> @@ -1208,38 +1140,37 @@ </example> </section> - <section id="sect-Component_Reference-richdataOrderedList-Reference_data"> + <section id="sect-Component_Reference-richlist-Reference_data"> <title>Reference data</title> <itemizedlist> <listitem> <para> - <parameter>component-type</parameter>: <classname>org.richfaces.DataOrderedList</classname> + <parameter>component-type</parameter>: <classname>org.richfaces.List</classname> </para> </listitem> <listitem> <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlDataOrderedList</classname> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlList</classname> </para> </listitem> <listitem> <para> - <parameter>component-family</parameter>: <classname>org.richfaces.DataOrderedList</classname> + <parameter>component-family</parameter>: <classname>org.richfaces.List</classname> </para> </listitem> <listitem> <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.DataOrderedListRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.richfaces.ListRenderer</classname> </para> </listitem> <listitem> <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.DataOrderedListTag</classname> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ListTag</classname> </para> </listitem> </itemizedlist> </section> </section> - --> <section id="sect-Component_Reference-Tables_and_grids-Table_filtering"> <title>Table filtering</title> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocomplete-Defining_suggestion_values.xml_sample =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocomplete-Defining_suggestion_values.xml_sample 2010-09-29 01:26:56 UTC (rev 19361) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocomplete-Defining_suggestion_values.xml_sample 2010-09-29 01:32:39 UTC (rev 19362) @@ -1 +1 @@ -<rich:autocomplete value="#{bean.state}" autocompleteList="#{bean.suggestions}" /> +<rich:autocomplete value="#{bean.state}" autocompleteMethod="#{bean.suggestions}" /> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values.xml_sample (from rev 19352, modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values.xml_sample 2010-09-29 01:32:39 UTC (rev 19362) @@ -0,0 +1,3 @@ +<h:inputText> + <rich:autocomplete value="#{bean.state}" autocompleteMethod="#{bean.suggestions}" /> +</h:inputText> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richcollapsiblePanel-richcollapsiblePanel.png (from rev 19352, modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richcollapsiblePanel-richcollapsiblePanel.png) =================================================================== (Binary files differ) Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richinplaceSelect-richinplaceSelect.png (from rev 19352, modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richinplaceSelect-richinplaceSelect.png) =================================================================== (Binary files differ) Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richinputNumberSlider-richinputNumberSlider.png (from rev 19352, modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richinputNumberSlider-richinputNumberSlider.png) =================================================================== (Binary files differ) Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richinputNumberSpinner-richinputNumberSpinner.png (from rev 19352, modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richinputNumberSpinner-richinputNumberSpinner.png) =================================================================== (Binary files differ) Modified: modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml =================================================================== --- modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml 2010-09-29 01:26:56 UTC (rev 19361) +++ modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml 2010-09-29 01:32:39 UTC (rev 19362) @@ -4,12 +4,12 @@ <chapter id="chap-Migration_Guide-Changes_and_new_features"> <title>Changes and new features</title> <para> - There have been several changes made to the RichFaces framework for version &VERSION; that may affect migrated projects. + There have been several changes made to the RichFaces framework for version 4 that may affect migrated projects. </para> <section id="sect-Migration_Guide-Changes_and_new_features-JSF_2_integration"> <title>JSF 2 integration</title> <para> - RichFaces &VERSION; has full support for JavaServer Faces (<acronym>JSF</acronym>) 2. Due to limited support for JavaServer Pages (JSP) in JSF2, RichFaces no longer fully supports JSP either. + RichFaces 4 has full support for JavaServer Faces (<acronym>JSF</acronym>) 2. Due to limited support for JavaServer Pages (JSP) in JSF2, RichFaces no longer fully supports JSP either. </para> </section> @@ -25,7 +25,7 @@ <term><varname>process</varname></term> <listitem> <para> - Changed to <varname>execute</varname> in &VERSION;. + Changed to <varname>execute</varname> in 4. </para> <variablelist> <varlistentry> @@ -115,7 +115,7 @@ <term><varname>reRender</varname></term> <listitem> <para> - Changed to <varname>render</varname> in &VERSION;. + Changed to <varname>render</varname> in 4. </para> <variablelist> <varlistentry> @@ -211,7 +211,7 @@ <term><varname>eventsQueue</varname></term> <listitem> <para> - Changed to <varname>queue</varname> in &VERSION;. + Changed to <varname>queue</varname> in 4. </para> <variablelist> <varlistentry> @@ -304,7 +304,7 @@ <term><varname>limitToList</varname></term> <listitem> <para> - Changed to <varname>limitRender</varname> in &VERSION;. + Changed to <varname>limitRender</varname> in 4. </para> <variablelist> <varlistentry> @@ -400,7 +400,7 @@ <term><varname>onbeforedomupdate</varname></term> <listitem> <para> - Changed to <varname>onsuccess</varname> in &VERSION;. + Changed to <varname>onsuccess</varname> in 4. </para> <variablelist> <varlistentry> @@ -458,7 +458,7 @@ <term><varname>ignoreDupResponses</varname></term> <listitem> <para> - Deprecated. Functionality moved to <varname>queue</varname> in &VERSION;. + Deprecated. Functionality moved to <varname>queue</varname> in 4. </para> <variablelist> <varlistentry> @@ -557,7 +557,7 @@ <term><varname>requestDelay</varname></term> <listitem> <para> - Deprecated. Functionality moved to <varname>queue</varname> in &VERSION;. + Deprecated. Functionality moved to <varname>queue</varname> in 4. </para> <variablelist> <varlistentry> @@ -638,7 +638,7 @@ <term><varname>ajaxSingle</varname></term> <listitem> <para> - Deprecated. Use <code>execute="@this"</code> in &VERSION; instead. + Deprecated. Use <code>execute="@this"</code> in 4 instead. </para> <variablelist> <varlistentry> @@ -779,7 +779,7 @@ <section id="sect-Migration_Guide-Changes_and_new_features-Feature_changes"> <title>Feature changes</title> <para> - Features have been altered or added to existing components and behaviors in the <productname>RichFaces</productname> &VERSION; framework. Refer to the <citetitle>Developer Guide</citetitle> for full details on how to make use of any new features. + Features have been altered or added to existing components and behaviors in the <productname>RichFaces</productname> 4 framework. Refer to the <citetitle>Developer Guide</citetitle> for full details on how to make use of any new features. </para> <section id="sect-Migration_Guide-Feature_changes-Server_side_process_and_render_mechanisms"> <title>Server-side process and render mechanisms</title> @@ -943,7 +943,7 @@ <section id="sect-Migration_Guide-Changes_and_new_features-Consolidated_or_renamed_components"> <title>Consolidated or renamed components</title> <para> - Several new components and behaviors have been added to <productname>RichFaces</productname> &VERSION;, some of which replace the functionality of deprecated elements. For full details on how to use these new components and behaviors, refer to the <citetitle>Component Reference</citetitle>. + Several new components and behaviors have been added to <productname>RichFaces</productname> 4, some of which replace the functionality of deprecated elements. For full details on how to use these new components and behaviors, refer to the <citetitle>Component Reference</citetitle>. </para> <section id="sect-Migration_Guide-Consolidated_or_renamed_components-richautocomplete"> @@ -960,6 +960,13 @@ </para> </section> + <section id="sect-Migration_Guide-Consolidated_or_renamed_components-richcollapsiblePanel"> + <title><sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag></title> + <para> + The <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component replaces the old <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> component. + </para> + </section> + <section id="sect-Migration_Guide-Consolidated_or_renamed_components-richextendedDataTable"> <title><sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag></title> <para> @@ -967,6 +974,19 @@ </para> </section> + <section id="sect-Component_Reference-Consolidated_or_renamed_components-richlist"> + <title><sgmltag>&lt;rich:list&gt;</sgmltag></title> + <para> + The <sgmltag>&lt;rich:list&gt;</sgmltag> component now combines the functionality of the old <sgmltag>&lt;rich:dataList&gt;</sgmltag>, <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag>, and <sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag> components. + </para> + <note> + <title>List styles</title> + <para> + Previously, the bullet styles for the <sgmltag>&lt;rich:dataList&gt;</sgmltag> component and the numeration styles for the <sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag> component were specified with the <varname>type</varname> attribute. The <varname>type</varname> attribute for the <sgmltag>&lt;rich:list&gt;</sgmltag> component is now used to specify the type of list, and the bullet and numeration styles are now handled in CSS. Refer to the <sgmltag>&lt;rich:list&gt;</sgmltag> component section in the <citetitle>RichFaces Component Reference</citetitle> for details. + </para> + </note> + </section> + <section id="sect-Migration_Guide-Consolidated_or_renamed_components-richpopupPanel"> <title><sgmltag>&lt;rich:popupPanel&gt;</sgmltag></title> <para> @@ -986,7 +1006,7 @@ <section id="sect-Migration_Guide-Changes_and_new_features-New_components_and_behaviors"> <title>New components and behaviors</title> <para> - Several new components and behaviors have been added to <productname>RichFaces</productname> &VERSION;, some of which replace the functionality of deprecated elements. For full details on how to use these new components and behaviors, refer to the <citetitle>Developer Guide</citetitle>. + Several new components and behaviors have been added to <productname>RichFaces</productname> 4, some of which replace the functionality of deprecated elements. For full details on how to use these new components and behaviors, refer to the <citetitle>Developer Guide</citetitle>. </para> <section id="sect-Migration_Guide-New_components_and_behaviors-richbusyBehavior"> @@ -1007,13 +1027,13 @@ <section id="sect-Migration_Guide-Changes_and_new_features-Deprecated_components_and_behaviors"> <title>Deprecated components and behaviors</title> <para> - Some components and behaviors have been deprecated in <productname>RichFaces</productname> &VERSION;. For the most part these items have their functionality replicated by another component or behavior. Refer to <xref linkend="sect-Migration_Guide-Changes_and_new_features-Consolidated_or_renamed_components" /> for further details on consolidated functionality. + Some components and behaviors have been deprecated in <productname>RichFaces</productname> 4. For the most part these items have their functionality replicated by another component or behavior. Refer to <xref linkend="sect-Migration_Guide-Changes_and_new_features-Consolidated_or_renamed_components" /> for further details on consolidated functionality. </para> <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-a4jpage"> <title><sgmltag>&lt;a4j:page&gt;</sgmltag></title> <para> - <productname>RichFaces</productname> &VERSION; drops support for the <sgmltag>&lt;a4j:page&gt;</sgmltag> component. The component was previously used for solving incompatibility in the JavaServer Pages (<acronym>JSP</acronym>) environment with Apache MyFaces in early Ajax4jsf versions. + <productname>RichFaces</productname> 4 drops support for the <sgmltag>&lt;a4j:page&gt;</sgmltag> component. The component was previously used for solving incompatibility in the JavaServer Pages (<acronym>JSP</acronym>) environment with Apache MyFaces in early Ajax4jsf versions. </para> </section> @@ -1024,6 +1044,13 @@ </para> </section> + <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-richdataList_richdataDefinitionList_and_richdataOrderedList"> + <title><sgmltag>&lt;rich:dataList&gt;</sgmltag>, <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag>, and <sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag></title> + <para> + The functionality of the old <sgmltag>&lt;rich:dataList&gt;</sgmltag>, <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag>, and <sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag> components is now available through the <sgmltag>&lt;rich:list&gt;</sgmltag> component. + </para> + </section> + <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-richmodalPanel"> <title><sgmltag>&lt;rich:modalPanel&gt;</sgmltag></title> <para> @@ -1045,6 +1072,13 @@ </para> </section> + <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-richsimpleTogglePanel"> + <title><sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag></title> + <para> + The functionality of the old <sgmltag>&lt;rich:simpleTogglePanel&gt;</sgmltag> component is now available through the <sgmltag>&lt;rich:collapsiblePanel&gt;</sgmltag> component. + </para> + </section> + </section> </chapter>