[richfaces-svn-commits] JBoss Rich Faces SVN: r3569 - trunk/docs/userguide/en/src/main/docbook/included.

Author: smukhina Date: 2007-10-26 11:00:46 -0400 (Fri, 26 Oct 2007) New Revision: 3569 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 language is corrected 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-26 15:00:17 UTC (rev 3568) +++ trunk/docs/userguide/en/src/main/docbook/included/tree.desc.xml 2007-10-26 15:00:46 UTC (rev 3569) @@ -17,8 +17,8 @@ </imageobject> </mediaobject> </figure> - <para>On the screenshot above there is an example of the tree with expanded node. This node - contains its own node with several leaves. Besides, it&apos;s possible to choose different + <para>On the screenshot above, there is an example of the tree 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> <section> @@ -26,7 +26,7 @@ <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> + <para>This feature provides rich possibilities to change an appearance of a component into different styles.</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-26 15:00:17 UTC (rev 3568) +++ trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2007-10-26 15:00:46 UTC (rev 3569) @@ -47,7 +47,7 @@ <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’s possible to define it without <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> @@ -61,11 +61,9 @@ <rich:tree> <rich:recursiveTreeNodesAdaptor roots="#{fileSystemBean.sourceRoots}" var="item" nodes="#{item.nodes}" /> </rich:tree> -... -]]></programlisting> +...]]></programlisting> - - <para> In the second case, it&apos;s necessary to define it with these attributes as it’s + <para> In the second case, it&apos;s necessary to define it with these attributes as it&apos;s shown below: </para> <para> @@ -78,8 +76,7 @@ </rich:treeNode> ... </rich:tree> -... -]]></programlisting> +...]]></programlisting> </section> <section> <title>Creating the Component Dynamically Using Java</title> @@ -90,10 +87,9 @@ <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlTree; ... HtmlTree myPanel = new HtmlTree(); -... -]]></programlisting> +...]]></programlisting> </section> - <section> + <section> <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> @@ -102,22 +98,20 @@ </emphasis> attribute. The property keeps a structure of an <ulink url="http://labs.jboss.com/file-access/default/members/jbossrichface... - <para>There is a default class TreeNodeImpl which is used for treeNode interface implementation. + <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. </para> - <para><emphasis role="bold"> - <property>&lt;rich:treeNode&gt;</property> - </emphasis> has getValue method which is available in a request scope variable with name that - is defined by <emphasis> + type which could be represented by the tree component. 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> <para>For particular visual representation of data <emphasis role="bold"> <property>&lt;rich:tree&gt;</property> - </emphasis> selects by type one of the children treeNode components. The type is defined with + </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 value of <emphasis> + </emphasis> attribute that contains a value of <emphasis> <property>&quot;type&quot;</property> </emphasis> attribute for treeNode. An example of definition is placed below: </para> @@ -139,8 +133,7 @@ </rich:treeNode> </rich:tree> </h:form> -... - ]]></programlisting> +...]]></programlisting> <para>This is a result: </para> @@ -155,18 +148,18 @@ <para>In case when <emphasis> <property>&quot;nodeFace&quot;</property> - </emphasis> attribute isn&apos;t defined or defined but its value isn&amp;t equal to + </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> <property>&quot;rendered&quot;</property> </emphasis> attribute for this treeNode is not defined then default treeNode is used. </para> - <para> Default treeNode is the first node (with not defined <emphasis> + <para>Default treeNode 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 tree component. If such treeNode - wasn&apos;t found, following default interior presentation is used: </para> + </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> <para> <emphasis role="bold">Example:</emphasis> @@ -179,7 +172,7 @@ <property>&quot;var&quot;</property> </emphasis> attribute. </para> - <para> It&amp;s possible to define several treeNode components with equal values of <emphasis> + <para> It&amp;s possible to define several treeNode components with the equal values of <emphasis> <property>&quot;type&quot;</property> </emphasis> attribute and different values of <emphasis> <property>&quot;rendered&quot;</property> @@ -194,20 +187,20 @@ <h:form> <rich:tree style="width:300px" value="#{library.data}" var="item" nodeFace="#{item.type}"> <rich:treeNode type="artist" iconLeaf="/images/tree/singer.gif" icon="/images/tree/singer.gif" -rendered=”#{item.exist}”> +rendered="#{item.exist}"> <h:outputText value="#{item.name}" /> </rich:treeNode> <rich:treeNode type="artist" iconLeaf="/images/tree/singer.gif" icon="/images/tree/singer_absent.gif" -rendered=”#{not item.exist}”> +rendered="#{not item.exist}"> <h:outputText value="#{item.name}" /> </rich:treeNode> - … + ... </rich:tree> </h:form> ... - ]]></programlisting> +]]></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> @@ -224,7 +217,7 @@ </mediaobject> </figure> - <para> You can define an EL-expression for <emphasis> + <para>You can define an EL-expression for <emphasis> <property>&quot;nodeFace&quot;</property> </emphasis> attribute. See an example: </para> @@ -232,25 +225,23 @@ <emphasis role="bold">Example:</emphasis> </para> - <programlisting role="JAVA"><![CDATA[nodeFace="#{data.name != 'param-value' ? 'artist' : 'album'}" - ]]></programlisting> + <programlisting role="JAVA"><![CDATA[nodeFace="#{data.name != 'param-value' ? 'artist' : 'album'}" ]]></programlisting> - <para> Switching on treeNode could be performed in three modes. Modes could be specified with <emphasis> + <para>Switching on treeNode could be performed in three modes. Modes could be specified with <emphasis> <property>&quot;switchType&quot;</property> </emphasis> attribute. </para> <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, server iteration is - absent</listitem> + <listitem>Client - switching is done as a whole on a client, no interaction with the server presents</listitem> </itemizedlist> <para>If <emphasis> <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 server.</para> + </emphasis> than any change in selection initiates Ajax request to the server.</para> <para> The <emphasis> <property>&quot;icon&quot;</property> @@ -283,7 +274,6 @@ <f:facet name="iconLeaf"> <h:graphicImage value="/images/tree/song.gif " /> </f:facet> - ... </rich:tree> ... @@ -297,7 +287,7 @@ <property>&quot;value&quot;</property> </emphasis> and <emphasis> <property>&quot;var&quot;</property> - </emphasis>. Besides, visual representation shouldn’t be defined right in the tree. There is + </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> @@ -352,7 +342,7 @@ </row> <row> <entry>acceptedTypes</entry> - <entry>Drag zone names 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> @@ -364,12 +354,12 @@ </section> <section> <title>Events handling</title> - <para>Listeners classes that process events on server side are defined with the help:</para> + <para>Listeners classes that process events on the server side are defined with the help of:</para> <itemizedlist> <listitem>nodeSelectListener is called during request sending on a node selecting event (if request sending on this event is defined)</listitem> - <listitem>dropListener processes Drop event</listitem> - <listitem>dragListener processes Drug event</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> </itemizedlist> @@ -425,8 +415,8 @@ <tgroup cols="2"> <thead> <row> - <entry>Skin parameters for wrapper element</entry> - <entry>Properties corresponding to CSS parameter</entry> + <entry>Skin parameters for a wrapper element</entry> + <entry>Properties corresponding to a CSS parameter</entry> </row> </thead> <tbody> @@ -460,7 +450,7 @@ <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 class with the same + </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">