Author: ochikvina
Date: 2007-10-26 05:33:12 -0400 (Fri, 26 Oct 2007)
New Revision: 3556
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 - replacing of all screenshots and final
corecting of the information
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-25 23:21:35
UTC (rev 3555)
+++ trunk/docs/userguide/en/src/main/docbook/included/tree.desc.xml 2007-10-26 09:33:12
UTC (rev 3556)
@@ -13,7 +13,7 @@
<title>Expanded tree with child elements</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/tree1.gif"/>
+ <imagedata fileref="images/tree1.png"/>
</imageobject>
</mediaobject>
</figure>
@@ -26,12 +26,25 @@
<itemizedlist>
<listitem>
<para>Highly customizable look-and-feel</para>
+ <para>This feature provides rich possibilities to change an
appearance of a component to different corresponding modern styles.</para>
</listitem>
- <para>This feature provides rich possibilities to change an appearance
of a component to different corresponding modern styles.</para>
+
<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>
+ <figure>
+ <title>Drag and drop feature of a tree</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/tree3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Here, an appropriate CD-disk is been moving from one album to the
next one.
+ </para>
</listitem>
- <para>This feature allows changing a sequence order of nodes in a tree
simply by dragging a certain node from one place to another.</para>
+
<listitem>
<para>Built-in Ajax processing</para>
</listitem>
Modified: trunk/docs/userguide/en/src/main/docbook/included/tree.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2007-10-25 23:21:35 UTC
(rev 3555)
+++ trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2007-10-26 09:33:12 UTC
(rev 3556)
@@ -44,8 +44,10 @@
<section>
<title>Creating the Component with a Page Tag</title>
- <para>There are two cases for a tree definition: without adapters and with
adapters. In the
- first case, it's necessary to define it with <emphasis>
+ <para>There are two cases for a tree definition: together with <emphasis
role="bold">
+ <property><rich:recursiveTreeNodesAdaptor></property>
+ </emphasis>
+ and without it. In the first case, it’s possible to define it without
<emphasis>
<property>"value"</property>
</emphasis> and <emphasis>
<property>"var"</property>
@@ -54,23 +56,27 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
+
<programlisting role="XML"><![CDATA[...
- <rich:tree value="#{library.data}" var="item" >
- <!--Set of the Tree nodes-->
+ <rich:tree>
+ <rich:recursiveTreeNodesAdaptor
roots="#{fileSystemBean.sourceRoots}" var="item"
nodes="#{item.nodes}" />
</rich:tree>
...
]]></programlisting>
- <para>In the second case, it’s possible to define it without these attributes
as it’s shown
- below. </para>
+ <para> In the second case, it's necessary to define it with these
attributes as it’s
+ shown below: </para>
+
<para>
<emphasis role="bold">Example:</emphasis>
</para>
-
<programlisting role="XML"><![CDATA[...
- <rich:tree>
- <rich:recursiveTreeNodesAdaptor
roots="#{fileSystemBean.sourceRoots}" var="item"
nodes="#{item.nodes}" />
+ <rich:tree value="#{library.data}" var="item" >
+ <rich:treeNode icon="/images/tree/singer.png" >
+ <h:outputText value="#{item.name}" />
+ </rich:treeNode>
+ ...
</rich:tree>
...
]]></programlisting>
@@ -91,8 +97,9 @@
<title>Details of Usage</title>
<para>As it has been mentioned <link
linked="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>"value"</property></emphasis>
- attribute. The property keeps a structure of an <ulink
+ <para>A bean property is passed into a tree <emphasis>
+ <property>"value"</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.
@@ -101,14 +108,18 @@
<para><emphasis role="bold">
<property><rich:treeNode></property>
</emphasis> has getValue method which is available in a request scope
variable with name that
- is defined by
<emphasis><property>"var"</property></emphasis>
attribute of tree component. </para>
+ is defined by <emphasis>
+ <property>"var"</property>
+ </emphasis> attribute of tree component. </para>
<para>For particular visual representation of data <emphasis
role="bold">
<property><rich:tree></property>
</emphasis> selects by type one of the children treeNode components. The type
is defined with
- the
<emphasis><property>"nodeFace"</property></emphasis>
attribute that contains value of
-
<emphasis><property>"type"</property></emphasis>
attribute for treeNode. An example of
- definition is placed below: </para>
+ the <emphasis>
+ <property>"nodeFace"</property>
+ </emphasis> attribute that contains value of <emphasis>
+ <property>"type"</property>
+ </emphasis> attribute for treeNode. An example of definition is placed below:
</para>
<para>
<emphasis role="bold">Example:</emphasis>
@@ -137,7 +148,7 @@
<title>Expanded tree with child elements of different types</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/tree3.png"/>
+ <imagedata fileref="images/tree2.png"/>
</imageobject>
</mediaobject>
</figure>
@@ -202,10 +213,10 @@
<figure>
<title> Using the <emphasis>
- <property>"type"</property>
- </emphasis> and the <emphasis>
- <property>"rendered"</property>
- </emphasis> attributes</title>
+ <property>"type"</property>
+ </emphasis> and the <emphasis>
+ <property>"rendered"</property>
+ </emphasis> attributes</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/tree4.png"/>
@@ -295,14 +306,14 @@
<section>
<title>Built-In Drag and Drop</title>
<para>The tree 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">"rich:dndParam"</link>
+ 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"
+ >"rich:dndParam"</link>
<link
linkend="dragSupport">"rich:dragSupport"</link>
<link
linkend="dragIndicator">"rich:dragIndicator"</link>
<link
linkend="dropSupport">"rich:dropSupport"</link>
- <property>Tree nodes</property> could be Drag, Drop or DnD elements, so
tree has both attributes
- groups.</para>
+ <property>Tree nodes</property> could be Drag, Drop or DnD elements, so
tree has both
+ attributes groups.</para>
<table>
<title>Drag attributes group</title>
<tgroup cols="2">
@@ -361,8 +372,9 @@
<listitem>dragListener processes Drug event</listitem>
<listitem>changeExpandListener processes expand/collapse event of a tree
node</listitem>
</itemizedlist>
-
- <para>Listener methods can be defined using the <link
linked="treeNode">following attributes</link> or using nested
tags.</para>
+
+ <para>Listener methods can be defined using the <link
linkend="treeNode">following
+ attributes</link> or using nested tags.</para>
<para>Client event attributes are:</para>
<itemizedlist>
<listitem>onexpand - expands a node event</listitem>
@@ -374,17 +386,16 @@
</itemizedlist>
<para>They can be used to add some JavaScript effects.</para>
-
+
<para> Also standart HTML event attributes like<emphasis>
- <property>"onclick"</property>
- </emphasis>, <emphasis>
- <property>"onmousedown"</property>
- </emphasis>, <emphasis>
- <property>"onmouseover"</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, except for
children
- events. </para>
+ <property>"onclick"</property>
+ </emphasis>, <emphasis>
+ <property>"onmousedown"</property>
+ </emphasis>, <emphasis>
+ <property>"onmouseover"</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,
+ except for children events. </para>
</section>
<section>
<title>Look-and-Feel Customization</title>