Author: artdaw Date: 2008-03-12 13:18:03 -0400 (Wed, 12 Mar 2008) New Revision: 6764 Modified: trunk/docs/userguide/en/src/main/docbook/included/treeNodesAdaptor.desc.xml trunk/docs/userguide/en/src/main/docbook/included/treeNodesAdaptor.xml Log: http://jira.jboss.com/jira/browse/RF-552 -Initial screenshot was changed. Details of Usage was edited, examples were verified. Modified: trunk/docs/userguide/en/src/main/docbook/included/treeNodesAdaptor.desc.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/treeNodesAdaptor.desc.xml 2008-03-12 16:15:56 UTC (rev 6763) +++ trunk/docs/userguide/en/src/main/docbook/included/treeNodesAdaptor.desc.xml 2008-03-12 17:18:03 UTC (rev 6764) @@ -8,24 +8,23 @@ <section> <title>Description</title> <para> - The <property>rich:treeNodesAdaptor</property> provides possibility to define data models and create representations for them. - </para> - - <figure> - <title>Expanded tree with <emphasis role="bold"><property>&lt;rich:treeNodesAdaptor&gt;</property></emphasis></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/treeNodesAdaptor1.png"/> - </imageobject> - </mediaobject> - </figure> - + The <emphasis role="bold"><property>&lt;rich:treeNodesAdaptor&gt;</property></emphasis> provides the possibility to define data models + and create representations for them. + </para> + <figure> + <title>Expanded tree with <emphasis role="bold"><property>&lt;rich:treeNodesAdaptor&gt;</property></emphasis></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/treeNodesAdaptor_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><para>Allows to define combined data models</para></listitem> + <listitem><para>Possibility to define nodes for processing via attributes</para></listitem> </itemizedlist> </section> </section> Modified: trunk/docs/userguide/en/src/main/docbook/included/treeNodesAdaptor.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/treeNodesAdaptor.xml 2008-03-12 16:15:56 UTC (rev 6763) +++ trunk/docs/userguide/en/src/main/docbook/included/treeNodesAdaptor.xml 2008-03-12 17:18:03 UTC (rev 6764) @@ -46,29 +46,27 @@ <section> <title>Creating the Component with a Page Tag</title> - <para>To create the simplest variant of <property>rich:treeNodesAdaptor</property> on a page, use the - following syntax:</para> - + <!--para> + In order to create the simplest variant of <emphasis role="bold"><property>&lt;rich:treeNodesAdaptor&gt;</property></emphasis> on a page use the + following syntax: + </para--> <para> <emphasis role="bold">Example:</emphasis> </para> <programlisting role="XML"><![CDATA[... <rich:treeNodesAdaptor var="issue" nodes="#{model.issues}"> - ... - <rich:treeNode> - <!-- node content --> - </rich:treeNode> - ... - <!-- Others nodes --> - ... + <rich:treeNode> + <h:commandLink action="#{project.click}" value="Project: #{project.name}" /> + </rich:treeNode> + ... + <!-- Others nodes --> + ... </rich:treeNodesAdaptor> -... -]]></programlisting> +...]]></programlisting> </section> <section> <title>Creating the Component Dynamically Using Java</title> - <para> <emphasis role="bold">Example:</emphasis> </para> @@ -82,8 +80,21 @@ <section> <title>Details of Usage</title> <para> - <emphasis role="bold">The typical variant of using:</emphasis> + The <emphasis role="bold"><property>&lt;rich:treeNodesAdaptor&gt;</property></emphasis> component + has a <emphasis><property>&quot;nodes&quot;</property></emphasis> attribute that defines a collection of elements to iterate through. </para> + <para> + Collections are allowed to include lists, arrays, maps, XML NodeList and NamedNodeMap either as a single object. + </para> + <para> + The <emphasis><property>&quot;var&quot;</property></emphasis> attribute is used to access to the current collection element. + </para> + <para> + The simple example is placed below. + </para> + <para> + <emphasis role="bold">Example:</emphasis> + </para> <programlisting role="XML"><![CDATA[... <rich:tree adviseNodeOpened="#{treeModelBean.adviseNodeOpened}" switchType="client"> <rich:treeNodesAdaptor id="project" nodes="#{loaderBean.projects}" var="project"> @@ -113,8 +124,9 @@ </section> <section> <title>Relevant Resources Links</title> - <para><ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/treeNodesAd... - >Here</ulink> you can see the example of <emphasis role="bold" - ><property>&lt;rich:treeNodesAdaptor &gt;</property></emphasis> usage and sources for the given example. </para> + <para> + <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/treeNodesAd... + >Here</ulink> you can see the example of <emphasis role="bold"><property>&lt;rich:treeNodesAdaptor &gt;</property></emphasis> + usage and sources for the given example. </para> </section> </section>