Author: vkorluzhenko Date: 2007-10-30 10:53:57 -0400 (Tue, 30 Oct 2007) New Revision: 3618 Modified: trunk/docs/userguide/en/src/main/docbook/included/tree.xml Log: http://jira.jboss.com/jira/browse/RF-1137 - improved description Modified: trunk/docs/userguide/en/src/main/docbook/included/tree.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2007-10-30 12:50:43 UTC (rev 3617) +++ trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2007-10-30 14:53:57 UTC (rev 3618) @@ -45,9 +45,8 @@ <section> <title>Creating the Component with a Page Tag</title> <para>There are two cases for a tree definition: together with <emphasis role="bold"> - <property>&lt;rich:recursiveTreeNodesAdaptor&gt;</property> - </emphasis> - and without it. In the first case, it&apos;s possible to define it without <emphasis> + <property>&lt;rich:recursiveTreeNodesAdaptor&gt;</property> + </emphasis> and without it. In the first case, it&apos;s possible to define it without <emphasis> <property>&quot;value&quot;</property> </emphasis> and <emphasis> <property>&quot;var&quot;</property> @@ -63,8 +62,8 @@ </rich:tree> ...]]></programlisting> - <para> In the second case, it&apos;s necessary to define it with these attributes as it&apos;s - shown below: </para> + <para> In the second case, it&apos;s necessary to define it with these attributes as + it&apos;s shown below: </para> <para> <emphasis role="bold">Example:</emphasis> @@ -89,31 +88,34 @@ HtmlTree myPanel = new HtmlTree(); ...]]></programlisting> </section> - <section> + <section> <title>Details of Usage</title> - <para>As it has been mentioned <link linkend="tree">above</link> the tree component allows + <para>As it has been mentioned <link linkend="tree">above</link> the tree component allows rendering any tree-like structure of data.</para> <para>A bean property is passed into a tree <emphasis> <property>&quot;value&quot;</property> - </emphasis> attribute. The property keeps a structure of an <ulink - url="http://labs.jboss.com/file-access/default/members/jbossrichface... - >org.richfaces.component.TreeNode</ulink> type.</para> - <para>There is a default class TreeNodeImpl which is used for TreeNode interface implementation. - XmlTreeDataBuilder class allows transforming XML into structures of objects with XmlNodeData - type which could be represented by the tree component. TreeNode has attribute <emphasis> + </emphasis> attribute. The property keeps a structure of + <property>&quot;TreeNode&quot;</property> type instances.</para> + <para>There is a default class <property>&quot;TreeNodeImpl&quot;</property>, which is a + default implementation for TreeNode interface. TreeNode has attribute <emphasis> <property>&quot;data&quot;</property> </emphasis> which value is available as request scope variable with name that is defined by <emphasis> <property>&quot;var&quot;</property> - </emphasis> attribute of tree component. </para> + </emphasis> attribute of tree component. <ulink + url="http://labs.jboss.com/file-access/default/members/jbossrichface... + >&quot;XmlTreeDataBuilder&quot; class</ulink> allows transforming XML into + structures of objects containing &quot;XmlNodeData&quot; instances as data, which + could be represented by the tree component. </para> <para>For particular visual representation of data <emphasis role="bold"> <property>&lt;rich:tree&gt;</property> </emphasis> selects one of the children treeNode components by type. The type is defined with the <emphasis> <property>&quot;nodeFace&quot;</property> - </emphasis> attribute that contains a value of <emphasis> + </emphasis> attribute that corresponds to a value of <emphasis> <property>&quot;type&quot;</property> - </emphasis> attribute for treeNode. An example of definition is placed below: </para> + </emphasis> attribute for <property>treeNode</property>. An example of definition is placed + below: </para> <para> <emphasis role="bold">Example:</emphasis> @@ -149,17 +151,20 @@ <para>In case when <emphasis> <property>&quot;nodeFace&quot;</property> </emphasis> attribute isn&apos;t defined or defined but its value isn&apos;t equal to - any type of all children treeNode components or this value is equal to some type, but the - value of <emphasis> + any type of all children <property>treeNode</property> components or this value is equal to + some type, but the value of <emphasis> <property>&quot;rendered&quot;</property> - </emphasis> attribute for this treeNode is not defined then default treeNode is used. </para> + </emphasis> attribute for this <property>treeNode</property> is + <property>&quot;false&quot;</property> then default <property>treeNode</property> is + used. </para> - <para>Default treeNode is the first node (with not defined <emphasis> + <para>Default <property>treeNode</property> is the first node (with not defined <emphasis> <property>&quot;type&quot;</property> </emphasis> attribute and defined <emphasis> <property>&quot;rendered&quot;</property> - </emphasis> attribute) from all children nodes of the tree component. If such treeNode - wasn&apos;t found, the following default interior presentation is used: </para> + </emphasis> attribute) from all children nodes of the tree component. If such + <property>treeNode</property> wasn&apos;t found, the following default interior + presentation is used: </para> <para> <emphasis role="bold">Example:</emphasis> @@ -199,7 +204,7 @@ </h:form> ...]]></programlisting> - <para> The example represents definition of two different treeNode components. The first + <para> The example represents definition of two different treeNode components. The first specifies the album that&apos;s available for sale, the other specifies the album that is not available. The result is shown on the following screenshot: </para> @@ -233,7 +238,8 @@ <itemizedlist> <listitem>Ajax - Ajax submission is used for switching </listitem> <listitem>Server - regular form submition request is used</listitem> - <listitem>Client - switching is done as a whole on a client, no interaction with the server presents</listitem> + <listitem>Client - switching is done as a whole on a client, no interaction with the server + presents</listitem> </itemizedlist> <para>If <emphasis> @@ -285,10 +291,9 @@ <property>&quot;value&quot;</property> </emphasis> and <emphasis> <property>&quot;var&quot;</property> - </emphasis>. Besides, visual representation shouldn&apos;t be defined right in the tree. There is - possibility to use common attributes such as <emphasis> - <property>&quot;ajaxSubmitSelection&quot;</property> - </emphasis>, for instance. </para> + </emphasis>. Besides, visual representation shouldn&apos;t be defined right in the tree. + In this case tree tag is intended mainly for defining common attributes such as + <property>&quot;ajaxSubmitSelection&quot;</property>, for instance. </para> </section> <section> @@ -448,8 +453,8 @@ <para>In order to redefine styles for all <emphasis role="bold"> <property>&lt;rich:tree&gt;</property> - </emphasis> components on a page using CSS, it&apos;s enough to create a class with the same - names and define necessary properties in them.</para> + </emphasis> components on a page using CSS, it&apos;s enough to create a class with the + same names and define necessary properties in them.</para> <para>To change styles of particular <emphasis role="bold"> <property>&lt;rich:tree&gt;</property>