Author: smukhina Date: 2007-10-31 13:56:12 -0400 (Wed, 31 Oct 2007) New Revision: 3652 Modified: trunk/docs/userguide/en/src/main/docbook/included/tree.desc.xml trunk/docs/userguide/en/src/main/docbook/included/tree.xml Log: http://jira.jboss.com/jira/browse/RF-1137 correcting the language for tree component Modified: trunk/docs/userguide/en/src/main/docbook/included/tree.desc.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/tree.desc.xml 2007-10-31 17:33:32 UTC (rev 3651) +++ trunk/docs/userguide/en/src/main/docbook/included/tree.desc.xml 2007-10-31 17:56:12 UTC (rev 3652) @@ -17,7 +17,7 @@ </imageobject> </mediaobject> </figure> - <para>On the screenshot above, there is an example of the tree with an expanded node. This node + <para>On the screenshot above, there is an example of the <property>tree</property> with an expanded node. This node contains its own node with several leaves. Besides, it&apos;s possible to choose your own icons for tree nodes.</para> </section> @@ -31,9 +31,11 @@ <listitem> <para>Built-in drag and drop support</para> - <para>This feature allows changing a placement of nodes in a tree simply by dropping a certain node from one place to another. Look at the screenshot below:</para> + <para>This feature allows programming DnD possibility for the <emphasis role="bold"> + <property>&lt;rich:tree&gt;</property> + </emphasis> component so that it would be possible to change a placement of nodes in a <property>tree</property> simply by dropping a certain node from one place to another. Look at the screenshot below:</para> <figure> - <title>Drag and drop feature of a tree</title> + <title>Drag and drop support</title> <mediaobject> <imageobject> <imagedata fileref="images/tree3.png"/> @@ -50,7 +52,7 @@ </listitem> <listitem> - <para>Support of a visual representation for different node types</para> + <para>Possibility to define a visual representation by node type</para> </listitem> <listitem> Modified: trunk/docs/userguide/en/src/main/docbook/included/tree.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2007-10-31 17:33:32 UTC (rev 3651) +++ trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2007-10-31 17:56:12 UTC (rev 3652) @@ -46,7 +46,8 @@ <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> + </emphasis> or <emphasis role="bold"> + <property>&lt;rich:treeNodesAdaptor&gt;</property></emphasis> and without them. 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> @@ -85,7 +86,7 @@ </para> <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlTree; ... -HtmlTree myPanel = new HtmlTree(); +HtmlTree myTree = new HtmlTree(); ...]]></programlisting> </section> <section> @@ -100,9 +101,9 @@ <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> + </emphasis> which value is available as a request scope variable with a name that is defined by <emphasis> <property>&quot;var&quot;</property> - </emphasis> attribute of tree component. <ulink + </emphasis> attribute of a tree component. <ulink url="http://labs.jboss.com/file-access/default/members/jbossrichface... structures of objects containing <property>&quot;XmlNodeData&quot;</property> @@ -142,7 +143,7 @@ <para>This is a result: </para> <figure> - <title>Expanded tree with child elements of different types</title> + <title>Expanded tree with child elements</title> <mediaobject> <imageobject> <imagedata fileref="images/tree2.png"/> @@ -255,7 +256,7 @@ <property>&quot;ajaxSubmitSelection&quot;</property> </emphasis> attribute value set to <emphasis> <property>&quot;true&quot;</property> - </emphasis> than any change in selection initiates Ajax request to the server.</para> + </emphasis> than any change in selection initiates an Ajax request to the server.</para> <para> The <emphasis> <property>&quot;icon&quot;</property> @@ -268,7 +269,6 @@ </emphasis> attributes define icons for the component. Also you can define icons using facets with the same names. If the facets are defined, the corresponding attributes are ignored and facets contents are used as icons. By default the width of a rendered facet area is 16px. </para> - <para> <emphasis role="bold">Example:</emphasis> </para> @@ -301,7 +301,7 @@ </emphasis> and <emphasis> <property>&quot;var&quot;</property> </emphasis>. Besides, visual representation shouldn&apos;t be defined right in the - <property>tree</property>. In this case tree tag is intended mainly for defining common + <property>tree</property>. In this case a tree tag is intended mainly for defining common attributes such as <emphasis> <property>&quot;ajaxSubmitSelection&quot;</property> </emphasis>, for instance. </para> @@ -309,14 +309,16 @@ </section> <section> <title>Built-In Drag and Drop</title> - <para>The tree component functionality provides a built-in support for Drag and Drop operations. + <para>The <emphasis role="bold"> + <property>&lt;rich: tree&gt;</property> + </emphasis> component functionality provides a built-in support for Drag and Drop operations. The main usage principles are the same as for RichFaces DnD wrapper components. Hence, to get additional information on the topic, read the corresponding chapters:<link linkend="dndParam" - >&quot;rich:dndParam&quot;</link> - <link linkend="dragSupport">&quot;rich:dragSupport&quot;</link> - <link linkend="dragIndicator">&quot;rich:dragIndicator&quot;</link> - <link linkend="dropSupport">&quot;rich:dropSupport&quot;</link> - <property>Tree nodes</property> could be Drag, Drop or DnD elements, so tree has both + >&quot;rich:dndParam&quot;</link>, + <link linkend="dragSupport">&quot;rich:dragSupport&quot;</link>, + <link linkend="dragIndicator">&quot;rich:dragIndicator&quot;</link>, + <link linkend="dropSupport">&quot;rich:dropSupport&quot;</link>. As + <property>treeNodes</property> could be Drag, Drop or DnD elements, a <property>tree</property> can include the following attributes groups.</para> <table> <title>Drag attributes group</title> @@ -329,12 +331,16 @@ </thead> <tbody> <row> + <entry>dragListener</entry> + <entry>A listener that processes a Drag event. </entry> + </row> + <row> <entry>dragIndicator</entry> <entry>An indicator component id.</entry> </row> <row> <entry>dragType</entry> - <entry>A drag zone name used to define whether processing is necessary with a Drop zone + <entry>A Drag zone name used to define whether processing is necessary with a Drop zone or not.</entry> </row> </tbody> @@ -352,11 +358,11 @@ <tbody> <row> <entry>dropListener</entry> - <entry>A listener that processes a drop event. </entry> + <entry>A listener that processes a Drop event. </entry> </row> <row> <entry>acceptedTypes</entry> - <entry>Drag zone names are allowed to be processed with a drop zone.</entry> + <entry>Drag zone names are allowed to be processed with a Drop zone.</entry> </row> <row> <entry>typeMapping</entry> @@ -374,10 +380,10 @@ request sending on this event is defined)</listitem> <listitem>dropListener processes a Drop event</listitem> <listitem>dragListener processes a Drug event</listitem> - <listitem>changeExpandListener processes expand/collapse event of a tree node</listitem> + <listitem>changeExpandListener processes expand/collapse event of a <property>treeNode</property></listitem> </itemizedlist> - <para>Listener methods can be defined using the <link linkend="treeNode">following + <para>Listener methods can be defined using the <link linkend="treeNodeKF">following attributes</link> or using nested tags.</para> <para>Client event attributes are:</para> <itemizedlist> @@ -397,8 +403,11 @@ <property>&quot;onmousedown&quot;</property> </emphasis>, <emphasis> <property>&quot;onmouseover&quot;</property> - </emphasis> and etc. could be used. Event handlers of a tree component capture events occured - on any tree part. But event handlers of treeNode capture events occured on treeNode only, + </emphasis> and etc. could be used. Event handlers of a <emphasis + role="bold"> + <property>&lt;rich:tree&gt;</property> + </emphasis> component capture events occured + on any <property>tree</property> part. But event handlers of <property>treeNode</property> capture events occured on <property>treeNode</property> only, except for children events. </para> </section> <section> @@ -408,12 +417,12 @@ </emphasis>.</para> <para>Default style classes are mapped on <emphasis><property>skin parameters</property>.</emphasis></para> - <para>To redefine an appearance of all trees at once, there are two ways:</para> + <para>To redefine an appearance of all <property>trees</property> at once, there are two ways:</para> <itemizedlist> <listitem>to redefine corresponding skin parameters</listitem> <listitem>to add <emphasis> <property>style classes</property> - </emphasis> used by the tree to your page style sheets</listitem> + </emphasis> used by the <property>tree</property> to your page style sheets</listitem> </itemizedlist> </section> <section> @@ -421,7 +430,7 @@ <para>There is only one skin parameter for the <property>tree</property> since <emphasis role="bold"> <property>&lt;rich:tree&gt;</property> - </emphasis> is a wrapper component for <property>tree</property> nodes. Look and feel is + </emphasis> is a wrapper component for <property>treeNodes</property>. Look and feel is described in details in the <link linkend="treeNode">&quot;treeNode&quot; chapter</link>.</para> <table>