Author: SeanRogers Date: 2010-07-12 23:26:13 -0400 (Mon, 12 Jul 2010) New Revision: 17995 Added: root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richdataDefinitionList_example.xml_sample root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richdataTable_example.xml_sample root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richextendedDataTable_example.xml_sample root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-Column_menu.png root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-Dragging_columns.png root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-Grouping_table_entries_by_column.png root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-Hiding_columns.png root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-Selecting_multiple_rows.png root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-richdataDefinitionList_example.png root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-richextendedDataTable_example.png root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richdataTable_example.png Removed: root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Trees-richdataDefinitionList_example.xml_sample Modified: root/docs/trunk/Component_Reference/src/main/docbook/en-US/Book_Info.xml root/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml root/docs/trunk/Component_Reference/src/main/docbook/en-US/Preface.xml root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Common_Ajax_attributes.xml root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Output_and_messages.xml root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml root/docs/trunk/parent/pom.xml Log: Updated rich:dataTable and rich:extendedDataTable Modified: root/docs/trunk/Component_Reference/src/main/docbook/en-US/Book_Info.xml =================================================================== --- root/docs/trunk/Component_Reference/src/main/docbook/en-US/Book_Info.xml 2010-07-13 01:26:22 UTC (rev 17994) +++ root/docs/trunk/Component_Reference/src/main/docbook/en-US/Book_Info.xml 2010-07-13 03:26:13 UTC (rev 17995) @@ -28,7 +28,7 @@ <year>&YEAR;</year> <holder>&HOLDER;</holder> </copyright> - <!-- FOR PUBLICAN --><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR JDOCBOOK: --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <!-- FOR PUBLICAN --><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR JDOCBOOK: --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </xi:fallback> </xi:include> <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> Modified: root/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml =================================================================== --- root/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml 2010-07-13 01:26:22 UTC (rev 17994) +++ root/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml 2010-07-13 03:26:13 UTC (rev 17995) @@ -3,10 +3,9 @@ ]> <book status="draft"> <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!-- + <!-- <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - --> - <xi:include href="chap-Component_Reference-Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + --><xi:include href="chap-Component_Reference-Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Common_Ajax_attributes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Common_features.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <part id="part-Component_Reference-a4j_tag_library"> @@ -14,36 +13,28 @@ <xi:include href="chap-Component_Reference-Actions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Containers.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!-- FIXME NOT IN A2 --> - <!-- <xi:include href="chap-Component_Reference-Validation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - --> <xi:include href="chap-Component_Reference-Processing_management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </part> <part id="part-Component_Reference-rich_tag_library"> <title>rich tag library</title> - <!-- + <!-- <xi:include href="chap-Component_Reference-Rich_inputs.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Panels_and_containers.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - --> - <xi:include href="chap-Component_Reference-Tables_and_grids.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!-- + --><xi:include href="chap-Component_Reference-Tables_and_grids.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <!-- <xi:include href="chap-Component_Reference-Trees.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Menus_and_toolbars.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - --> - <!-- FIXME NOT IN A2 --> - <!-- <xi:include href="chap-Component_Reference-Output_and_messages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Drag_and_drop.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Layout_and_appearance.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - --> - <xi:include href="chap-Component_Reference-Functions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!-- + --><xi:include href="chap-Component_Reference-Functions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <!-- <xi:include href="chap-Component_Reference-Functionality_extension.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - --> + --> </part> - <!-- + <!-- <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - --> + --> </book> Modified: root/docs/trunk/Component_Reference/src/main/docbook/en-US/Preface.xml =================================================================== --- root/docs/trunk/Component_Reference/src/main/docbook/en-US/Preface.xml 2010-07-13 01:26:22 UTC (rev 17994) +++ root/docs/trunk/Component_Reference/src/main/docbook/en-US/Preface.xml 2010-07-13 03:26:13 UTC (rev 17995) @@ -3,10 +3,10 @@ ]> <preface id="pref-Component_Reference-Preface"> <title>Preface</title> - <!-- FOR JDOCBOOK --><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR PUBLICAN --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <!-- FOR JDOCBOOK --><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR PUBLICAN --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </xi:fallback> </xi:include> - <!-- PUBLICAN'S ORIGINAL XINCLUDES --><xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR JDOCBOOK --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <!-- PUBLICAN'S ORIGINAL XINCLUDES --><xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><!-- FOR JDOCBOOK --><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="fallback_content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </xi:fallback> </xi:include> </xi:fallback> Modified: root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml =================================================================== --- root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml 2010-07-13 01:26:22 UTC (rev 17994) +++ root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml 2010-07-13 03:26:13 UTC (rev 17995) @@ -73,8 +73,8 @@ Variables from JavaScript functions can be used for the <varname>value</varname> attribute. In such an implementation, the <varname>noEscape</varname> attribute should be set to <literal>true</literal>. Using <code>noEscape="true"</code>, the <varname>value</varname> attribute can contain any JavaScript expression or JavaScript function invocation, and the result will be sent to the server as the <varname>value</varname> attribute. </para> </section> - - <!-- TODO NOT IN A2 --> + + <!-- TODO NOT IN A2 --> <section id="sect-Component_Reference-Actions-a4jajaxListener"> <title><sgmltag>&lt;a4j:ajaxListener&gt;</sgmltag></title> <itemizedlist> @@ -201,8 +201,8 @@ </para> </section> - <!-- FIXME this is really rich:componentControl --> - <section id="sect-Component_Reference-Actions-a4jcomponentControl"> + <!-- FIXME this is really rich:componentControl --> + <section id="sect-Component_Reference-Actions-richcomponentControl"> <title><sgmltag>&lt;rich:componentControl&gt;</sgmltag></title> <remark>The following reference data is taken from the old <sgmltag>&lt;rich:componentControl&gt;</sgmltag> reference. The details may be different now that the component is part of the <classname>a4j</classname> tag library.</remark> <itemizedlist> @@ -238,7 +238,7 @@ <para> The <varname>event</varname>, <varname>for</varname>, and <varname>operation</varname> attributes are all that is required to attach JavaScript functions to the parent component. The <varname>event</varname> attribute specifies the event that triggers the JavaScript API function call. The <varname>for</varname> attribute defines the target component, and the <varname>operation</varname> attribute specifies the JavaScript function to perform. </para> - <example id="exam-Component_Reference-a4jcomponentControl-a4jcomponentControl_basic_usage"> + <example id="exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage"> <title>rich:componentControl basic usage</title> <programlisting language="XML" role="XML">&lt;h:commandButton value="Show Modal Panel"&gt; @@ -251,9 +251,9 @@ </para> </example> <para> - The <varname>attachTo</varname> attribute can be used to attach the event to a component other than the parent component. If no <varname>attachTo</varname> attribute is supplied, the <sgmltag>&lt;rich:componentControl&gt;</sgmltag> component's parent is used, as in <xref linkend="exam-Component_Reference-a4jcomponentControl-a4jcomponentControl_basic_usage" />. + The <varname>attachTo</varname> attribute can be used to attach the event to a component other than the parent component. If no <varname>attachTo</varname> attribute is supplied, the <sgmltag>&lt;rich:componentControl&gt;</sgmltag> component's parent is used, as in <xref linkend="exam-Component_Reference-richcomponentControl-richcomponentControl_basic_usage" />. </para> - <example id="exam-Component_Reference-a4jcomponentControl-Attaching_a4jcomponentControl_to_a_component"> + <example id="exam-Component_Reference-richcomponentControl-Attaching_richcomponentControl_to_a_component"> <title>Attaching <sgmltag>&lt;rich:componentControl&gt;</sgmltag> to a component</title> <programlisting language="XML" role="XML">&lt;rich:componentControl attachTo="doExpandCalendarID" event="onclick" operation="Expand" for="ccCalendarID" /&gt; @@ -265,7 +265,7 @@ <para> The operation can receive parameters either through the <varname>params</varname> attribute, or by using <sgmltag>&lt;f:param&gt;</sgmltag> elements. </para> - <example id="exam-Component_Reference-a4jcomponentControl-Using_parameters"> + <example id="exam-Component_Reference-richcomponentControl-Using_parameters"> <title>Using parameters</title> <variablelist> <varlistentry> @@ -328,7 +328,7 @@ Incomplete </para> </section> - + <section id="sect-Component_Reference-Actions-a4jhtmlCommandLink"> <title><sgmltag>&lt;a4j:htmlCommandLink&gt;</sgmltag></title> <itemizedlist> @@ -479,7 +479,7 @@ </para> </section> - <section id="sect-Component_Reference-Tables_and_grids-a4jrepeat"> + <section id="sect-Component_Reference-Actions-a4jrepeat"> <title><sgmltag>&lt;a4j:repeat&gt;</sgmltag></title> <itemizedlist> <listitem> @@ -503,16 +503,18 @@ </para> </listitem> </itemizedlist> - <!-- FIXME Move a4j:repeat --> + <!-- FIXME Move a4j:repeat --> <para> - REVIEW COMMENT - a4j:repeat is not an action, should be moved. The <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component is used to iterate changes through a repeated collection of components. It allows specific rows of items to be updated without sending Ajax requests for the entire collection. The <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component forms the basis for many of the tabular components detailed in <xref linkend="chap-Component_Reference-Tables_and_grids" />. + REVIEW COMMENT - a4j:repeat is not an action, should be moved. The <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component is used to iterate changes through a repeated collection of components. It allows specific rows of items to be updated without sending Ajax requests for the entire collection. The <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component forms the basis for many of the tabular components detailed in <xref linkend="chap-Component_Reference-Tables_and_grids" />. </para> <para> - The contents of the collection are determined using Expression Language (<acronym>EL</acronym>). The data model for the contents is specified with the <varname>value</varname> attribute. The <varname>var</varname> attribute names the object to use when iterating through the collection. This object is then referenced in the relevant child components. After an Ajax request, only the rows specified with the <varname>ajaxKeys</varname> attribute are updated rather than the entire collection. <xref linkend="exam-Component_Reference-Tables_and_grids-a4jrepeat_example" /> shows how to use <sgmltag>&lt;a4j:repeat&gt;</sgmltag> to maintain a simple table. + The contents of the collection are determined using Expression Language (<acronym>EL</acronym>). The data model for the contents is specified with the <varname>value</varname> attribute. The <varname>var</varname> attribute names the object to use when iterating through the collection. This object is then referenced in the relevant child components. After an Ajax request, only the rows specified with the <varname>ajaxKeys</varname> attribute are updated rather than the entire collection. <xref linkend="exam-Component_Reference-a4jrepeat-a4jrepeat_example" /> shows how to use <sgmltag>&lt;a4j:repeat&gt;</sgmltag> to maintain a simple table. </para> - <example id="exam-Component_Reference-Tables_and_grids-a4jrepeat_example"> + <example id="exam-Component_Reference-a4jrepeat-a4jrepeat_example"> <title><sgmltag>&lt;a4j:repeat&gt;</sgmltag> example</title> - <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-Tables_and_grids-a4jrepeat_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + +<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-a4jrepeat_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</programlisting> <para> Each row of a table contains two cells: one showing the item code, and the other showing the item price. The table is generated by iterating through items in the <code>repeatBeans.items</code> data model. </para> @@ -522,8 +524,8 @@ </para> </section> - <!-- FIXME - a4j:support is now a4j:ajax in 4.0 --> - <section id="sect-Component_Reference-Actions-a4jsupport"> + <!-- FIXME - a4j:support is now a4j:ajax in 4.0 --> + <section id="sect-Component_Reference-Actions-a4jajax"> <title><sgmltag>&lt;a4j:ajax&gt;</sgmltag></title> <itemizedlist> <listitem> @@ -548,7 +550,7 @@ </listitem> </itemizedlist> <para> - REVIEW COMMENT: a4j:support is a4j:ajax in 4.0, paths need to be updated. The <sgmltag>&lt;a4j:ajax&gt;</sgmltag> component allows Ajax capability to be added to any non-Ajax component. It is placed as a direct child to the component that requires Ajax support. The <sgmltag>&lt;a4j:ajax&gt;</sgmltag> component uses the common attributes listed in <xref linkend="chap-Component_Reference-Common_Ajax_attributes" />. + REVIEW COMMENT: a4j:support is a4j:ajax in 4.0, paths need to be updated. The <sgmltag>&lt;a4j:ajax&gt;</sgmltag> component allows Ajax capability to be added to any non-Ajax component. It is placed as a direct child to the component that requires Ajax support. The <sgmltag>&lt;a4j:ajax&gt;</sgmltag> component uses the common attributes listed in <xref linkend="chap-Component_Reference-Common_Ajax_attributes" />. </para> <note> <title>Attaching JavaScript functions</title> @@ -556,7 +558,7 @@ When attaching the <sgmltag>&lt;a4j:ajax&gt;</sgmltag> component to non-Ajax JavaServer Faces command components, such as <sgmltag>&lt;h:commandButton&gt;</sgmltag> and <sgmltag>&lt;h:commandLink&gt;</sgmltag>, it is important to set <code>disabledDefault="true"</code>. If this attribute is not set, a non-Ajax request is sent after the Ajax request and the page is refreshed unexpectedly. </para> </note> - <example id="exam-Component_Reference-a4jsupport-a4jsupport_example"> + <example id="exam-Component_Reference-a4jajax-a4jajax_example"> <title><sgmltag>&lt;a4j:ajax&gt;</sgmltag> example</title> <programlisting language="XML" role="XML">&lt;h:panelGrid columns="2"&gt; Modified: root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Common_Ajax_attributes.xml =================================================================== --- root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Common_Ajax_attributes.xml 2010-07-13 01:26:22 UTC (rev 17994) +++ root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Common_Ajax_attributes.xml 2010-07-13 03:26:13 UTC (rev 17995) @@ -123,7 +123,7 @@ <para> RichFaces uses a form-based approach for sending Ajax requests. As such, each time a request is sent the data from the requesting component's parent <acronym>JSF</acronym> form is submitted along with the <acronym>XMLHTTPRequest</acronym> object. The form data contains values from the input element and auxiliary information such as state-saving data. </para> - <section id="sect-Component_Reference-Data_processing-process"> + <section id="sect-Component_Reference-Data_processing-execute"> <title><varname>execute</varname></title> <para> The <varname>execute</varname> attribute allows <acronym>JSF</acronym> processing to be limited to defined components. To only process the requesting component, <code>execute="@this"</code> can be used. Modified: root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml =================================================================== --- root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml 2010-07-13 01:26:22 UTC (rev 17994) +++ root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml 2010-07-13 03:26:13 UTC (rev 17995) @@ -6,7 +6,7 @@ <para> This chapter details those components in the <classname>a4j</classname> tag library which define an area used as a container or wrapper for other components. </para> -<!-- FIXME NOT IN A2 --> + <!-- FIXME NOT IN A2 --> <section id="sect-Component_Reference-Containers-a4jform"> <title><sgmltag>&lt;a4j:form&gt;</sgmltag></title> <itemizedlist> @@ -162,7 +162,7 @@ </para> </section> -<!-- FIXME NOT IN A2 --> + <!-- FIXME NOT IN A2 --> <section id="sect-Component_Reference-Containers-a4jpage"> <title><sgmltag>&lt;a4j:page&gt;</sgmltag></title> <itemizedlist> Modified: root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml =================================================================== --- root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml 2010-07-13 01:26:22 UTC (rev 17994) +++ root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml 2010-07-13 03:26:13 UTC (rev 17995) @@ -118,7 +118,7 @@ If the <code>mode</code> is unspecified, the submission behavior for the item is inherited from the parent <classname>&lt;rich:panelMenu&gt;</classname>. Otherwise, the <code>mode</code> setting is used instead of the parent's behavior. </para> <para> - Icons for menu items can be chosen from a set of standard icons. There are two attributes that relate to the different menu states that the icon represents: <code>icon</code> and <code>iconDisabled</code>. The standard icons are shown in <xref linkend="figu-Component_Reference-richcolumn-Basic_column_example" />. + Icons for menu items can be chosen from a set of standard icons. There are two attributes that relate to the different menu states that the icon represents: <code>icon</code> and <code>iconDisabled</code>. The standard icons are shown in <xref linkend="figu-Component_Reference-Basic_column_example-Basic_column_example" />. </para> <figure id="figu-Component_Reference-richpanelMenuItem-Standard_icons"> <title>Standard icons</title> Modified: root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Output_and_messages.xml =================================================================== --- root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Output_and_messages.xml 2010-07-13 01:26:22 UTC (rev 17994) +++ root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Output_and_messages.xml 2010-07-13 03:26:13 UTC (rev 17995) @@ -214,7 +214,7 @@ </example> </section> - <!-- + <!-- <section id="sect-Component_Reference-Output_and_messages-richpaint2D"> <title><sgmltag>&lt;rich:paint2D&gt;</sgmltag></title> @@ -237,6 +237,6 @@ </para> </section> - --> + --> </chapter> Modified: root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml =================================================================== --- root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml 2010-07-13 01:26:22 UTC (rev 17994) +++ root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml 2010-07-13 03:26:13 UTC (rev 17995) @@ -6,7 +6,7 @@ <para> This chapter covers those components used to handle and manage resources and beans. </para> -<!-- FIXME NOT IN A2 --> + <!-- FIXME NOT IN A2 --> <section id="sect-Component_Reference-Resources-a4jloadBundle"> <title><sgmltag>&lt;a4j:loadBundle&gt;</sgmltag></title> <itemizedlist> Modified: root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml =================================================================== --- root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-07-13 01:26:22 UTC (rev 17994) +++ root/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-07-13 03:26:13 UTC (rev 17995) @@ -3,6 +3,14 @@ ]> <chapter id="chap-Component_Reference-Tables_and_grids"> <title>Tables and grids</title> + <!-- In development notification --> + <important> + <title>Documentation in development</title> + <para> + Some concepts covered in this chapter may refer to the previous version of <productname>Richfaces</productname> + , version 3.3.3. This chapter is scheduled for review to ensure all information is up to date. + </para> + </important> <para> This chapter covers all components related to the display of tables and grids. </para> @@ -44,8 +52,7 @@ <example id="exam-Component_Reference-richcolumn-Basic_column_example"> <title>Basic column example</title> -<programlisting language="XML" role="XML"> -&lt;rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"&gt; +<programlisting language="XML" role="XML">&lt;rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"&gt; &lt;rich:column&gt; &lt;f:facet name="header"&gt;State Flag&lt;/f:facet&gt; &lt;h:graphicImage value="#{cap.stateFlag}"/&gt; @@ -64,30 +71,29 @@ &lt;/rich:column&gt; &lt;/rich:dataTable&gt; </programlisting> + <blockquote> + <figure id="figu-Component_Reference-Basic_column_example-Basic_column_example"> + <title>Basic column example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richcolumn-Basic_column_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + The result of the basic column example, displaying a table with a header row and four columns. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> </example> - <blockquote> - <figure id="figu-Component_Reference-richcolumn-Basic_column_example"> - <title>Basic column example</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richcolumn-Basic_column_example.png" format="PNG" /> - </imageobject> - <textobject> - <para> - The result of the basic column example, displaying a table with a header row and four columns. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> <para> Columns can be merged by using the <varname>colspan</varname> attribute to specify how many normal columns to span. The <varname>colspan</varname> attribute is used in conjunction with the <varname>breakBefore</varname> attribute on the next column to determine how the merged columns are laid out. <xref linkend="exam-Component_Reference-richcolumn-Column_spanning_example" />. </para> <example id="exam-Component_Reference-richcolumn-Column_spanning_example"> <title>Column spanning example</title> -<programlisting language="XML" role="XML"> -&lt;rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"&gt; +<programlisting language="XML" role="XML">&lt;rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"&gt; &lt;rich:column colspan="3"&gt; &lt;h:graphicImage value="#{cap.stateFlag}"/&gt; &lt;/rich:column&gt; @@ -102,30 +108,29 @@ &lt;/rich:column&gt; &lt;/rich:dataTable&gt; </programlisting> + <blockquote> + <figure id="figu-Component_Reference-Column_spanning_example-Column_spanning_example"> + <title>Column spanning example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richcolumn-Column_spanning_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + The result of the column spanning example, showing the first column (the state flag column) spanning a width of three columns, with the others broken onto the following line. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> </example> - <blockquote> - <figure id="figu-Component_Reference-richcolumn-Column_spanning_example"> - <title>Column spanning example</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richcolumn-Column_spanning_example.png" format="PNG" /> - </imageobject> - <textobject> - <para> - The result of the column spanning example, showing the first column (the state flag column) spanning a width of three columns, with the others broken onto the following line. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> <para> - Similarly, the <varname>rowspan</varname> attribute can be used to merge and span rows. Again the <varname>breakBefore</varname> attribute needs to be used on related <sgmltag>&lt;rich:column&gt;</sgmltag> components to define the layout. <xref linkend="exam-Component_Reference-richcolumn-Row_spanning_example" /> and the resulting <xref linkend="figu-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups" /> show the first column of the table spanning three rows. + Similarly, the <varname>rowspan</varname> attribute can be used to merge and span rows. Again the <varname>breakBefore</varname> attribute needs to be used on related <sgmltag>&lt;rich:column&gt;</sgmltag> components to define the layout. <xref linkend="exam-Component_Reference-richcolumn-Row_spanning_example" /> and the resulting <xref linkend="figu-Component_Reference-Complex_headers_using_column_groups-Complex_headers_using_column_groups" /> show the first column of the table spanning three rows. </para> <example id="exam-Component_Reference-richcolumn-Row_spanning_example"> <title>Row spanning example</title> -<programlisting language="XML" role="XML"> -&lt;rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"&gt; +<programlisting language="XML" role="XML">&lt;rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"&gt; &lt;rich:column rowspan="3"&gt; &lt;f:facet name="header"&gt;State Flag&lt;/f:facet&gt; &lt;h:graphicImage value="#{cap.stateFlag}"/&gt; @@ -142,22 +147,22 @@ &lt;/rich:column&gt; &lt;/rich:dataTable&gt; </programlisting> + <blockquote> + <figure id="figu-Component_Reference-Row_spanning_example-Row_spanning_example"> + <title>Row spanning example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richcolumn-Row_spanning_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + The result of the row spanning example, showing the first column of the table spanning three rows. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> </example> - <blockquote> - <figure id="figu-Component_Reference-richcolumn-Row_spanning_example"> - <title>Row spanning example</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richcolumn-Row_spanning_example.png" format="PNG" /> - </imageobject> - <textobject> - <para> - The result of the row spanning example, showing the first column of the table spanning three rows. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> <para> For details on filtering and sorting columns, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_filtering" /> and <xref linkend="sect-Component_Reference-Tables_and_grids-Table_sorting" />. </para> @@ -196,13 +201,12 @@ The <sgmltag>&lt;rich:columnGroup&gt;</sgmltag> component combines multiple columns in a single row to organize complex parts of a table. The resulting effect is similar to using the <varname>breakBefore</varname> attribute of the <sgmltag>&lt;rich:column&gt;</sgmltag> component, but is clearer and easier to follow in the source code. </para> <para> - The <sgmltag>&lt;rich:columnGroup&gt;</sgmltag> can also be used to create complex headers in a table. <xref linkend="exam-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups" /> and the resulting <xref linkend="figu-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups" /> demonstrate how complex headers can be achieved. + The <sgmltag>&lt;rich:columnGroup&gt;</sgmltag> can also be used to create complex headers in a table. <xref linkend="exam-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups" /> and the resulting <xref linkend="figu-Component_Reference-Complex_headers_using_column_groups-Complex_headers_using_column_groups" /> demonstrate how complex headers can be achieved. </para> <example id="exam-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups"> <title>Complex headers using column groups</title> -<programlisting language="XML" role="XML"> -&lt;rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5" id="sublist"&gt; +<programlisting language="XML" role="XML">&lt;rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5" id="sublist"&gt; &lt;f:facet name="header"&gt; &lt;rich:columnGroup&gt; &lt;rich:column rowspan="2"&gt; @@ -236,24 +240,24 @@ &lt;/rich:column&gt; &lt;/rich:dataTable&gt; </programlisting> + <blockquote> + <figure id="figu-Component_Reference-Complex_headers_using_column_groups-Complex_headers_using_column_groups"> + <title>Complex headers using column groups</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A table with a complex header, where three of the columns are grouped together under a common title. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> </example> - <blockquote> - <figure id="figu-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups"> - <title>Complex headers using column groups</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups.png" format="PNG" /> - </imageobject> - <textobject> - <para> - A table with a complex header, where three of the columns are grouped together under a common title. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> </section> - + <section id="sect-Component_Reference-Tables_and_grids-richcolumns"> <title><sgmltag>&lt;rich:columns&gt;</sgmltag></title> <itemizedlist> @@ -277,8 +281,7 @@ <example id="exam-Component_Reference-richcolumns-Basic_columns_example"> <title>Basic columns example</title> -<programlisting language="XML" role="XML"> -&lt;rich:dataTable value="#{dataTableScrollerBean.model}" var="model" width="750"&gt; +<programlisting language="XML" role="XML">&lt;rich:dataTable value="#{dataTableScrollerBean.model}" var="model" width="750"&gt; &lt;rich:columns value="#{dataTableScrollerBean.columns}" var="columns" index="ind" id="column#{ind}"&gt; &lt;f:facet name="header"&gt; &lt;h:outputText value="#{columns.header}" /&gt; @@ -299,8 +302,7 @@ <example id="exam-Component_Reference-richcolumns-Using_richcolumns_and_richcolumn_together"> <title>Using <sgmltag>&lt;rich:columns&gt;</sgmltag> and <sgmltag>&lt;rich:column&gt;</sgmltag> together</title> -<programlisting language="XML" role="XML"> -&lt;rich:dataTable value="#{dataTableScrollerBean.model}" var="model" width="500px" rows="5"&gt; +<programlisting language="XML" role="XML">&lt;rich:dataTable value="#{dataTableScrollerBean.model}" var="model" width="500px" rows="5"&gt; &lt;f:facet name="header"&gt; &lt;h:outputText value="Cars Available"&gt;&lt;/h:outputText&gt; &lt;/f:facet&gt; @@ -363,23 +365,20 @@ 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> <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). The <varname>first</varname> attribute specifies which item in the data model to show first, 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. + 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). 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-Trees-richdataDefinitionList_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +<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 role="html"> - <imagedata fileref="images/figu-Component_Reference-Trees-richdataDefinitionList_example.png" format="PNG" /> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-richdataDefinitionList_example.png" format="PNG" /> </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/figu-Component_Reference-Trees-richdataDefinitionList_example.png" format="PNG" /> - </imageobject> <textobject> <para> A list of cars with their price and mileage displayed as a data definition. @@ -525,9 +524,11 @@ </figure> </blockquote> </example> + <!-- TODO <para> The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component can be used with the <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> component to display multiple pages of grids. Refer to <xref linkend="sect-Component_Reference-Tables_and_grids-richdataScroller" /> for details on the <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> component. </para> + --> <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. </para> @@ -606,7 +607,7 @@ </varlistentry> </variablelist> <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). The <varname>first</varname> attribute specifies which item in the data model to show first, 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. + 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). 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-richdataList-richdataList_example"> <title><sgmltag>&lt;rich:dataList&gt;</sgmltag> example</title> @@ -709,13 +710,15 @@ </varlistentry> </variablelist> <para> - The <varname>rows</varname> attribute limits the number of items in the list. The <varname>first</varname> attribute specifies the first item to start from when populating the 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 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. </para> - <example id="exam-Component_Reference-Tables_and_grids-richdataOrderedList_example"> + <example id="exam-Component_Reference-richdataOrderedList-richdataOrderedList_example"> <title><sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag> example</title> -<programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-Tables_and_grids-richdataOrderedList_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + +<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> <blockquote> - <figure id="figu-Component_Reference-Tables_and_grids-richdataOrderedList_example"> + <figure id="figu-Component_Reference-richdataOrderedList_example-richdataOrderedList_example"> <title><sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag> example</title> <mediaobject> <imageobject> @@ -732,45 +735,319 @@ </example> </section> + <!-- TODO <section id="sect-Component_Reference-Tables_and_grids-richdataScroller"> <title><sgmltag>&lt;rich:dataScroller&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.richfaces.DataTable</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.richfaces.component.html.HtmlDataTable</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.richfaces.DataTable</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.richfaces.DataTableRenderer</classname> + </para> + </listitem> + <listitem> + <para> + tag-class: <classname>org.richfaces.taglib.DataTableTag</classname> + </para> + </listitem> + </itemizedlist> <para> Incomplete </para> </section> - + --> <section id="sect-Component_Reference-Tables_and_grids-richdataTable"> <title><sgmltag>&lt;rich:dataTable&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.richfaces.DataTable</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.richfaces.component.html.HtmlDataTable</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.richfaces.DataTable</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.richfaces.DataTableRenderer</classname> + </para> + </listitem> + <listitem> + <para> + tag-class: <classname>org.richfaces.taglib.DataTableTag</classname> + </para> + </listitem> + </itemizedlist> <para> - Incomplete + The <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component is used to render a table, including the table's header and footer. It works in conjunction with the <sgmltag>&lt;rich:column&gt;</sgmltag>, <sgmltag>&lt;rich:columnGroup&gt;</sgmltag>, and <sgmltag>&lt;rich:columns&gt;</sgmltag> components to list the contents of a data model. </para> + <note> + <title><sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag></title> + <para> + The <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component does not include extended table features, such as data scrolling, row selection, and column reordering. These features are available as part of the <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component; refer to <xref linkend="sect-Component_Reference-Tables_and_grids-richextendedDataTable" /> for further details. + </para> + </note> + <para> + The <varname>value</varname> attribute points to the data model, and the <varname>var</varname> attribute specifies a variable to use when iterating through the data model. 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 <literal>header</literal>, <literal>footer</literal>, and <literal>caption</literal> facets can be used to display text, and to customize the appearance of the table through skinning. demonstrates a simple table implementation. + </para> + <example id="exam-Component_Reference-richdataTable-richdataTable_example"> + <title><sgmltag>&lt;rich:dataTable&gt;</sgmltag> example</title> + +<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-richdataTable_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</programlisting> + <blockquote> + <figure id="figu-Component_Reference-richdataTable_example-richdataTable_example"> + <title><sgmltag>&lt;rich:dataTable&gt;</sgmltag> example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richdataTable_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A data table made using the <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + <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. + </para> + <para> + For details on filtering and sorting data tables, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_filtering" /> and <xref linkend="sect-Component_Reference-Tables_and_grids-Table_sorting" />. + </para> </section> <section id="sect-Component_Reference-Tables_and_grids-richextendedDataTable"> <title><sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + component-type: <classname>org.richfaces.ExtendedDataTable</classname> + </para> + </listitem> + <listitem> + <para> + component-class: <classname>org.richfaces.component.html.HtmlExtendedDataTable</classname> + </para> + </listitem> + <listitem> + <para> + component-family: <classname>org.richfaces.ExtendedDataTable</classname> + </para> + </listitem> + <listitem> + <para> + renderer-type: <classname>org.richfaces.ExtendedDataTableRenderer</classname> + </para> + </listitem> + <listitem> + <para> + tag-class: <classname>org.richfaces.taglib.ExtendedDataTableTag</classname> + </para> + </listitem> + </itemizedlist> <para> - * Combined with rich:scrollableDataTable + The <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component builds on the functionality of the <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component, adding features such as data scrolling, row and column selection, and rearranging of columns. </para> + <para> + The <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component includes the following attributes not included in the <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component: + </para> + <simplelist columns="3"> + <member><varname>activeClass</varname></member> + <member><varname>activeRowKey</varname></member> + <member><varname>enableContextMenu</varname></member> + <member><varname>groupingColumn</varname></member> + <member><varname>height</varname></member> + <member><varname>noDataLabel</varname></member> + <member><varname>onselectionchange</varname></member> + <member><varname>selectedClass</varname></member> + <member><varname>selection</varname></member> + <member><varname>selectionMode</varname></member> + <member><varname>tableState</varname></member> + </simplelist> + <para> + The <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component does <emphasis>not</emphasis> include the following attributes available with the <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component: + </para> + <itemizedlist> + <listitem> + <para> + <varname>columns</varname> + </para> + </listitem> + <listitem> + <para> + <varname>columnsWidth</varname> + </para> + </listitem> + <listitem> + <para> + <varname>onRowContextMenu</varname> + </para> + </listitem> + </itemizedlist> + <para> + Basic use of the <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component requires the <varname>value</varname> and <varname>var</varname> attributes, the same as with the <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component. Refer to <xref linkend="sect-Component_Reference-Tables_and_grids-richdataTable" /> for details. + </para> + <para> + The <varname>height</varname> attribute is mandatory, and defines the height of the table on the page. This is set to <literal>500px</literal> by default. The width of the table can be set by using the <varname>width</varname> attribute. As with the <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component, the look of the <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component can be customized and skinned using the <literal>header</literal>, <literal>footer</literal>, and <literal>caption</literal> facets. + </para> + <example id="exam-Component_Reference-richextendedDataTable-richextendedDataTable_example"> + <title><sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> example</title> + +<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-richextendedDataTable_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</programlisting> + <blockquote> + <figure id="figu-Component_Reference-richextendedDataTable_example-richextendedDataTable_example"> + <title><sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-richextendedDataTable_example.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + A data table made using the <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component. It features scrolling data, column sorting, and a column filter. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + <para> + <xref linkend="exam-Component_Reference-richextendedDataTable-richextendedDataTable_example" /> shows an example extended data table. The implementation features a scrolling data table, selection of one or more rows, sorting by columns, grouping by column, and a filter on the <guilabel>Name</guilabel> column. + </para> + <para> + Row selection is determined by the <varname>selectionMode</varname> attribute. Setting the attribute to <literal>none</literal> allows for no row selection capability. Setting the <varname>selectionMode</varname> attribute to <literal>single</literal> allows the user to select a single row at a time using the mouse. With the <varname>selectionMode</varname> attribute set to <literal>multi</literal>, the user can select multiple rows by holding down the <keycap function="shift">Shift</keycap> or <keycap function="control">Ctrl</keycap> keys while clicking. The <varname>selection</varname> attribute points to the object that tracks which rows are selected. <xref linkend="figu-Component_Reference-richextendedDataTable-Selecting_multiple_rows" /> shows the table from the example with multiple rows selected. + </para> + <figure id="figu-Component_Reference-richextendedDataTable-Selecting_multiple_rows"> + <title>Selecting multiple rows</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-Selecting_multiple_rows.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + The example table with rows numbered 1, 2, 3, and 5 selected. + </para> + </textobject> + </mediaobject> + </figure> + <para> + The example uses the <literal>filter</literal> facet of the <sgmltag>&lt;rich:column&gt;</sgmltag> component to display the text field. A user can type their criteria into the text field to customize the filter of the column below. For full details on filtering tables, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_filtering" />. + </para> + <para> + When hovering the mouse over a column header, a menu button appears to the right-hand side, as shown in <xref linkend="figu-Component_Reference-richextendedDataTable-Column_menu" />. This menu allows the user to sort the contents of the column, group the table by the column, or hide and show columns. + </para> + <figure id="figu-Component_Reference-richextendedDataTable-Column_menu"> + <title>Column menu</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-Column_menu.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + The menu for sorting, grouping, and hiding or showing columns. + </para> + </textobject> + </mediaobject> + </figure> + <para> + Each column can allow sorting by setting the <sgmltag>&lt;rich:column&gt;</sgmltag> component's <varname>sortable</varname> attribute to <literal>true</literal>. The value of the data model to sort by is specified with the <varname>sortBy</varname> attribute. In addition to using the menu for sorting, columns can be quickly sorted either ascending or descending by clicking on the directional icon next to the column title. The directional icons are defined in each <sgmltag>&lt;rich:column&gt;</sgmltag> component with the <varname>sortIconAscending</varname> and <varname>sortIconDescending</varname> attributes, for ascending and descending icons respectively. For full details on sorting tables, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_sorting" />. + </para> + <para> + Grouping the table's entries by a column will organize the table into collapsible sections, as shown in <xref linkend="figu-Component_Reference-richextendedDataTable-Grouping_table_entries_by_column" />. + </para> + <figure id="figu-Component_Reference-richextendedDataTable-Grouping_table_entries_by_column"> + <title>Grouping table entries by column</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-Grouping_table_entries_by_column.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + A table with entries grouped by the <guilabel>Group</guilabel> column. + </para> + </textobject> + </mediaobject> + </figure> + <para> + The checkboxes in the column menu under the <guisubmenu>Columns</guisubmenu> sub-menu will hide or show the respective columns, as shown in <xref linkend="figu-Component_Reference-richextendedDataTable-Hiding_columns" />. + </para> + <figure id="figu-Component_Reference-richextendedDataTable-Hiding_columns"> + <title>Hiding columns</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-Hiding_columns.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + The <guilabel>Date</guilabel> and <guilabel>Group</guilabel> columns are hidden from the table. + </para> + </textobject> + </mediaobject> + </figure> + <para> + Columns in a <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component can be rearranged by the user by dragging each column to a different position. The <varname>label</varname> attribute for the <sgmltag>&lt;rich:column&gt;</sgmltag> component is displayed during dragging, as shown in + </para> + <figure id="figu-Component_Reference-richextendedDataTable-Dragging_columns"> + <title>Dragging columns</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-Dragging_columns.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + Dragging the <guilabel>Name</guilabel> column rearranges the order of the columns. + </para> + </textobject> + </mediaobject> + </figure> + <para> + Once the contents of the table have been rearranged and customized by the user, the <varname>tableState</varname> attribute can be used to preserve the customization so it can be restored later. The <varname>tableState</varname> attribute points to a backing-bean property which can in turn be saved to a database separate from standard JSF state-saving mechanisms. + </para> </section> + <!-- TODO <section id="sect-Component_Reference-Tables_and_grids-richsubTable"> <title><sgmltag>&lt;rich:subTable&gt;</sgmltag></title> <para> Incomplete </para> </section> - + --> <section id="sect-Component_Reference-Tables_and_grids-Table_filtering"> <title>Table filtering</title> <para> - Incomplete + Under development. </para> </section> <section id="sect-Component_Reference-Tables_and_grids-Table_sorting"> <title>Table sorting</title> <para> - Incomplete + Under development. </para> </section> Copied: root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richdataDefinitionList_example.xml_sample (from rev 17988, root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Trees-richdataDefinitionList_example.xml_sample) =================================================================== --- root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richdataDefinitionList_example.xml_sample (rev 0) +++ root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richdataDefinitionList_example.xml_sample 2010-07-13 03:26:13 UTC (rev 17995) @@ -0,0 +1,11 @@ +<h:form> + <rich:dataDefinitionList var="car" value="#{dataTableScrollerBean.allCars}" rows="5" first="4" title="Cars"> + <f:facet name="term"> + <h:outputText value="#{car.make} #{car.model}"></h:outputText> + </f:facet> + <h:outputText value="Price:" styleClass="label"></h:outputText> + <h:outputText value="#{car.price}" /><br/> + <h:outputText value="Mileage:" styleClass="label"></h:outputText> + <h:outputText value="#{car.mileage}" /><br/> + </rich:dataDefinitionList> +</h:form> Added: root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richdataTable_example.xml_sample =================================================================== --- root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richdataTable_example.xml_sample (rev 0) +++ root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richdataTable_example.xml_sample 2010-07-13 03:26:13 UTC (rev 17995) @@ -0,0 +1,31 @@ +<rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"> + <f:facet name="caption"> + <h:outputText value="United States Capitals" /> + </f:facet> + <f:facet name="header"> + <h:outputText value="Capitals and States Table" /> + </f:facet> + <rich:column> + <f:facet name="header">State Flag</f:facet> + <h:graphicImage value="#{cap.stateFlag}"/> + <f:facet name="footer">State Flag</f:facet> + </rich:column> + <rich:column> + <f:facet name="header">State Name</f:facet> + <h:outputText value="#{cap.state}"/> + <f:facet name="footer">State Name</f:facet> + </rich:column> + <rich:column > + <f:facet name="header">State Capital</f:facet> + <h:outputText value="#{cap.name}"/> + <f:facet name="footer">State Capital</f:facet> + </rich:column> + <rich:column> + <f:facet name="header">Time Zone</f:facet> + <h:outputText value="#{cap.timeZone}"/> + <f:facet name="footer">Time Zone</f:facet> + </rich:column> + <f:facet name="footer"> + <h:outputText value="Capitals and States Table" /> + </f:facet> +</rich:dataTable> Added: root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richextendedDataTable_example.xml_sample =================================================================== --- root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richextendedDataTable_example.xml_sample (rev 0) +++ root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richextendedDataTable_example.xml_sample 2010-07-13 03:26:13 UTC (rev 17995) @@ -0,0 +1,27 @@ +<rich:extendedDataTable id="edt" value="#{extendedDT.dataModel}" var="edt" width="500px" height="500px" selectedClass="dataTableSelectedRow" sortMode="single" selectionMode="multi" selection="#{extendedDT.selection}" rowKeyVar="rkvar" tableState="#{extendedDT.tableState}"> + <rich:column id="id" headerClass="dataTableHeader" width="50" label="Id" sortable="true" sortBy="#{edt.id}" sortIconAscending="dataTableAscIcon" sortIconDescending="dataTableDescIcon"> + <f:facet name="header"> + <h:outputText value="Id" /> + </f:facet> + <h:outputText value="#{edt.id}" /> + </rich:column> + <rich:column id="name" width="300" headerClass="dataTableHeader" label="Name" sortable="true" sortBy="#{edt.name}" sortIconAscending="dataTableAscIcon" sortIconDescending="dataTableDescIcon" filterBy="#{edt.name}" filterEvent="onkeyup" visible="false"> + <f:facet name="header"> + <h:outputText value="Name" /> + </f:facet> + <h:outputText value="#{edt.name}" /> + </rich:column> + <rich:column id="date" width="100" headerClass="dataTableHeader" label="Date" sortable="true" comparator="#{extendedDT.dateComparator}" sortIconAscending="dataTableAscIcon" sortIconDescending="dataTableDescIcon"> + <f:facet name="header"> + <h:outputText value="Date" /> + </f:facet> + <h:outputText value="#{edt.date}"><f:convertDateTime pattern="yyyy-MM-dd HH:mm:ss" /> + </h:outputText> + </rich:column> + <rich:column id="group" width="50" headerClass="dataTableHeader" label="Group" sortable="true" sortBy="#{edt.group}" sortIconAscending="dataTableAscIcon" sortIconDescending="dataTableDescIcon"> + <f:facet name="header"> + <h:outputText value="Group" /> + </f:facet> + <h:outputText value="#{edt.group}" /> + </rich:column> +</rich:extendedDataTable> Deleted: root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Trees-richdataDefinitionList_example.xml_sample =================================================================== --- root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Trees-richdataDefinitionList_example.xml_sample 2010-07-13 01:26:22 UTC (rev 17994) +++ root/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Trees-richdataDefinitionList_example.xml_sample 2010-07-13 03:26:13 UTC (rev 17995) @@ -1,11 +0,0 @@ -<h:form> - <rich:dataDefinitionList var="car" value="#{dataTableScrollerBean.allCars}" rows="5" first="4" title="Cars"> - <f:facet name="term"> - <h:outputText value="#{car.make} #{car.model}"></h:outputText> - </f:facet> - <h:outputText value="Price:" styleClass="label"></h:outputText> - <h:outputText value="#{car.price}" /><br/> - <h:outputText value="Mileage:" styleClass="label"></h:outputText> - <h:outputText value="#{car.mileage}" /><br/> - </rich:dataDefinitionList> -</h:form> Added: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-Column_menu.png =================================================================== (Binary files differ) Property changes on: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-Column_menu.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-Dragging_columns.png =================================================================== (Binary files differ) Property changes on: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-Dragging_columns.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-Grouping_table_entries_by_column.png =================================================================== (Binary files differ) Property changes on: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-Grouping_table_entries_by_column.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-Hiding_columns.png =================================================================== (Binary files differ) Property changes on: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-Hiding_columns.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-Selecting_multiple_rows.png =================================================================== (Binary files differ) Property changes on: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-Selecting_multiple_rows.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-richdataDefinitionList_example.png =================================================================== (Binary files differ) Property changes on: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-richdataDefinitionList_example.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-richextendedDataTable_example.png =================================================================== (Binary files differ) Property changes on: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-richextendedDataTable_example.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richdataTable_example.png =================================================================== (Binary files differ) Property changes on: root/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richdataTable_example.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: root/docs/trunk/parent/pom.xml =================================================================== --- root/docs/trunk/parent/pom.xml 2010-07-13 01:26:22 UTC (rev 17994) +++ root/docs/trunk/parent/pom.xml 2010-07-13 03:26:13 UTC (rev 17995) @@ -81,10 +81,20 @@ </format> </formats> <options> - <xincludeSupported>true</xincludeSupported> - <xmlTransformerType>saxon</xmlTransformerType> - <docbookVersion>1.72.0</docbookVersion> - <localeSeparator>-</localeSeparator> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <docbookVersion>1.72.0</docbookVersion> + <localeSeparator>-</localeSeparator> + <transformerParameters> + <property> + <name>javax.xml.parsers.DocumentBuilderFactory</name> + <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value> + </property> + <property> + <name>javax.xml.parsers.SAXParserFactory</name> + <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value> + </property> + </transformerParameters> </options> </configuration> </plugin>