[richfaces-svn-commits] JBoss Rich Faces SVN: r3722 - in trunk: docs/userguide/en/src/main/docbook/included and 1 other directories.

Author: vkorluzhenko Date: 2007-11-02 11:10:39 -0400 (Fri, 02 Nov 2007) New Revision: 3722 Modified: trunk/cdk/generator/src/main/resources/META-INF/schema/entities/draggable_attributes.ent trunk/docs/userguide/en/src/main/docbook/included/tree.xml trunk/ui/tree/src/main/config/component/tree.xml Log: http://jira.jboss.com/jira/browse/RF-696 - fixed errors in description of attributes Modified: trunk/cdk/generator/src/main/resources/META-INF/schema/entities/draggable_attributes.ent =================================================================== --- trunk/cdk/generator/src/main/resources/META-INF/schema/entities/draggable_attributes.ent 2007-11-02 15:08:10 UTC (rev 3721) +++ trunk/cdk/generator/src/main/resources/META-INF/schema/entities/draggable_attributes.ent 2007-11-02 15:10:39 UTC (rev 3722) @@ -7,12 +7,12 @@ <property> <name>dragType</name> <classname>java.lang.String</classname> - <description><![CDATA[Key of a drag object. It's used to define a necessity of processing the current dragged element on the drop zone side]]></description> + <description><![CDATA[Defines a drag zone type that is used for definition of a dragged element, which can be accepted by a drop zone]]></description> </property> <property> <name>dragIndicator</name> <classname>java.lang.String</classname> - <description><![CDATA[Id of the dragIndicator component used as drag operation cursor]]></description> + <description><![CDATA[Id of a component that is used as drag pointer during the drag operation]]></description> </property> <property > <name>ondragstart</name> Modified: trunk/docs/userguide/en/src/main/docbook/included/tree.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2007-11-02 15:08:10 UTC (rev 3721) +++ trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2007-11-02 15:10:39 UTC (rev 3722) @@ -46,8 +46,9 @@ <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> 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> + </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> @@ -101,7 +102,8 @@ <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 a request scope variable with a 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 a <property>tree</property> component. <ulink url="http://labs.jboss.com/file-access/default/members/jbossrichface... @@ -310,38 +312,38 @@ <section> <title>Built-In Drag and Drop</title> <para>The <emphasis role="bold"> - <property>&lt;rich: tree&gt;</property> - </emphasis> component functionality provides a built-in support for Drag and Drop operations. + <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>. As - <property>treeNodes</property> could be Drag, Drop or DnD elements, a <property>tree</property> can include the following - attributes groups.</para> + >&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> <tgroup cols="2"> <thead> <row> <entry>dragValue</entry> - <entry>Element value drag passing into processing after a Drop event.</entry> + <entry>Element value drag passing into processing after a Drop event</entry> </row> </thead> <tbody> <row> <entry>dragListener</entry> - <entry>A listener that processes a Drag event. </entry> + <entry>A listener that processes a Drag event</entry> </row> <row> <entry>dragIndicator</entry> - <entry>An indicator component id.</entry> + <entry>Id of a component that is used as drag pointer during the drag operation</entry> </row> <row> <entry>dragType</entry> - <entry>A Drag zone name used to define whether processing is necessary with a Drop zone - or not.</entry> + <entry>Defines a drag zone type that is used for definition of a dragged element, which + can be accepted by a drop zone</entry> </row> </tbody> </tgroup> @@ -380,7 +382,8 @@ 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 <property>treeNode</property></listitem> + <listitem>changeExpandListener processes expand/collapse event of a + <property>treeNode</property></listitem> </itemizedlist> <para>Listener methods can be defined using the <link linkend="treeNodeKF">following @@ -403,12 +406,11 @@ <property>&quot;onmousedown&quot;</property> </emphasis>, <emphasis> <property>&quot;onmouseover&quot;</property> - </emphasis> and etc. could be used. Event handlers of a <emphasis - role="bold"> + </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> + </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> <title>Look-and-Feel Customization</title> @@ -422,7 +424,7 @@ <listitem>to redefine corresponding skin parameters</listitem> <listitem>to add <emphasis> <property>style classes</property> - </emphasis> used by the <property>tree</property> to your page style sheets</listitem> + </emphasis> used by the <property>tree</property> to your page style sheets</listitem> </itemizedlist> </section> <section> @@ -430,7 +432,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>treeNodes</property>. 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> Modified: trunk/ui/tree/src/main/config/component/tree.xml =================================================================== --- trunk/ui/tree/src/main/config/component/tree.xml 2007-11-02 15:08:10 UTC (rev 3721) +++ trunk/ui/tree/src/main/config/component/tree.xml 2007-11-02 15:10:39 UTC (rev 3722) @@ -53,7 +53,7 @@ &ui_component_attributes; &ajax_component_attributes; &html_style_attributes; - &html_events; + &html_events; <property> <name>stateVar</name> @@ -111,7 +111,7 @@ <property> <name>dragIndicator</name> <classname>java.lang.String</classname> - <description>An indicator component id</description> + <description>Id of a component that is used as drag pointer during the drag operation</description> </property> <property> <name>value</name> @@ -194,7 +194,7 @@ <name>dragValue</name> <classname>java.lang.Object</classname> <description> - Data to be sent to the drop zone after a drop event + Data to be sent to the drop zone after a drop event </description> <defaultvalue>getRowKey()</defaultvalue> </property> @@ -203,53 +203,53 @@ <name>dropValue</name> <classname>java.lang.Object</classname> <description> - Data to be processed after a drop event + Data to be processed after a drop event </description> <defaultvalue>getRowKey()</defaultvalue> - </property> - - <property> - <name>toggleOnClick</name> - <classname>boolean</classname> - <description> - If "false" do not toggle node state on click. - If "true", than node will be toggles on click on ether node content, - or node icon. - Default value is false. - </description> - <defaultvalue>false</defaultvalue> + </property> + + <property> + <name>toggleOnClick</name> + <classname>boolean</classname> + <description> + If "false" do not toggle node state on click. + If "true", than node will be toggles on click on ether node content, + or node icon. + Default value is false. + </description> + <defaultvalue>false</defaultvalue> </property> - - <property> - <name>stateAdvisor</name> - <classname>java.lang.Object</classname> + + <property> + <name>stateAdvisor</name> + <classname>java.lang.Object</classname> <description> ValueBinding pointing at instance of class implementing org.richfaces.component.state.TreeStateAdvisor interface. - </description> - </property> - <property> - <name>adviseNodeOpened</name> - <classname>javax.faces.el.MethodBinding</classname> + </description> + </property> + <property> + <name>adviseNodeOpened</name> + <classname>javax.faces.el.MethodBinding</classname> <description> MethodBinding pointing at a method accepting an org.richfaces.component.UITree with return of java.lang.Boolean type. If returned value is: java.lang.Boolean. TRUE, a particular treeNode is expanded; java.lang.Boolean.FALSE, a particular treeNode is collapsed; null, a particular treeNode saves the current state - </description> - <methodargs>org.richfaces.component.UITree</methodargs> - </property> - <property> - <name>adviseNodeSelected</name> - <classname>javax.faces.el.MethodBinding</classname> + </description> + <methodargs>org.richfaces.component.UITree</methodargs> + </property> + <property> + <name>adviseNodeSelected</name> + <classname>javax.faces.el.MethodBinding</classname> <description> MethodBinding pointing at a method accepting an org.richfaces.component.UITree with return of java.lang.Boolean type. If returned value is: java.lang.Boolean. TRUE, a particular treeNode is selected; java.lang.Boolean.FALSE, a particular treeNode is unselected; null, a particular treeNode saves the current state - </description> - <methodargs>org.richfaces.component.UITree</methodargs> + </description> + <methodargs>org.richfaces.component.UITree</methodargs> </property> </component>