Author: vkorluzhenko
Date: 2007-11-28 12:07:13 -0500 (Wed, 28 Nov 2007)
New Revision: 4319
Modified:
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.xml
trunk/docs/userguide/en/src/main/docbook/included/dataTable.xml
trunk/docs/userguide/en/src/main/docbook/included/poll.desc.xml
trunk/docs/userguide/en/src/main/docbook/included/poll.xml
trunk/docs/userguide/en/src/main/docbook/included/subTable.xml
Log:
http://jira.jboss.com/jira/browse/RF-657 - improved description
Modified: trunk/docs/userguide/en/src/main/docbook/included/dataDefinitionList.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dataDefinitionList.xml 2007-11-28
16:42:40 UTC (rev 4318)
+++ trunk/docs/userguide/en/src/main/docbook/included/dataDefinitionList.xml 2007-11-28
17:07:13 UTC (rev 4319)
@@ -145,7 +145,7 @@
<property>"id"</property>
</emphasis> attribute for <emphasis role="bold">
<property><rich:dataDefinitionList></property>
- </emphasis> component. As a result the component are updated after an Ajax
request.</para>
+ </emphasis> component. As a result the component is updated after an Ajax
request.</para>
</section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/dataGrid.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dataGrid.xml 2007-11-28 16:42:40 UTC
(rev 4318)
+++ trunk/docs/userguide/en/src/main/docbook/included/dataGrid.xml 2007-11-28 17:07:13 UTC
(rev 4319)
@@ -162,7 +162,7 @@
<property>"id"</property>
</emphasis> attribute for <emphasis role="bold">
<property><rich:dataGrid></property>
- </emphasis> component. As a result the component are updated after an Ajax
request.</para>
+ </emphasis> component. As a result the component is updated after an Ajax
request.</para>
</section>
<section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/dataList.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dataList.xml 2007-11-28 16:42:40 UTC
(rev 4318)
+++ trunk/docs/userguide/en/src/main/docbook/included/dataList.xml 2007-11-28 17:07:13 UTC
(rev 4319)
@@ -157,7 +157,7 @@
<property>"id"</property>
</emphasis> attribute for <emphasis role="bold">
<property><rich:dataList></property>
- </emphasis> component. As a result the component are updated after an Ajax
request.</para>
+ </emphasis> component. As a result the component is updated after an Ajax
request.</para>
</section>
<section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/dataOrderedList.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dataOrderedList.xml 2007-11-28
16:42:40 UTC (rev 4318)
+++ trunk/docs/userguide/en/src/main/docbook/included/dataOrderedList.xml 2007-11-28
17:07:13 UTC (rev 4319)
@@ -147,7 +147,7 @@
<property>"id"</property>
</emphasis> attribute for <emphasis role="bold">
<property><rich:dataOrderedList></property>
- </emphasis> component. As a result the component are updated after an Ajax
request.</para>
+ </emphasis> component. As a result the component is updated after an Ajax
request.</para>
</section>
<section>
<title>Look-and-Feel Customization</title>
Modified: trunk/docs/userguide/en/src/main/docbook/included/dataTable.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dataTable.xml 2007-11-28 16:42:40
UTC (rev 4318)
+++ trunk/docs/userguide/en/src/main/docbook/included/dataTable.xml 2007-11-28 17:07:13
UTC (rev 4319)
@@ -52,7 +52,9 @@
</para>
<programlisting role="XML"><![CDATA[...
<rich:dataTable value="#{capitalsBean.capitals}"
var="capitals">
- <!--...//Set of columns and header/footer facets-->
+ <rich:column>
+ ...
+ </rich:column>
</rich:dataTable>
...
]]></programlisting>
@@ -75,12 +77,12 @@
<property><rich:dataTable></property>
</emphasis> component is similar to the <emphasis
role="bold">
<property><h:dataTable></property>
- </emphasis> one, except Ajax support and skinnability . Ajax support is
possible, because the
+ </emphasis> one, except Ajax support and skinnability. Ajax support is
possible, because the
component was created basing on the <emphasis role="bold">
<property><a4j:repeat></property>
</emphasis> component and as a result it could be partially updated with
Ajax. <emphasis>
<property>"ajaxKeys"</property>
- </emphasis> attribute allows to define rows that are updated after an Ajax
request.</para>
+ </emphasis> attribute allows to define rows that is updated after an Ajax
request.</para>
<para>Here is an example:</para>
@@ -103,9 +105,9 @@
<property>"id"</property>
</emphasis> attribute for <emphasis role="bold">
<property><rich:dataTable></property>
- </emphasis> component. As a result the component are updated after an Ajax
request.</para>
+ </emphasis> component. As a result the component is updated after an Ajax
request.</para>
- <para>The component allows to use <emphasis>
+ <para id="table_ex">The component allows to use <emphasis>
<property>"header"</property>
</emphasis>, <emphasis>
<property>"footer"</property>
Modified: trunk/docs/userguide/en/src/main/docbook/included/poll.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/poll.desc.xml 2007-11-28 16:42:40
UTC (rev 4318)
+++ trunk/docs/userguide/en/src/main/docbook/included/poll.desc.xml 2007-11-28 17:07:13
UTC (rev 4319)
@@ -1,9 +1,10 @@
<?xml version='1.0' encoding='UTF-8'?>
<root>
-<section>
-<title>Description</title>
- <para>The <emphasis role="bold">
- <property><a4j:poll></property>
- </emphasis> component allows periodical sending of Ajax requests to the
server and is used for a page update according to a specified in milliseconds time
interval.</para>
-</section>
-</root>
\ No newline at end of file
+ <section>
+ <title>Description</title>
+ <para>The <emphasis role="bold">
+ <property><a4j:poll></property>
+ </emphasis> component allows periodical sending of Ajax requests to a
server and is
+ used for a page updating according to a specified time
interval.</para>
+ </section>
+</root>
Modified: trunk/docs/userguide/en/src/main/docbook/included/poll.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/poll.xml 2007-11-28 16:42:40 UTC
(rev 4318)
+++ trunk/docs/userguide/en/src/main/docbook/included/poll.xml 2007-11-28 17:07:13 UTC
(rev 4319)
@@ -1,57 +1,58 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter>
-
- <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.ajax4jsf.Poll</entry>
- </row>
- <row>
- <entry>component-family</entry>
- <entry>org.ajax4jsf.components.AjaxPoll</entry>
- </row>
- <row>
- <entry>component-class</entry>
- <entry>org.ajax4jsf.component.html.AjaxPoll</entry>
- </row>
- <row>
- <entry>renderer-type</entry>
- <entry>org.ajax4jsf.components.AjaxPollRenderer</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
+
+ <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.ajax4jsf.Poll</entry>
+ </row>
+ <row>
+ <entry>component-family</entry>
+ <entry>org.ajax4jsf.components.AjaxPoll</entry>
+ </row>
+ <row>
+ <entry>component-class</entry>
+ <entry>org.ajax4jsf.component.html.AjaxPoll</entry>
+ </row>
+ <row>
+ <entry>renderer-type</entry>
+ <entry>org.ajax4jsf.components.AjaxPollRenderer</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
<section>
<title>Creating on a page</title>
- <para>To use this component it's necessary only to set an update
interval.</para>
+ <para id="creating">To create the simplest variant on a page use the
following syntax:</para>
- <para>
+ <para>
<emphasis role="bold">Example:</emphasis>
- </para>
- <programlisting role="XML"><![CDATA[<a4j:poll
interval="1000" reRender="someDataTable"
action="#{bean.action1}"/>
+ </para>
+ <programlisting role="XML"><![CDATA[<a4j:poll
interval="500" reRender="grid"/>
]]></programlisting>
- <para>The <emphasis role="bold">
+ <!--para>The <emphasis role="bold">
<property><a4j:poll></property>
- </emphasis> component defined this way every second submits Ajax form onto
the server, performs the corresponding action and renders a components with the
<emphasis >
+ </emphasis> component defined this way every second submits Ajax form onto
the server,
+ performs the corresponding action and renders a components with the
<emphasis>
<property>"someDataTable"</property>
- </emphasis> id after a response comes back.</para>
+ </emphasis> id after a response comes back.</para-->
</section>
<section>
<title>Dynamical creation of a component from Java code</title>
- <para>
+ <para>
<emphasis role="bold">Example:</emphasis>
- </para>
+ </para>
<programlisting role="JAVA"><![CDATA[import
org.ajax4jsf.component.html.AjaxPoll;
...
AjaxPoll myPoll = new AjaxPoll();
@@ -60,35 +61,126 @@
</section>
<section>
<title>Key attributes and ways of usage</title>
- <para>The component decodes all necessary JavaScript for time count and on the
expiry of some interval for calling of a RichFaces utility method for Ajax request
sending (A4J.AJAX.Submit (Some request parameters)).
- </para>
- <para>
- The timer could be stopped or started in any time. The current state is controlled on
the component with the <emphasis >
+ <para id="attributes">The <emphasis role="bold">
+ <property><a4j:poll></property>
+ </emphasis> componet is used for periodical polling of a server. In order to
use the component
+ it's necessary to set an update interval. The <emphasis>
+ <property>"interval"</property>
+ </emphasis> attribute defines a polling interval in milliseconds beetween the
previous
+ response and the next request. The total period beetween two requests generated by
the
+ <emphasis role="bold">
+ <property><a4j:poll></property>
+ </emphasis> component is a sum of an<emphasis>
+ <property>"interval"</property>
+ </emphasis> attribute value and a server response time. Default value for
<emphasis>
+ <property>"interval"</property>
+ </emphasis> attribute is set to 1000 milliseconds (1 second). See an example
of definition in
+ the <link linkend="creating">"Creating on a page"
section</link>. </para>
+ <para>The <emphasis>
+ <property>"timeout"</property>
+ </emphasis> attribute defines response wating time in milliseconds. If the
response
+ isn't received during this period a connection is aborted and the next
request is
+ sent. Default value for <emphasis>
+ <property>"timeout"</property>
+ </emphasis> attribute isn't set.</para>
+ <para>The <emphasis>
+ <property>"enabled"</property>
+ </emphasis> attribute defines should the <emphasis
role="bold">
+ <property><a4j:poll></property>
+ </emphasis> send request or not. It's necessary to render the
+ <emphasis role="bold">
+ <property><a4j:poll></property>
+ </emphasis> to apply the current value of <emphasis>
+ <property>"enabled"</property>
+ </emphasis> attribute. You can use an EL-expression for <emphasis>
+ <property>"enabled"</property>
+ </emphasis> attribute to point to a bean property. An example of usage of
<link
+ linkend="attributes">all mentioned above attributes</link> is
placed below:</para>
+
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+
+ <programlisting role="XML"><![CDATA[...
+ <a4j:region>
+ <h:form>
+ <a4j:poll id="poll" interval="1000"
enabled="#{userBean.pollEnabled}" reRender="poll,grid"/>
+ </h:form>
+ </a4j:region>
+ <h:form>
+ <h:panelGrid columns="2" width="80%"
id="grid">
+ <h:panelGrid columns="1">
+ <h:outputText value="Polling Inactive" rendered="#{not
userBean.pollEnabled}"></h:outputText>
+ <h:outputText value="Polling Active"
rendered="#{userBean.pollEnabled}"></h:outputText>
+ <a4j:commandButton style="width:120px"
id="control"
+
value="#{userBean.pollEnabled?'Stop':'Start'} Polling"
+ reRender="poll, grid">
+ <a4j:actionparam name="polling"
value="#{!userBean.pollEnabled}"
+ assignTo="#{userBean.pollEnabled}"/>
+ </a4j:commandButton>
+ </h:panelGrid>
+ <h:outputText id="serverDate"
style="font-size:16px" value="Server Date: #{userBean.date}"/>
+ </h:panelGrid>
+ </h:form>
+...
+]]></programlisting>
+
+ <para>The example shows how date and time are updated on a page in compliance
with data taken
+ from a server. The <emphasis role="bold">
+ <property><a4j:poll></property>
+ </emphasis> componet sends requests to the server every second.
<emphasis>
+ <property>"reRender"</property>
+ </emphasis> attribute for <emphasis role="bold">
+ <property><a4j:poll></property>
+ </emphasis> contains value of own Id. Hence, it renders itself for applying
the current value
+ of <emphasis>
+ <property>"enabled"</property>
+ </emphasis> attribute.</para>
+
+ <!--It's also necessary to define an ID of the <emphasis
role="bold">
+ <property><a4j:poll></property>
+ </emphasis> componet in its <emphasis>
+ <property>"reRender"</property>
+ </emphasis> attribute to apply the current value of <emphasis>
+ <property>"enabled"</property>
+ </emphasis> attribute. </para>
+
+ <para>The component decodes all necessary JavaScript for time count and on the
expiry of some
+ interval for calling of a RichFaces utility method for Ajax request sending
(A4J.AJAX.Submit
+ (Some request parameters)). </para>
+ <para> The timer could be stopped or started in any time. The current state is
controlled on the
+ component with the <emphasis>
<property>"enabled"</property>
- </emphasis> attribute:
- </para>
- <programlisting role="XML"><![CDATA[<a4j:poll
interval="1000" enabled="#{bean.boolProperty}"/>
+ </emphasis> attribute: </para>
+ <programlisting role="XML"><![CDATA[<a4j:poll
interval="1000" enabled="#{bean.boolProperty}"/>
]]></programlisting>
-<para>As any RichFaces Action component, <emphasis role="bold">
+ <para>As any RichFaces Action component, <emphasis
role="bold">
<property><a4j:poll></property>
</emphasis> has all described in the <emphasis role="bold">
- <property><ulink
url="index.html#support"><a4j:support></ulink></property>
- </emphasis> chapter attributes to provide the necessary behavior of request
sending (delay, limitation of a submit and render area, requests frequency, and etc.). For
detailed information on these attributes see again the <emphasis
role="bold">
- <property><ulink
url="index.html#support"><a4j:support></ulink></property></emphasis>
component description.
- </para>
+ <property>
+ <ulink
url="index.html#support"><a4j:support></ulink>
+ </property>
+ </emphasis> chapter attributes to provide the necessary behavior of request
sending (delay,
+ limitation of a submit and render area, requests frequency, and etc.). For
detailed
+ information on these attributes see again the <emphasis
role="bold">
+ <property>
+ <ulink
url="index.html#support"><a4j:support></ulink>
+ </property>
+ </emphasis> component description. </para-->
</section>
-
+
<section>
<title>Relevant resources links</title>
-
+
<para><ulink
url="http://livedemo.exadel.com/richfaces-demo/richfaces/poll.jsf?c=...
- >Here</ulink> you can see the example of <emphasis
role="bold"
- ><property><a4j:poll></property></emphasis>
usage and sources for the given example. </para>
- <para>The aditional information about component usage you can find here :
<ulink
-
url="http://jboss.com/index.html?module=bb&op=viewtopic&...
- >RichFaces Users Forum</ulink>.</para>
-
+ >Here</ulink> you can see the example of <emphasis
role="bold">
+ <property><a4j:poll></property>
+ </emphasis> usage and sources for the given example. </para>
+ <para>The aditional information about component usage you can find here :
<ulink
+
url="http://jboss.com/index.html?module=bb&op=viewtopic&...
+ Users Forum</ulink>.</para>
+
</section>
-</chapter>
\ No newline at end of file
+</chapter>
Modified: trunk/docs/userguide/en/src/main/docbook/included/subTable.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/subTable.xml 2007-11-28 16:42:40 UTC
(rev 4318)
+++ trunk/docs/userguide/en/src/main/docbook/included/subTable.xml 2007-11-28 17:07:13 UTC
(rev 4319)
@@ -1,46 +1,46 @@
<?xml version='1.0' encoding='UTF-8'?>
<section>
-<sectioninfo>
-<keywordset>
-<keyword>rich:subtable</keyword>
-<keyword>HtmlSubTable</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.SubTable</entry>
- </row>
- <row>
- <entry>component-class</entry>
- <entry>org.richfaces.component.html.HtmlSubTable</entry>
- </row>
- <row>
- <entry>component-family</entry>
- <entry>org.richfaces.SubTable</entry>
- </row>
- <row>
- <entry>renderer-type</entry>
- <entry>org.richfaces.SubTableRenderer</entry>
- </row>
- <row>
- <entry>tag-class</entry>
- <entry>org.richfaces.taglib.SubTableTag</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
+ <sectioninfo>
+ <keywordset>
+ <keyword>rich:subtable</keyword>
+ <keyword>HtmlSubTable</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.SubTable</entry>
+ </row>
+ <row>
+ <entry>component-class</entry>
+ <entry>org.richfaces.component.html.HtmlSubTable</entry>
+ </row>
+ <row>
+ <entry>component-family</entry>
+ <entry>org.richfaces.SubTable</entry>
+ </row>
+ <row>
+ <entry>renderer-type</entry>
+ <entry>org.richfaces.SubTableRenderer</entry>
+ </row>
+ <row>
+ <entry>tag-class</entry>
+ <entry>org.richfaces.taglib.SubTableTag</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
<section>
<title>Creating the Component with a Page Tag</title>
<para>Here is a simple example as it could be used on a page:</para>
@@ -49,10 +49,14 @@
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
- <rich:dataTable value="#{capitalsBean.capitals}"
var="capitals">
- <!--...//Set of columns and header/footer facets-->
+ <rich:dataTable value="#{capitalsBean.capitals}"
var="capitals">
+ <rich:column>
+ ...
+ </rich:column>
<rich:subTable value=#{capitals.details} var="detail">
- <!--...//Set of columns and header/footer facets-->
+ <rich:column>
+ ...
+ </rich:column>
</rich:subTable>
</rich:dataTable>
...
@@ -72,77 +76,105 @@
</section>
<section>
<title>Details of Usage</title>
- <para>The <property>subtable</property> component is very similar to
the custom JSF dataTable one, the only difference is that
- the component doesn't add the wrapping <emphasis
role="bold"><property><table></property></emphasis>
and <emphasis
role="bold"><property><tbody></property></emphasis>
tags.
- Hence, it's possible to add a subtable structure different from the main one
to organize tables
- of the master - details type. The component is also has common peculiarities of any
rich component:</para>
- <itemizedlist>
- <listitem>Skin support. The table completely meets a three-class principle of
Rich Faces skinnability</listitem>
- <listitem>Support of Ajax updates for a limited set of rows</listitem>
- </itemizedlist>
- <para>Skins support is described in the <link
linkend="ArchitectureOverview">corresponding section</link>. Ajax
support is
- possible because the component is created basing on the <emphasis
role="bold"><property><a4j:repeat></property></emphasis>
component and as a result the
- component has its possibilities of Ajax updates for a limited set of rows. The
component is implemented
- with the <emphasis
><property>"ajaxKeys"</property></emphasis>
attribute for a table and in contrast to the <emphasis
role="bold"><property><a4j:repeat></property></emphasis>
outputs the standard HTML
- structure for table rendering.</para>
- <programlisting role="XML"><![CDATA[...
- <rich:dataTable value="#{capitalsBean.capitals}"
var="capitals" id="table">
- <!--...//Set of columns and header/footer facets-->
- <rich:subTable value="#{capitals.details}" var="detail"
ajaxKeys="#{bean.ajaxSet}" binding="#{bean.subtable}" >
- <!--...//Set of columns and header/footer facets-->
+
+ <para>The <emphasis role="bold">
+ <property><rich:subTable></property>
+ </emphasis> component is similar to the <emphasis
role="bold">
+ <property><h:dataTable></property>
+ </emphasis> one, except Ajax support and skinnability. One more difference is
that the
+ component doesn't add the wrapping <emphasis role="bold">
+ <property><table></property>
+ </emphasis> and <emphasis role="bold">
+ <property><tbody></property>
+ </emphasis> tags. Ajax support is possible, because the component was created
basing on the
+ <emphasis role="bold">
+ <property><a4j:repeat></property>
+ </emphasis> component and as a result it could be partially updated with
Ajax. <emphasis>
+ <property>"ajaxKeys"</property>
+ </emphasis> attribute allows to define rows that is updated after an Ajax
request.</para>
+
+ <para>Here is an example:</para>
+
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+
+ <programlisting role="XML"><![CDATA[...
+ <rich:dataTable value="#{capitalsBean.capitals}"
var="capitals">
+ <rich:column>
+ ...
+ </rich:column>
+ <rich:subTable value="#{capitals.details}" var="detail"
ajaxKeys="#{bean.ajaxSet}" binding="#{bean.subtable}"
id="subtable">
+ <rich:column>
+ ...
+ </rich:column>
</rich:subTable>
</rich:dataTable>
...
- <a4j:commandButton action="#{bean.someAction}"
reRender="table"/>
+ <a4j:commandButton action="#{tableBean.action}"
reRender="subtable"/>
...
]]></programlisting>
-<para>For such a table during someAction processing called with Ajax request when
the key is pressed
- it's possible to fill in lot's of ajaxKeys with strings indices that
are to be updated.
- A resulting output on the client contains only required rows and they are updated in the
tree, even
- when update is specified for the whole table.</para>
+ <para> In the example <emphasis>
+ <property>"reRender"</property>
+ </emphasis> attribute contains value of <emphasis>
+ <property>"id"</property>
+ </emphasis> attribute for <emphasis role="bold">
+ <property><rich:subTable></property>
+ </emphasis> component. As a result the component is updated after an Ajax
request.</para>
+
+ <para>The component allows to use <emphasis>
+ <property>"header"</property>
+ </emphasis> and <emphasis>
+ <property>"footer"</property>
+ </emphasis> facets for output. See an example for <emphasis
role="bold">
+ <property><rich:dataTable></property>
+ </emphasis>
+ <link linkend="table_ex">component</link>.</para>
+
</section>
-
- <section>
- <title>Look-and-Feel Customization</title>
-
- <para>For skinnability implementation, the components use a <emphasis>
+
+ <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">
+
+ <para>There are two ways to redefine the appearance of all <emphasis
role="bold">
<property><rich:subTable></property>
</emphasis> components at once:</para>
-
- <itemizedlist>
- <listitem>
- <para>Redefine the corresponding skin parameters</para>
- </listitem>
-
- <listitem>
- <para>Add to your style sheets <emphasis>
+
+ <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:subTable></property>
</emphasis> component</para>
- </listitem>
- </itemizedlist>
- </section>
-
+ </listitem>
+ </itemizedlist>
+ </section>
+
<section>
<title>Skin Parameters Redefinition</title>
-
+
<para>Skin parameters redefinition for <emphasis role="bold">
- <property><rich:subTable></property>
- </emphasis> are the same as for the <emphasis role="bold">
- <property><rich:dataTable></property>
- </emphasis> <link
linkend="SPR">component</link>.</para>
+ <property><rich:subTable></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>
-
+
<table>
<title>Classes names that define a component appearance</title>
<tgroup cols="2">
@@ -161,11 +193,11 @@
<entry>rich-subtable-caption</entry>
<entry>Defines styles for a "caption" facet
element</entry>
</row>
-
+
</tbody>
</tgroup>
</table>
-
+
<table>
<title>Classes names that define header and footer elements</title>
<tgroup cols="2">
@@ -176,12 +208,12 @@
</row>
</thead>
<tbody>
-
+
<row>
<entry>rich-subtable-header</entry>
<entry>Defines styles for a subtable header row</entry>
</row>
-
+
<row>
<entry>rich-subtable-header-continue</entry>
<entry>Defines styles for all subtable header lines after the
first</entry>
@@ -190,17 +222,17 @@
<entry>rich-subtable-subheader</entry>
<entry>Defines styles for a column header of subtable</entry>
</row>
-
+
<row>
<entry>rich-subtable-subfooter</entry>
<entry>Defines styles for a column footer of subtable</entry>
</row>
-
+
<row>
<entry>rich-subtable-footer</entry>
<entry>Defines styles for a subtable footer row</entry>
</row>
-
+
<row>
<entry>rich-subtable-footer-continue</entry>
<entry>Defines styles for all subtable footer lines after the
first</entry>
@@ -208,7 +240,7 @@
</tbody>
</tgroup>
</table>
-
+
<table>
<title>Classes names that define rows and cells</title>
<tgroup cols="2">
@@ -223,7 +255,7 @@
<entry>rich-subtable-headercell</entry>
<entry>Defines styles for a subtable header cell</entry>
</row>
-
+
<row>
<entry>rich-subtable-subheadercell</entry>
<entry>Defines styles for a column header cell of
subtable</entry>
@@ -240,30 +272,30 @@
<entry>rich-subtable-firstrow</entry>
<entry>Defines styles for a subtable start row</entry>
</row>
-
+
<row>
<entry>rich-subtable-subfootercell</entry>
<entry>Defines styles for a column footer cell of
subtable</entry>
</row>
-
+
<row>
<entry>rich-subtable-footercell</entry>
<entry>Defines styles for a subtable footer cell</entry>
</row>
-
+
</tbody>
</tgroup>
</table>
<para>In order to redefine styles for all <emphasis
role="bold">
- <property><rich:subTable></property>
- </emphasis> components on a page using CSS, it's enough to create
classes with the
+ <property><rich:subTable></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:subTable></property>
- </emphasis> components, define your own style classes in the corresponding
<emphasis
- role="bold">
- <property><rich:subTable></property>
- </emphasis>attributes.</para>
+ <property><rich:subTable></property>
+ </emphasis> components, define your own style classes in the corresponding
<emphasis
+ role="bold">
+ <property><rich:subTable></property>
+ </emphasis>attributes.</para>
</section>
-</section>
\ No newline at end of file
+</section>