Author: artdaw
Date: 2008-03-13 13:14:52 -0400 (Thu, 13 Mar 2008)
New Revision: 6792
Modified:
trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodesAdaptor.desc.xml
trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodesAdaptor.xml
Log:
http://jira.jboss.com/jira/browse/RF-658 -description edited.
Modified:
trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodesAdaptor.desc.xml
===================================================================
---
trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodesAdaptor.desc.xml 2008-03-13
17:14:27 UTC (rev 6791)
+++
trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodesAdaptor.desc.xml 2008-03-13
17:14:52 UTC (rev 6792)
@@ -7,26 +7,28 @@
</sectioninfo>
<section>
<title>Description</title>
- <para>
- The <property>rich:recursiveTreeNodesAdaptor</property> provides
possibility to define data models and process nodes recursively.
- </para>
-
- <figure>
- <title>Expanded tree with recursive <emphasis
role="bold"><property><rich:treeNodesAdaptor></property></emphasis></title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/recursiveTreeNodesAdaptor1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
+ <para>
+ The <emphasis
role="bold"><property><rich:recursiveTreeNodesAdaptor></property></emphasis>
is
+ an extension of a <emphasis
role="bold"><property><rich:treeNodesAdaptor></property></emphasis>
component
+ that provides the possibility to define data models and process nodes
recursively. </para>
+ <figure>
+ <title>Expanded tree with <emphasis role="bold">
+
<property><rich:recursiveTreeNodesAdaptor></property>
+ </emphasis></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/recursiveTreeNodesAdaptor_initial.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
</section>
<section>
<title>Key Features</title>
<itemizedlist>
- <listitem>Allows to define combined data models</listitem>
- <listitem>Possibility to define nodes for processing via
attributes</listitem>
- <listitem>Allows to process nodes recursively</listitem>
+ <listitem><para>Allows to define combined data
models</para></listitem>
+ <listitem><para>Possibility to define nodes for processing via
attributes</para></listitem>
+ <listitem><para>Allows to process nodes
recursively</para></listitem>
</itemizedlist>
</section>
</section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodesAdaptor.xml
===================================================================
---
trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodesAdaptor.xml 2008-03-13
17:14:27 UTC (rev 6791)
+++
trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodesAdaptor.xml 2008-03-13
17:14:52 UTC (rev 6792)
@@ -46,23 +46,14 @@
<section>
<title>Creating the Component with a Page Tag</title>
- <para>To create the simplest variant of
<property>rich:recursiveTreeNodesAdaptor</property> on a page, use the
- following syntax:</para>
-
- <para>
+ <para>
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
- <rich:recursiveTreeNodesAdaptor var="issue"
root="#{project.root}" nodes="#{model.issues}">
- ...
- <rich:treeNode>
- <!-- node content -->
- </rich:treeNode>
- <!-- Others nodes -->
- ...
- </rich:recursiveTreeNodesAdaptor>
-...
-]]></programlisting>
+<rich:tree switchType="ajax"
stateAdvisor="#{treeDemoStateAdvisor}">
+ <rich:recursiveTreeNodesAdaptor roots="#{fileSystemBean.sourceRoots}"
var="item" nodes="#{item.nodes}" />
+</rich:tree>
+...]]></programlisting>
</section>
<section>
@@ -80,8 +71,22 @@
<section>
<title>Details of Usage</title>
+ <para>
+ The <emphasis
role="bold"><property><rich:recursiveTreeNodesAdaptor></property></emphasis>
component has a
+
<emphasis><property>"roots"</property></emphasis>
attribute that defines collection to use at the top of recursion.
+ </para>
+ <para>
+ The
<emphasis><property>"nodes"</property></emphasis>
attribute defines collection to use on another recursion levels.
+ </para>
+ <para>
+ The
<emphasis><property>"var"</property></emphasis>
attribute is used to access to the current collection element.
+ </para>
+ <para>
+ The <emphasis
role="bold"><property><rich:recursiveTreeNodesAdaptor></property></emphasis>
component can be nested without any limitations.
+ See the following example.
+ </para>
<para>
- <emphasis role="bold">The typical variant of
using:</emphasis>
+ <emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
<rich:tree adviseNodeOpened="#{treeModelBean.adviseNodeOpened}"
switchType="client">
@@ -117,7 +122,8 @@
...
]]></programlisting>
- </section>
+ </section>
+
<!--
<section>
<title>Details of Usage</title>
@@ -212,12 +218,13 @@
</para>
</section>
- <section>
+
+
+-->
+ <section>
<title>Relevant resources links</title>
<para>
- <ulink
url="http://livedemo.exadel.com/richfaces-demo/richfaces/effect.jsf?...
- you can see the example of <emphasis
role="bold"><rich:effect></emphasis> usage.
</para>
+ <ulink
url="http://livedemo.exadel.com/richfaces-demo/richfaces/treeNodesAd...
+ you can see the example of <emphasis
role="bold"><property><rich:recursiveTreeNodesAdaptor></property></emphasis>
usage. </para>
</section>
-
- -->
</section>