Author: SeanRogers Date: 2010-09-13 21:39:52 -0400 (Mon, 13 Sep 2010) New Revision: 19182 Modified: modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml modules/docs/branches/M3_draft/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml Log: Completed rich:list style details (RF-9140) Modified: modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml =================================================================== --- modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-09-14 00:39:12 UTC (rev 19181) +++ modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-09-14 01:39:52 UTC (rev 19182) @@ -951,7 +951,7 @@ </variablelist> </section> - <!-- TODO + <!-- <section id="sect-Component_Reference-richlist-Bullet_point_type"> <title>Bullet point type</title> <para> @@ -986,153 +986,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 +1035,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 +1070,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/branches/M3_draft/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml =================================================================== --- modules/docs/branches/M3_draft/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml 2010-09-14 00:39:12 UTC (rev 19181) +++ modules/docs/branches/M3_draft/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml 2010-09-14 01:39:52 UTC (rev 19182) @@ -967,6 +967,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>