Author: vkorluzhenko Date: 2007-11-23 11:01:52 -0500 (Fri, 23 Nov 2007) New Revision: 4223 Modified: trunk/docs/userguide/en/src/main/docbook/included/dataDefinitionList.desc.xml trunk/docs/userguide/en/src/main/docbook/included/dataDefinitionList.xml trunk/docs/userguide/en/src/main/docbook/included/dataGrid.xml trunk/docs/userguide/en/src/main/docbook/included/dataList.xml trunk/docs/userguide/en/src/main/docbook/included/dataOrderedList.desc.xml trunk/docs/userguide/en/src/main/docbook/included/dataOrderedList.xml Log: http://jira.jboss.com/jira/browse/RF-657 - updated description Modified: trunk/docs/userguide/en/src/main/docbook/included/dataDefinitionList.desc.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/dataDefinitionList.desc.xml 2007-11-23 15:15:42 UTC (rev 4222) +++ trunk/docs/userguide/en/src/main/docbook/included/dataDefinitionList.desc.xml 2007-11-23 16:01:52 UTC (rev 4223) @@ -13,7 +13,7 @@ <title>DataDefinitionList component</title> <mediaobject> <imageobject> - <imagedata fileref="images/datadefinitionlist1.gif"/> + <imagedata fileref="images/datadefinitionlist1.png"/> </imageobject> </mediaobject> </figure> Modified: trunk/docs/userguide/en/src/main/docbook/included/dataDefinitionList.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/dataDefinitionList.xml 2007-11-23 15:15:42 UTC (rev 4222) +++ trunk/docs/userguide/en/src/main/docbook/included/dataDefinitionList.xml 2007-11-23 16:01:52 UTC (rev 4223) @@ -50,8 +50,8 @@ </para> <programlisting role="XML"><![CDATA[... <rich:dataDefinitionList value="#{bean.capitals}" var="caps"> - <f:facet name="term">United States Capitals</f:facet> - <h:outputText value="#{caps.name}"/> + <f:facet name="term">Cars</f:facet> + <h:outputText value="#{car.model}"/> </rich:dataDefinitionList> ... ]]></programlisting> @@ -71,32 +71,82 @@ </section> <section> <title>Details of Usage</title> -<para>The component takes a list from a model and outputs it as an ordered list. The component also has - similar to ordinary UIData components output ways:</para> -<itemizedlist> -<listitem>A header and footer output</listitem> -<listitem>Limitation of the output elements (the <emphasis ><property>&quot;elements&quot;</property></emphasis> attribute) and definition of the first - element</listitem> - <listitem>Binding to scrolling components of list pages</listitem> - </itemizedlist> - <para>It allows definition inside a facet with the <emphasis><property>&quot;term&quot;</property></emphasis> name to add HTML DT elements into a list.</para> - <para>The component is created basing on the <emphasis role="bold"><property>&lt;a4j:repeat&gt;</property></emphasis> component and as a result the component could - be partially updated with AJAX.</para> - - <para> - <emphasis role="bold">Example:</emphasis> - </para> + <para>The <emphasis role="bold"> + <property>&lt;rich:dataDefinitionList&gt;</property> + </emphasis> component allows to generate an definition list from a model.</para> + <para>The component has the <emphasis> + <property>&quot;type&quot;</property> + </emphasis> facet, which corresponds to the <emphasis> + <property>&quot;type&quot;</property> + </emphasis> parameter for the <emphasis> + <property>&quot;DT&quot;</property> + </emphasis> HTML element.</para> + <para>Here is an example:</para> + <programlisting role="XML"><![CDATA[... - <rich:dataDefinitionList value="#{bean.capitals}" var="caps" ajaxKeys="#{listBean.list}" - binding="#{listBean.dataList}" id="list"> - <h:outputText value="#{caps.name}"/> + <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> +... +]]></programlisting> + + <para>This is a result:</para> + + <figure> + <title>Component usage</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/datadefinitionlist1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>In the example the <emphasis> + <property>&quot;rows&quot;</property> + </emphasis> attribute limits number of output elements of the list.</para> + + <para><emphasis> + <property>&quot;first&quot;</property> + </emphasis> attribute defines first element for output. <emphasis> + <property>&quot;title&quot;</property> + </emphasis> are used for popup title.</para> + + <para>The component is created basing on the <emphasis role="bold"> + <property>&lt;a4j:repeat&gt;</property> + </emphasis> component and as a result it could be partially updated with Ajax. <emphasis> + <property>&quot;ajaxKeys&quot;</property> + </emphasis> attribute allows to define elements that are updated after an Ajax request.</para> + <para>Here is an example:</para> + + <para> + <emphasis role="bold">Example:</emphasis> + </para> + <programlisting role="XML"><![CDATA[... + <rich:dataDefinitionList value="#{dataTableScrollerBean.allCars}" var="car" ajaxKeys="#{listBean.list}" + binding="#{listBean.dataList}" id="list" rows="5" type="disc"> + <h:outputText value="#{car.make} #{car.model}"></h:outputText> </rich:dataDefinitionList> ... <a4j:commandButton action"#{listBean.action}" reRender="list" value="Submit"/> ... ]]></programlisting> -<para>Here during the action is processed the ajaxKeys set is composed into a list and then update - specified for the whole table actually happens only for the chosen set of rows.</para> + + <para> In the example <emphasis> + <property>&quot;reRender&quot;</property> + </emphasis> attribute contains value of <emphasis> + <property>&quot;id&quot;</property> + </emphasis> attribute for <emphasis role="bold"> + <property>&lt;rich:dataDefinitionList&gt;</property> + </emphasis> component. As a result the component are updated after an Ajax request.</para> + </section> <section> Modified: trunk/docs/userguide/en/src/main/docbook/included/dataGrid.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/dataGrid.xml 2007-11-23 15:15:42 UTC (rev 4222) +++ trunk/docs/userguide/en/src/main/docbook/included/dataGrid.xml 2007-11-23 16:01:52 UTC (rev 4223) @@ -51,8 +51,8 @@ <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... - <rich:dataGrid value="#{bean.capitals}" var="caps" columns="4"> - <h:outputText value="#{caps.name}"/> + <rich:dataGrid value="#{dataTableScrollerBean.allCars}" var="car"> + <h:outputText value="#{car.model}"/> </rich:dataGrid> ... ]]></programlisting> @@ -112,9 +112,9 @@ </f:facet> <h:panelGrid columns="2"> <h:outputText value="Price:" styleClass="label"></h:outputText> - <h:outputText value="#{car.price}" /> + <h:outputText value="#{car.price}"/> <h:outputText value="Mileage:" styleClass="label"></h:outputText> - <h:outputText value="#{car.mileage}" /> + <h:outputText value="#{car.mileage}"/> </h:panelGrid> </rich:panel> <f:facet name="footer"> Modified: trunk/docs/userguide/en/src/main/docbook/included/dataList.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/dataList.xml 2007-11-23 15:15:42 UTC (rev 4222) +++ trunk/docs/userguide/en/src/main/docbook/included/dataList.xml 2007-11-23 16:01:52 UTC (rev 4223) @@ -53,7 +53,7 @@ </para> <programlisting role="XML"><![CDATA[... <rich:dataList var="car" value="#{dataTableScrollerBean.allCars}" > - <h:outputText value="#{cars.name}"/> + <h:outputText value="#{car.model}"/> </rich:dataList> ... ]]></programlisting> @@ -80,7 +80,7 @@ </emphasis> attribute, which corresponds to the <emphasis> <property>&quot;type&quot;</property> </emphasis> parameter for the <emphasis> - <property>&quot;ul&quot;</property> + <property>&quot;UL&quot;</property> </emphasis> HTML element and defines a marker type. Possible values for <emphasis> <property>&quot;type&quot;</property> </emphasis> attribute are: <property>&quot;disc&quot;</property>, @@ -90,12 +90,12 @@ <programlisting role="XML"><![CDATA[... <h:form> - <rich:dataList var="car" value="#{dataTableScrollerBean.allCars}" rows="5" type="disc"> + <rich:dataList var="car" value="#{dataTableScrollerBean.allCars}" rows="5" type="disc" title="Car Store"> <h:outputText value="#{car.make} #{car.model}"/><br/> <h:outputText value="Price:" styleClass="label"></h:outputText> - <h:outputText value="#{car.price} " /><br/> + <h:outputText value="#{car.price} "/><br/> <h:outputText value="Mileage:" styleClass="label"></h:outputText> - <h:outputText value="#{car.mileage} " /><br/> + <h:outputText value="#{car.mileage} "/><br/> </rich:dataList> </h:form> ... @@ -145,7 +145,7 @@ <rich:dataList value="#{dataTableScrollerBean.allCars}" var="car" ajaxKeys="#{listBean.list}" binding="#{listBean.dataList}" id="list" rows="5" type="disc"> <h:outputText value="#{car.make} #{car.model}"></h:outputText> - </rich:dataGrid> + </rich:dataList> ... <a4j:commandButton action"#{listBean.action}" reRender="list" value="Submit"/> ... Modified: trunk/docs/userguide/en/src/main/docbook/included/dataOrderedList.desc.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/dataOrderedList.desc.xml 2007-11-23 15:15:42 UTC (rev 4222) +++ trunk/docs/userguide/en/src/main/docbook/included/dataOrderedList.desc.xml 2007-11-23 16:01:52 UTC (rev 4223) @@ -13,7 +13,7 @@ <title>DataOrderedList component</title> <mediaobject> <imageobject> - <imagedata fileref="images/dataorderedlist1.gif"/> + <imagedata fileref="images/dataorderedlist1.png"/> </imageobject> </mediaobject> </figure> Modified: trunk/docs/userguide/en/src/main/docbook/included/dataOrderedList.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/dataOrderedList.xml 2007-11-23 15:15:42 UTC (rev 4222) +++ trunk/docs/userguide/en/src/main/docbook/included/dataOrderedList.xml 2007-11-23 16:01:52 UTC (rev 4223) @@ -1,183 +1,236 @@ <?xml version='1.0' encoding='UTF-8'?> <section> -<sectioninfo> -<keywordset> -<keyword>rich:dataOrderedList</keyword> -<keyword>HtmlDataOrderedList</keyword> -<keyword>ordered list</keyword> -</keywordset> -</sectioninfo> - - <table> - <title>Component identification parameters </title> - <tgroup cols="2"> - <thead> - <row> - <entry>Name</entry> - <entry>Value</entry> - </row> - </thead> - <tbody> - <row> - <entry>component-type</entry> - <entry>org.richfaces.DataOrderedList</entry> - </row> - <row> - <entry>component-class</entry> - <entry>org.richfaces.component.html.HtmlDataOrderedList</entry> - </row> - <row> + <sectioninfo> + <keywordset> + <keyword>rich:dataOrderedList</keyword> + <keyword>HtmlDataOrderedList</keyword> + <keyword>ordered list</keyword> + </keywordset> + </sectioninfo> + + <table> + <title>Component identification parameters </title> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + <entry>Value</entry> + </row> + </thead> + <tbody> + <row> + <entry>component-type</entry> + <entry>org.richfaces.DataOrderedList</entry> + </row> + <row> + <entry>component-class</entry> + <entry>org.richfaces.component.html.HtmlDataOrderedList</entry> + </row> + <row> <entry>component-family</entry> <entry>org.richfaces.DataOrderedList</entry> - </row> - <row> + </row> + <row> <entry>renderer-type</entry> <entry>org.richfaces.DataOrderedListRenderer</entry> - </row> - <row> - <entry>tag-class</entry> - <entry>org.richfaces.taglib.DataOrderedListTag</entry> - </row> - </tbody> - </tgroup> - </table> - + </row> + <row> + <entry>tag-class</entry> + <entry>org.richfaces.taglib.DataOrderedListTag</entry> + </row> + </tbody> + </tgroup> + </table> + <section> <title>Creating the Component with a Page Tag</title> - <para>To create the simplest variant of <property>dataOrderedList</property> on a page, use the following syntax:</para> + <para>To create the simplest variant of <property>dataOrderedList</property> on a page, use the + following syntax:</para> <para> <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... - <rich:dataOrderedList value="#{bean.capitals}" var="caps"> - <h:outputText value="#{caps.name}"/> + <rich:dataOrderedList var="car" value="#{dataTableScrollerBean.allCars}" > + <h:outputText value="#{car.model}"/> </rich:dataOrderedList> ... ]]></programlisting> </section> <section> - <title>Creating the Component Dynamically Using Java</title> + <title>Creating the Component Dynamically Using Java</title> <para> <emphasis role="bold">Example:</emphasis> </para> - <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlDataOrderedList; + <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlDataOrderedList; ... HtmlDataOrderedList myList = new HtmlDataOrderedList(); ... ]]></programlisting> -</section> -<section> -<title>Details of Usage</title> -<para>The component takes a list from a model and outputs it as an ordered list. The component also has -similar to ordinary UIData components output ways:</para> -<itemizedlist> -<listitem>Header and footer output</listitem> -<listitem>Limitation of the output elements (the <emphasis ><property>&quot;elements&quot;</property></emphasis> attribute) and definition of the first - element</listitem> - <listitem>Binding to scrolling components of list pages</listitem> - </itemizedlist> - <para>The component has the <emphasis ><property>&quot;type&quot;</property></emphasis> attribute corresponding to the <emphasis><property>&quot;ul&quot;</property></emphasis> HTML element.</para> - <para>The component is created basing on the <emphasis role="bold"><property>&lt;a4j:repeat&gt;</property></emphasis> component and as a result the component could - be partially updated with AJAX.</para> + </section> + <section> + <title>Details of Usage</title> + <para>The <emphasis role="bold"> + <property>&lt;rich:dataOrderedList&gt;</property> + </emphasis> component allows to generate an ordered list from a model.</para> + <para>The component has the <emphasis> + <property>&quot;type&quot;</property> + </emphasis> attribute, which corresponds to the <emphasis> + <property>&quot;type&quot;</property> + </emphasis> parameter for the <emphasis> + <property>&quot;OL&quot;</property> + </emphasis> HTML element and defines a marker type. Possible values for <emphasis> + <property>&quot;type&quot;</property> + </emphasis> attribute are: <property>&quot;A&quot;</property>, + <property>&quot;a&quot;</property>, <property>&quot;I&quot;</property>, + <property>&quot;i&quot;</property>,<property>&quot;1&quot;</property>.</para> + <para>Here is an example:</para> + <programlisting role="XML"><![CDATA[... + <h:form> + <rich:dataOrderedList var="car" value="#{dataTableScrollerBean.allCars}" rows="5" type="1" title="Car Store"> + <h:outputText value="#{car.make} #{car.model}"/><br/> + <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:dataOrderedList> + </h:form> +... +]]></programlisting> + + <para>This is a result:</para> + + <figure> + <title>Component usage</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/dataorderedlist1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>In the example the <emphasis> + <property>&quot;rows&quot;</property> + </emphasis> attribute limits number of output elements of the list.</para> + + <para><emphasis> + <property>&quot;first&quot;</property> + </emphasis> attribute defines first element for output. <emphasis> + <property>&quot;title&quot;</property> + </emphasis> are used for popup title.</para> + + <para>The component is created basing on the <emphasis role="bold"> + <property>&lt;a4j:repeat&gt;</property> + </emphasis> component and as a result it could be partially updated with Ajax. <emphasis> + <property>&quot;ajaxKeys&quot;</property> + </emphasis> attribute allows to define elements that are updated after an Ajax request.</para> + <para>Here is an example:</para> + <para> <emphasis role="bold">Example:</emphasis> </para> - <programlisting role="XML"><![CDATA[... - <rich:dataOrderedList value="#{bean.capitals}" var="caps" ajaxKeys="#{listBean.list}" - binding="#{listBean.dataList}" id="list"> - <h:outputText value="#{caps.name}"/> + <programlisting role="XML"><![CDATA[... + <rich:dataOrderedList value="#{dataTableScrollerBean.allCars}" var="car" ajaxKeys="#{listBean.list}" + binding="#{listBean.dataList}" id="list" rows="5" type="disc"> + <h:outputText value="#{car.make} #{car.model}"></h:outputText> </rich:dataOrderedList> ... - <a4j:commandButton action"#{listBean.action}" reRender="list" value="Submit"> + <a4j:commandButton action"#{listBean.action}" reRender="list" value="Submit"/> ... ]]></programlisting> -<para>Here during the action is processed the ajaxKeys set is composed into a list and then update - specified for the whole table actually happens only for the chosen set of rows.</para> - </section> - <section> - <title>Look-and-Feel Customization</title> - - <para>For skinnability implementation, the components use a <emphasis> - <property>style class redefinition method.</property> - </emphasis> Default style classes are mapped on <emphasis> - <property>skin parameters.</property> - </emphasis></para> - - <para>There are two ways to redefine the appearance of all <emphasis role="bold"> - <property>&lt;rich:dataOrderedList&gt;</property> - </emphasis> components at once:</para> - - <itemizedlist> - <listitem> - <para>Redefine the corresponding skin parameters</para> - </listitem> - - <listitem> - <para>Add to your style sheets <emphasis> - <property>style classes</property> - </emphasis> used by a <emphasis role="bold"> - <property>&lt;rich:dataOrderedList&gt;</property> - </emphasis> component</para> - </listitem> - </itemizedlist> - </section> - - <section> - <title>Definition of Custom Style Classes</title> - - <para>On the screenshot there are classes names that define styles for component elements.</para> - - <figure> - <title>Style classes</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/dataorderedlist2.png"/> - </imageobject> - </mediaobject> - </figure> - - <table> - <title>Classes names that define a list appearance</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>rich-orderedlist</entry> - <entry>Defines styles for an html &lt;ol&gt; element</entry> - </row> - <row> - <entry>rich-list-item</entry> - <entry>Defines styles for an html &lt;li&gt; element</entry> - </row> - </tbody> - </tgroup> - </table> - <para>In order to redefine styles for all <emphasis role="bold"> - <property>&lt;rich:dataOrderedList&gt;</property> - </emphasis> components on a page using CSS, it&apos;s enough to create classes with the - same names and define necessary properties in them.</para> - - <para>To change styles of particular <emphasis role="bold"> - <property>&lt;rich:dataOrderedList&gt;</property> - </emphasis> components, define your own style classes in the corresponding <emphasis - role="bold"> - <property>&lt;rich:dataOrderedList&gt;</property> - </emphasis>attributes.</para> - </section> + <para> In the example <emphasis> + <property>&quot;reRender&quot;</property> + </emphasis> attribute contains value of <emphasis> + <property>&quot;id&quot;</property> + </emphasis> attribute for <emphasis role="bold"> + <property>&lt;rich:dataOrderedList&gt;</property> + </emphasis> component. As a result the component are updated after an Ajax request.</para> + </section> <section> + <title>Look-and-Feel Customization</title> + + <para>For skinnability implementation, the components use a <emphasis> + <property>style class redefinition method.</property> + </emphasis> Default style classes are mapped on <emphasis> + <property>skin parameters.</property> + </emphasis></para> + + <para>There are two ways to redefine the appearance of all <emphasis role="bold"> + <property>&lt;rich:dataOrderedList&gt;</property> + </emphasis> components at once:</para> + + <itemizedlist> + <listitem> + <para>Redefine the corresponding skin parameters</para> + </listitem> + + <listitem> + <para>Add to your style sheets <emphasis> + <property>style classes</property> + </emphasis> used by a <emphasis role="bold"> + <property>&lt;rich:dataOrderedList&gt;</property> + </emphasis> component</para> + </listitem> + </itemizedlist> + </section> + + <section> + <title>Definition of Custom Style Classes</title> + + <para>On the screenshot there are classes names that define styles for component elements.</para> + + <figure> + <title>Style classes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/dataorderedlist2.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>Classes names that define a list appearance</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Class name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>rich-orderedlist</entry> + <entry>Defines styles for an html &lt;ol&gt; element</entry> + </row> + <row> + <entry>rich-list-item</entry> + <entry>Defines styles for an html &lt;li&gt; element</entry> + </row> + </tbody> + </tgroup> + </table> + + <para>In order to redefine styles for all <emphasis role="bold"> + <property>&lt;rich:dataOrderedList&gt;</property> + </emphasis> components on a page using CSS, it&apos;s enough to create classes with the + same names and define necessary properties in them.</para> + + <para>To change styles of particular <emphasis role="bold"> + <property>&lt;rich:dataOrderedList&gt;</property> + </emphasis> components, define your own style classes in the corresponding <emphasis + role="bold"> + <property>&lt;rich:dataOrderedList&gt;</property> + </emphasis>attributes.</para> + </section> + <section> <title>Relevant Resources Links</title> - <para><ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/dataLists.j... - >Here</ulink> you can see the example of <emphasis role="bold" - ><property>&lt;rich:dataOrderedList &gt;</property></emphasis> usage and sources for the given example. </para> - </section> + <para><ulink + url="http://livedemo.exadel.com/richfaces-demo/richfaces/dataLists.j... + >Here</ulink> you can see the example of <emphasis role="bold"> + <property>&lt;rich:dataOrderedList &gt;</property> + </emphasis> usage and sources for the given example. </para> + </section> </section> - \ No newline at end of file