[richfaces-svn-commits] JBoss Rich Faces SVN: r5377 - trunk/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Tue Jan 15 06:52:18 EST 2008
Author: artdaw
Date: 2008-01-15 06:52:18 -0500 (Tue, 15 Jan 2008)
New Revision: 5377
Modified:
trunk/docs/userguide/en/src/main/docbook/included/columns.xml
Log:
http://jira.jboss.com/jira/browse/RF-1199 - add Details of Usage, Look-and-Feel Customization, Skin Parameters Redefinition, Definition of Custom Style Classes, Relevant Resources Links.
Modified: trunk/docs/userguide/en/src/main/docbook/included/columns.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/columns.xml 2008-01-15 11:51:48 UTC (rev 5376)
+++ trunk/docs/userguide/en/src/main/docbook/included/columns.xml 2008-01-15 11:52:18 UTC (rev 5377)
@@ -2,8 +2,8 @@
<section>
<sectioninfo>
<keywordset>
- <keyword>rich:orderingList</keyword>
- <keyword>orderingList</keyword>
+ <keyword>rich:columns</keyword>
+ <keyword>columns</keyword>
</keywordset>
</sectioninfo>
<table>
@@ -13,7 +13,6 @@
<thead>
<row>
<entry>Name</entry>
-
<entry>Value</entry>
</row>
</thead>
@@ -72,7 +71,113 @@
</emphasis> component gets a list from data model and outputs corresponding set of columns inside
<emphasis role="bold"><property><rich:dataTable></property></emphasis> on a page.
</para>
+ <para>The <emphasis role="bold"><property><rich:columns></property></emphasis> component allows to use
+ <emphasis><property>"header"</property></emphasis> and <emphasis><property>"footer" </property></emphasis> facets.
+ </para>
+ <para>The simple example is placed below</para>
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[...
+<rich:dataTable value="#{bean.model}" var="var" id="tb">
+ <rich:columns value="#{colBean.columns}" var="col">
+ <f:facet name="header">
+ <h:outputText value="#{col.header}" />
+ </f:facet>
+ <h:outputText value="#{row.value}"/>
+ <f:facet name="footer">
+ <h:outputText value="#{col.footer}"/>
+ </f:facet>
+ </rich:columns>
+</rich:dataTable>
+...]]></programlisting>
+
+ <para>
+ The <emphasis role="bold"><property><rich:columns></property></emphasis> component does not prevent to use
+ <emphasis role="bold"><property><rich:column></property></emphasis>.
+ In the following example one column renders in any way and another columns could be picked from the model:
+ </para>
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[...
+<rich:dataTable value="#{rowBean.rows}" var="row">
+ <rich:column>
+ <h:outputText value ="#{row.columnValue}"/>
+ </rich:column>
+ <rich:columns value="#{colBean.columns}" var="col">
+ <f:facet name="header">
+ <h:outputText value="#{col.header}"/>
+ </f:facet>
+ <h:outputText value="#{row.columnValue}"/>
+ <f:facet name="footer">
+ <h:outputText value="#{col.footer}"/>
+ </f:facet>
+ </rich:columns>
+</rich:dataTable>
+...]]></programlisting>
</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><rich:columns></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><rich:columns></property>
+ </emphasis> component</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section>
+ <title>Skin Parameters Redefinition</title>
+
+ <para>Skin parameters redefinition for <emphasis role="bold">
+ <property><rich:columns></property>
+ </emphasis> are the same as for the <emphasis role="bold">
+ <property><rich:dataTable></property>
+ </emphasis> <link linkend="SPR">component</link>.</para>
+ </section>
+ <section>
+ <title>Definition of Custom Style Classes</title>
+
+ <para>Custom style classes for <emphasis role="bold">
+ <property><rich:columns></property>
+ </emphasis> are the same as for the <emphasis role="bold">
+ <property><rich:dataTable></property>
+ </emphasis> <link linkend="DofCCS">component</link>.
+ </para>
+
+ <para>In order to redefine styles for all <emphasis role="bold">
+ <property><rich:columns></property>
+ </emphasis> components on a page using CSS, it'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><rich:columns></property>
+ </emphasis> components, define your own style classes in the corresponding <emphasis
+ role="bold">
+ <property><rich:columns></property>
+ </emphasis>attributes.</para>
+ </section>
+ <section>
+ <title>Relevant Resources Links</title>
+ <para><ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/dataTable.jsf?c=columns"
+ >Here</ulink> you can see the example of <emphasis role="bold"
+ ><property><rich:columns></property></emphasis> usage and sources for the given example. </para>
+ </section>
</section>
\ No newline at end of file
More information about the richfaces-svn-commits
mailing list