[richfaces-svn-commits] JBoss Rich Faces SVN: r6172 - trunk/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Tue Feb 19 11:14:49 EST 2008
Author: smukhina
Date: 2008-02-19 11:14:48 -0500 (Tue, 19 Feb 2008)
New Revision: 6172
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
Modified: trunk/docs/userguide/en/src/main/docbook/included/tree.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/tree.desc.xml 2008-02-19 15:34:30 UTC (rev 6171)
+++ trunk/docs/userguide/en/src/main/docbook/included/tree.desc.xml 2008-02-19 16:14:48 UTC (rev 6172)
@@ -52,7 +52,7 @@
</listitem>
<listitem>
- <para>Possibility to define a visual representation by node type</para>
+ <para>Possibility to define a visual representation by a 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 2008-02-19 15:34:30 UTC (rev 6171)
+++ trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2008-02-19 16:14:48 UTC (rev 6172)
@@ -44,7 +44,7 @@
<section>
<title>Creating the Component with a Page Tag</title>
- <para>There are two cases for a tree definition: together with <emphasis role="bold">
+ <para>There are two cases for a tree definition: with <emphasis role="bold">
<property><rich:recursiveTreeNodesAdaptor></property>
</emphasis> or <emphasis role="bold">
<property><rich:treeNodesAdaptor></property>
@@ -65,7 +65,7 @@
...]]></programlisting>
<para> In the second case, it's necessary to define it with these attributes as
- it's shown below: </para>
+ it's shown in the example: </para>
<para>
<emphasis role="bold">Example:</emphasis>
@@ -314,7 +314,7 @@
<para>As it has been mentioned <link linkend="tree">above</link> the <emphasis role="bold">
<property><rich:tree></property>
</emphasis> component allows rendering any tree-like data model.</para>
- <para>The component interacts with data model through
+ <para>The component interacts with data model via
<property>"TreeNode"</property> interface (<ulink
url="http://labs.jboss.com/file-access/default/members/jbossrichfaces/freezone/docs/apidoc_framework/org/richfaces/model/TreeNode.html"
>org.richfaces.model.TreeNode</ulink>) that is used for tree nodes representation. The <emphasis>
@@ -322,7 +322,7 @@
</emphasis> attribute of the <emphasis role="bold">
<property><rich:tree></property>
</emphasis> component contains a nodes structure defined in a bean property. The property
- keeps a structure of objects that implement <property>"TreeNode"</property>
+ keeps a structure of objects that implements <property>"TreeNode"</property>
interface.</para>
<para><property>"TreeNode"</property> has a property
<property>"data"</property> (see <ulink
@@ -349,7 +349,7 @@
<property><rich:tree></property>
</emphasis> component.</para>
<para>It's possible to define a visual representation of a data model node (to define a
- node icon) and its behavior in a compliance with data contained in this node (with a value of
+ node icon) and its behavior in correspondence with data contained in this node (with a value of
the <emphasis>
<property>"var"</property>
</emphasis> attribute). The node behavior is defined by components nested to the <emphasis
@@ -399,14 +399,14 @@
</figure>
<para>In the example when each node of data model is processed, data contained in the property
<property>"data"</property> of
- <property>"TreeNode"</property> interface are placed in a request scope
+ <property>"TreeNode"</property> interface is placed in a request scope
variable, which name is defined with <emphasis>
<property>"var"</property>
</emphasis> attribute. The value of the <emphasis>
<property>"nodeFace"</property>
- </emphasis> attribute is evaluated in compliance with data placed in the <emphasis>
+ </emphasis> attribute is evaluated in correspondence with data placed in the <emphasis>
<property>"var"</property>
- </emphasis> attribute. And for the node representation is used corresponding <emphasis
+ </emphasis> attribute. And for the node representation is used the corresponding <emphasis
role="bold">
<property><rich:treeNode></property>
</emphasis> component (with a value of <emphasis>
@@ -483,7 +483,7 @@
</emphasis> attribute and different values of <emphasis>
<property>"rendered"</property>
</emphasis> attribute. It provides the possibility to define different representation for the
- same nodes type. In the example with artists and their albums (see <link linkend="example"
+ same node types. In the example with artists and their albums (see <link linkend="example"
>above</link>) it's possible to represent albums that are available for sale and
albums that are not available. An example is placed below:</para>
<para>
@@ -523,9 +523,9 @@
<property><rich:treeNode></property>
</emphasis> components has equal values of the <emphasis>
<property>"type"</property>
- </emphasis> attribute. In a compliance with value of the <emphasis>
+ </emphasis> attribute. Depending on value of the <emphasis>
<property>"rendered"</property>
- </emphasis> attribute corresponding <emphasis role="bold">
+ </emphasis> attribute the corresponding <emphasis role="bold">
<property><rich:treeNode></property>
</emphasis> component is selected for node representation. If an album is available for sale
the value of the <emphasis>
@@ -543,10 +543,9 @@
</emphasis> component.</para>
<itemizedlist>
<listitem>Ajax (default value) - Ajax submission is used for switching. Note, that for
- collapse/expand operations it is sent an Ajax request to the server. It could be seen a
- short delay in this case.</listitem>
- <listitem>Server - regular form submission request is used. Note, that all nodes actually
- render up-front and expanding/collapsing do not require server call.</listitem>
+ collapse/expand operations, an Ajax request is sent to the server and it could cause a
+ short delay.</listitem>
+ <listitem>Server - regular form submission request is used.</listitem>
<listitem>Client - switching is done as a whole on a client, no interaction with a server
presents. Full page content is reloaded after every click.</listitem>
</itemizedlist>
@@ -560,7 +559,7 @@
<property>"iconLeaf"</property>
</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>
+ facets content is used as icons. By default the width of a rendered facet area is 16px. </para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
@@ -628,7 +627,7 @@
</row>
<row>
<entry>dragIndicator</entry>
- <entry>Id of a component that is used as drag pointer during the drag operation</entry>
+ <entry>Id of a component that is used as a drag pointer during the drag operation</entry>
</row>
<row>
<entry>dragType</entry>
@@ -729,7 +728,7 @@
<listitem>ondragexit is a script expression to invoke when an element passing out from a tree zone</listitem>
<listitem>ondragstart is a script expression to invoke when drag starts</listitem>
<listitem>ondragend is a script expression to invoke when drag ends (a drop event)</listitem>
- <listitem>ondragenter is a script expression to invoke when an dragged element appears on a tree</listitem>
+ <listitem>ondragenter is a script expression to invoke when a dragged element appears on a tree</listitem>
</itemizedlist>
<para>They can be used to add some JavaScript effects.</para>
More information about the richfaces-svn-commits
mailing list