Author: ochikvina
Date: 2009-08-28 09:28:27 -0400 (Fri, 28 Aug 2009)
New Revision: 15406
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_column.xml
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_dataTable.xml
Log:
https://jira.jboss.org/jira/browse/RF-7679 - the component 'Details of Usage'
section is updated;
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_column.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_column.xml 2009-08-28
13:25:49 UTC (rev 15405)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_column.xml 2009-08-28
13:28:27 UTC (rev 15406)
@@ -10,7 +10,7 @@
</title>
<section>
<title>Description</title>
- <para>The component for row rendering for a UIData component.</para>
+ <para>The component is meant for row rendering in UIData
components.</para>
<figure>
<title>
<emphasis role="bold">
@@ -31,7 +31,7 @@
</listitem>
<listitem>
<para>Possibility to combine columns with the help of <emphasis>
- <property>"colspan"</property>
+ <property>"colspan"</property>
</emphasis>
</para>
</listitem>
@@ -61,7 +61,7 @@
<property><rich:column></property>
</emphasis> component is used the same way as the
standard <emphasis role="bold">
<property><h:column></property>
- </emphasis>, i.e. the following code on a page is
used:</para>
+ </emphasis>. See the example of the component usage
below:</para>
<para>
<emphasis
role="bold">Example:</emphasis>
@@ -102,9 +102,9 @@
column with a flag, use the <emphasis>
<property>"colspan"</property>
</emphasis> attribute, which is similar to an HTML
one, specifying
- that the first column contains 3 columns. In addition,
it's
+ that the first column contains 3 columns. In addition,
it's
necessary to specify that the next column begins from the
first row
- with the help of the
+ with the help of
<code>breakBefore="true"</code>.</para>
<para>
@@ -133,9 +133,9 @@
<emphasis role="bold">
<property><rich:column></property>
</emphasis> modified with <emphasis>
-
<property>"colspan"</property>
+
<property>"colspan"</property>
</emphasis> and <emphasis>
-
<property>"breakbefore"</property>
+
<property>"breakbefore"</property>
</emphasis> attributes</title>
<mediaobject>
<imageobject>
@@ -144,11 +144,11 @@
</mediaobject>
</figure>
<para>The same way is used for
<property>columns</property> grouping with the <emphasis>
-
<property>"rowspan"</property>
+
<property>"rowspan"</property>
</emphasis> attribute that is similar to an HTML one
responsible for
rows quantity definition occupied with the current one. The
only thing
to add in the example is an instruction to move onto the
next row for
- each next after the second column.</para>
+ each next row after the second column.</para>
<para>
<emphasis
role="bold">Example:</emphasis>
@@ -178,7 +178,7 @@
<emphasis role="bold">
<property><rich:column></property>
</emphasis> generated with
<emphasis>
-
<property>"rowspan"</property>
+
<property>"rowspan"</property>
</emphasis> attribute</title>
<mediaobject>
<imageobject>
@@ -203,10 +203,10 @@
<title>Sorting and Filtering</title>
<section id="sort">
<title>Sorting</title>
- <para> In order to sort the columns you should use
<emphasis>
-
<property>"sortBy"</property>
+ <para> In order to sort the columns you should use
the <emphasis>
+
<property>"sortBy"</property>
</emphasis> attribute that indicates what
values to be
- sorted.This attribute can be used only with the
<emphasis role="bold">
+ sorted. This attribute can be used only with the
<emphasis role="bold">
<property><rich:dataTable></property>
</emphasis> component.
In order to sort the column you should click on
its
@@ -241,7 +241,7 @@
<emphasis role="bold">
<property><rich:column></property>
</emphasis> with
<emphasis>
-
<property>"sortBy"</property>
+
<property>"sortBy"</property>
</emphasis> attribute
</title>
<mediaobject>
<imageobject>
@@ -250,33 +250,33 @@
</mediaobject>
</figure>
<para>The <emphasis>
-
<property>"sortExpression"</property>
+
<property>"sortExpression"</property>
</emphasis> attribute defines a bean property which
is used
- for sorting of a column. This attribute can be
used only with the <emphasis role="bold">
+ for sorting a column. This attribute can be used
only with the <emphasis role="bold">
<property><rich:scrollableDataTable></property>
</emphasis> component.
- The following example is a example of the
attribute usage.
+ See the example of the attribute usage below.
</para>
<para>
<emphasis
role="bold">Example:</emphasis>
</para>
<programlisting role="XML">...
-<rich:scrollableDataTable id="carList"
+<rich:scrollableDataTable
value="#{dataTableScrollerBean.allCars}" sortMode="single"
- binding="#{dataTableScrollerBean.table}">
- <rich:column id="make" sortExpression="#{cap.make}">
+ var="category">
+ <rich:column sortExpression="#{category.make}">
<f:facet name="header">
<h:outputText styleClass="headerText" value="Make"
/>
</f:facet>
<h:outputText value="#{category.make}" />
</rich:column>
- <rich:column id="model">
+ <rich:column>
<f:facet name="header">
<h:outputText styleClass="headerText" value="Model"
/>
</f:facet>
<h:outputText value="#{category.model}" />
</rich:column>
- <rich:column id="price">
+ <rich:column>
<f:facet name="header">
<h:outputText styleClass="headerText" value="Price"
/>
</f:facet>
@@ -295,11 +295,11 @@
</imageobject>
</mediaobject>
</figure>-->
- <para> The <emphasis>
-
<property>"selfSorted"</property>
- </emphasis> attribute that would add the
possibility of
- automatic sorting by clicking the column header.
Default
- value is "true". In the example below
the
+ <para>The <emphasis>
+
<property>"selfSorted"</property>
+ </emphasis> attribute is meant for adding
the possibility of
+ automatic sorting by clicking on the column
header. Default
+ value is "true". In the example
below the
second column is unavailable for sorting.
</para>
<para>
<emphasis
role="bold">Example:</emphasis>
@@ -320,24 +320,24 @@
</rich:column>
</rich:dataTable>
...</programlisting>
- <para>
+ <para>The
<emphasis>
-
<property>"sortOrder"</property>
- </emphasis> attribute is used for changing
the sorting of
+
<property>"sortOrder"</property>
+ </emphasis> attribute is used for changing
the sort order of
columns by means of external controls.
</para>
<para>Possible values are:</para>
<itemizedlist>
<listitem>
- <para> "ASCENDING" -
column is
- sorted in ascending </para>
+
<para>"ASCENDING" - column is
+ sorted in ascending order</para>
</listitem>
<listitem>
- <para> "DESCENDING" -
column is
- sorted in descending </para>
+
<para>"DESCENDING" - column is
+ sorted in descending
order</para>
</listitem>
<listitem>
- <para> "UNSORTED" -
column
- isn't sorted </para>
+
<para>"UNSORTED" - column
+ isn't sorted </para>
</listitem>
</itemizedlist>
<para>
@@ -443,9 +443,9 @@
<para> Using built-in filtering.
It uses
<code>startsWith()</code>
function to make filtering. In this
case
- you need to define <emphasis>
+ you need to define the
<emphasis>
<property>"filterBy"</property>
- </emphasis> attribute at column
you want
+ </emphasis> attribute at a column
you want
to be filterable. This attribute
defines
iterable object property which is used
when filtering performed.
</para>
@@ -476,16 +476,26 @@
<para>
<emphasis
role="bold">Example:</emphasis>
</para>
- <programlisting
role="XML">...
-<rich:dataTable value="#{capitalsBean.capitals}" var="cap"
width="500px">
- <rich:column filterBy="#{cap.state}"
filterValue="#{filterName.filterBean}" filterEvent="onkeyup">
- <h:outputText value="#{cap.state}"/>
- </rich:column>
- <rich:column filterBy="#{cap.name}"
filterEvent="onkeyup">
- <h:outputText value="#{cap.name}"/>
- </rich:column>
-</rich:dataTable>
-...</programlisting>
+ <programlisting
role="XML"><![CDATA[...
+<rich:dataTable value="#{capitalsBean.capitals}" var="cap"
width="200px">
+ <f:facet name="header">
+ <h:outputText value="Sorting Example"/>
+ </f:facet>
+ <rich:column filterBy="#{cap.state}"
filterEvent="onkeyup">
+ <f:facet name="header">
+ <h:outputText value="State Name"/>
+ </f:facet>
+ <h:outputText value="#{cap.state}"/>
+ </rich:column>
+ <rich:column filterBy="#{cap.name}"
filterEvent="onkeyup">
+ <f:facet name="header">
+ <h:outputText value="State Capital"/>
+ </f:facet>
+ <h:outputText value="#{cap.name}"/>
+ </rich:column>
+</rich:dataTable>
+...
+]]></programlisting>
<para> This is the result:
</para>
<figure>
<title>Built-in filtering feature
usage</title>
@@ -511,39 +521,20 @@
<property>"filterMethod"</property>
</emphasis> attribute is defined
with
method binding. This method accepts on
- Object parameter and return boolean
- value. So, this method also could be
+ Object parameter and returns boolean
+ value. Thus, this method also could be
used to check if the object satisfies
- filtering condition. The usage of this
+ filtering condition or not. The usage
of this
attribute is the best way for
implementing your own complex business
logic. </para>
- <para>See the following
example:</para>
- <para>
- <emphasis
role="bold">Example:</emphasis>
- </para>
- <programlisting
role="XML">...
-<rich:dataTable value="#{capitalsBean.capitals}" var="cap"
id="table">
- <rich:column
filterMethod="#{filteringBean.filterStates}">
- <f:facet name="header">
- <h:inputText
value="#{filteringBean.filterValue}" id="input">
- <a4j:support event="onkeyup"
reRender="table"
- ignoreDupResponses="true"
requestDelay="700" focus="input" />
- </h:inputText>
- </f:facet>
- <h:outputText value="#{cap.state}" />
- </rich:column>
- <rich:column filterExpression="#{fn:containsIgnoreCase(cap.timeZone,
filteringBean.filterZone)}">
- <f:facet name="header">
- <h:selectOneMenu
value="#{filteringBean.filterZone}">
- <f:selectItems
value="#{filteringBean.filterZones}" />
- <a4j:support event="onchange"
reRender="table" />
- </h:selectOneMenu>
- </f:facet>
- <h:outputText value="#{cap.timeZone}" />
- </rich:column>
-</rich:dataTable>
-...</programlisting>
+ <para>See a simple example of
<emphasis>
+
<property>"filterExpression"</property>
+ </emphasis> and <emphasis>
+
<property>"filterMethod"</property>
+ </emphasis> attributes usage on the
+ RichFaces <ulink
url="http://livedemo.exadel.com/richfaces-demo/richfaces/filteringFe...
page</ulink>.</para>
+
</listitem>
</itemizedlist>
</section>
@@ -579,7 +570,7 @@
</row>
<row>
<entry>renderer-type</entry>
-
<entry>org.richfaces.ColumnRenderer</entry>
+
<entry>org.richfaces.renderkit.CellRenderer</entry>
</row>
<row>
<entry>tag-class</entry>
@@ -608,19 +599,24 @@
</row>
</tbody>
</tgroup>
- </table>
- You can find all necessary information about style classes redefinition in
+ </table>
+ <para>Custom style classes as well as skin parameters for <emphasis
role="bold">
+ <property><rich:column></property></emphasis> are
the same as for the <link linkend="dataTableRefData"><emphasis
role="bold">
+ <property><rich:dataTable></property></emphasis>
component.</link></para>
+ <para>You can find all necessary information about style classes
redefinition in
<link linkend="customstyles">Definition of Custom Style
Classes</link>
- section.
+ section.</para>
</section>
<section>
<title>Relevant Resources Links</title>
<para>Visit
- <ulink
url="http://livedemo.exadel.com/richfaces-demo/richfaces/dataTable.j...
page at
- RichFaces live demo for examples of component usage and their sources.</para>
- <para>"
- <ulink
url="http://www.jboss.org/community/docs/DOC-9607">Using the
"rendered" attribute of <rich:column></ulink>" article
- in RichFaces cookbook at JBoss portal gives an example of code of the component
usage case.
+ the <ulink
url="http://livedemo.exadel.com/richfaces-demo/richfaces/dataTable.j...
page at
+ RichFaces LiveDemo for examples of the component usage and their
sources.</para>
+ <para>
+ See the example on how to use the <emphasis>
+ <property>"rendered"</property></emphasis>
attribute of <emphasis role="bold">
+ <property><rich:column></property></emphasis> in
the
+ <ulink
url="http://www.jboss.org/community/docs/DOC-9607">RichFaces
Cookbook article</ulink>.
</para>
</section>
</section>
\ No newline at end of file
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_dataTable.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_dataTable.xml 2009-08-28
13:25:49 UTC (rev 15405)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_dataTable.xml 2009-08-28
13:28:27 UTC (rev 15406)
@@ -125,7 +125,7 @@
You can find information how to remove header's gradient <ulink
url="http://wiki.jboss.org/wiki/RichFacesDataTableBackgroundOut"... in the
"How to remove rich:dataTable header background " article</ulink>.
</para>
</section>
- <section>
+ <section id="dataTableRefData">
<title>Reference Data</title>
<para>
<ulink url="&tlddoc;rich/dataTable.html">Table of