[richfaces-svn-commits] JBoss Rich Faces SVN: r2665 - in trunk/docs/userguide/en/src/main: resources/images and 1 other directory.

Author: vkukharchuk Date: 2007-08-31 12:23:02 -0400 (Fri, 31 Aug 2007) New Revision: 2665 Added: trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodes.desc.xml trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodes.xml trunk/docs/userguide/en/src/main/resources/images/recursiveTreeNodes1.png Modified: trunk/docs/userguide/en/src/main/docbook/included/treeNodes.desc.xml trunk/docs/userguide/en/src/main/docbook/included/treeNodes.xml Log: http://jira.jboss.com/jira/browse/RF-658 Added: trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodes.desc.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodes.desc.xml (rev 0) +++ trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodes.desc.xml 2007-08-31 16:23:02 UTC (rev 2665) @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section> + <sectioninfo> + <keywordset> + <keyword>recursiveTreeNodes</keyword> + </keywordset> + </sectioninfo> + <section> + <title>Description</title> + <para> + The <property>rich:recursiveTreeNodes</property> provides possibility to define data models and process nodes recursively. + </para> + + <figure> + <title>Expanded tree with recursiveTreeNodes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/recursiveTreeNodes1.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + <section> + <title>Key Features</title> + <itemizedlist> + <listitem>Allows to define combined data models</listitem> + <listitem>Possibility to define nodes for processing via attributes</listitem> + <listitem>Allows to process nodes recursively</listitem> + </itemizedlist> + </section> +</section> Added: trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodes.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodes.xml (rev 0) +++ trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodes.xml 2007-08-31 16:23:02 UTC (rev 2665) @@ -0,0 +1,233 @@ +<?xml version='1.0' encoding='UTF-8'?> +<section> + <sectioninfo> + <keywordset> + <keyword>recursiveTreeNodes</keyword> + <keyword>rich:recursiveTreeNodes</keyword> + <keyword>HtmlRecursiveTreeNodes</keyword> + </keywordset> + </sectioninfo> + + <table> + <title>Component identification parameters </title> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + <entry>Value</entry> + </row> + </thead> + <tbody> + <row> + <entry>component-type</entry> + <entry>org.richfaces.RecursiveTreeNodes</entry> + </row> + <row> + <entry>component-class</entry> + <entry>org.richfaces.component.html.HtmlRecursiveTreeNodes</entry> + </row> + <row> + <entry>component-family</entry> + <entry>org.richfaces.RecursiveTreeNodes</entry> + </row> + <!-- + <row> + <entry>renderer-type</entry> + <entry>org.richfaces.EffectRenderer</entry> + </row> + --> + <row> + <entry>tag-class</entry> + <entry>org.richfaces.taglib.RecursiveTreeNodesTag</entry> + </row> + </tbody> + </tgroup> + </table> + + <section> + <title>Creating the Component with a Page Tag</title> + <para>To create the simplest variant of <property>rich:recursiveTreeNodes</property> on a page, use the + following syntax:</para> + + <para> + <emphasis role="bold">Example:</emphasis> + </para> + <programlisting role="XML"><![CDATA[... + <rich:recursiveTreeNodes var="issue" root="#{project.root}" nodes="#{model.issues}"> + ... + <rich:treeNode> + <!-- node content --> + </rich:treeNode> + + <!-- Others nodes --> + ... + </rich:recursiveTreeNodes> +... +]]></programlisting> + </section> + + <section> + <title>Creating the Component Dynamically Using Java</title> + + <para> + <emphasis role="bold">Example:</emphasis> + </para> + <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlRecursiveTreeNodes; +... +HtmlRecursiveTreeNodes myRecursiveTreeNodes = new HtmlRecursiveTreeNodes(); +... +]]></programlisting> + </section> + + <section> + <title>Details of Usage</title> + <para> + <emphasis role="bold">The typical variant of using:</emphasis> + </para> + <programlisting role="XML"><![CDATA[... +<rich:tree adviseNodeOpened="#{treeModelBean.adviseNodeOpened}" switchType="client"> + <rich:treeNodes id="project" nodes="#{loaderBean.projects}" var="project"> + + <rich:treeNode> + <h:commandLink action="#{project.click}" value="Project: #{project.name}" /> + </rich:treeNode> + + <rich:recursiveTreeNodes id="dir" var="dir" root="#{project.dirs}" nodes="#{dir.directories}"> + + <rich:treeNode> + <h:commandLink action="#{dir.click}" value="Directory: #{dir.name}" /> + </rich:treeNode> + + <rich:treeNodes id="file" var="file" nodes="#{dir.files}"> + <rich:treeNode> + <h:commandLink action="#{file.click}" value="File: #{file.name}" /> + </rich:treeNode> + </rich:treeNodes> + + <rich:treeNodes id="file1" var="file" nodes="#{dir.files}"> + <rich:treeNode> + <h:commandLink action="#{file.click}" value="File1: #{file.name}" /> + </rich:treeNode> + </rich:treeNodes> + + <rich:recursiveTreeNodes id="archiveEntry" var="archiveEntry" + root="#{dir.files}" nodes="#{archiveEntry.archiveEntries}" + activeRoot="#{archiveEntry.class.simpleName == 'ArchiveFile'}" + activeNodes="#{archiveEntry.class.simpleName == 'ArchiveEntry'}"> + + <rich:treeNode id="archiveEntryNode"> + <h:commandLink action="#{archiveEntry.click}" value="Archive entry: #{archiveEntry.name}" /> + </rich:treeNode> + + </rich:recursiveTreeNodes> + + </rich:recursiveTreeNodes> + </rich:treeNodes> +</rich:tree> +... +]]></programlisting> + + </section> +<!-- + <section> + <title>Details of Usage</title> +<para> + It is possible to use <property>&lt;rich:effect&gt;</property> in two modes: +<itemizedlist> + <listitem>attached to the JSF components or html tags and triggered by particular event. + Wiring effect with JSF components might be occurs on the server or client. + Wiring with html tag is possible only on the client side </listitem> + <listitem>invoking from the javascript code by effect name. + During the rendering, <property>rich:effect</property> generates the javascript function with defined name. When the function is called, + the effect is applied </listitem> +</itemizedlist> +</para> + <para> + <emphasis role="bold">Those a the typical variants of using:</emphasis> + </para> + <programlisting role="XML"><![CDATA[... + +<rich:panel> + <rich:effect event="onmouseout" type="Opacity" params="duration:0.8,from:1.0,to:0.3" /> + .... panel content .... +</rich:panel> +... + + +<div id="contentDiv"> + ..... div content ...... +</div> + +<input type="button" onclick="hideDiv({duration:0.7})" value="Hide" /> +<input type="button" onclick="showDiv()" value="Show" /> + +<rich:effect name="hideDiv" for="contentDiv" type="Fade" /> +<rich:effect name="showDiv" for="contentDiv" type="Appear" /> + + +<rich:effect for="window" event="onload" type="Appear" params="id:'contentDiv',duration:0.8,from:0.3,to:1.0" /> +... +]]></programlisting> + + <figure> + <title>Initial:</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/effect1.png"/> + </imageobject> + </mediaobject> + </figure> + + <figure> + <title>When the mouse cursor is over:</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/effect0.png"/> + </imageobject> + </mediaobject> + </figure> + +<para> +<emphasis><property>&quot;name&quot;</property></emphasis> attribute defines the name of the javascript function will +be generated on the page when the component is rendered. You can invoke this function to activate the effect. The function access one parameter. +It is a set of effect options in JSON format. +</para> + +<para> +<emphasis><property>&quot;type&quot;</property></emphasis> attribute defines the type of effect. For example, "Fade", "Blind", "Opacity". Take a look at scriptaculous documentation +for set of available effect. +</para> + +<para> +<emphasis><property>&quot;for&quot;</property></emphasis> attribute defines the id of the component or html tag, the effect will be attached to. +Richfaces converts the <emphasis><property>&quot;for&quot;</property></emphasis> attribute value to the client id of the component if such component is found. If not, the value is left as is for possible +wiring with on the DOM element's id on the client side. +By default, the target of the effect is the same element that effect pointed to. However, the target element +is might be overridden with <emphasis><property>&quot;effectId&quot;</property></emphasis> option passed with <emphasis><property>&quot;params&quot;</property></emphasis> +attribute of with function paramenter. +</para> + +<para> +<emphasis><property>&quot;params&quot;</property></emphasis> attribute allows to define the set of options possible for particurar effect. +For example, 'duration', 'delay', 'from', 'to'. Additionally to the options used by the effect itself, there are two option that might override +the <property>rich:effect</property> attribute. Those are: +<itemizedlist> + <listitem><emphasis><property>&quot;effectId&quot;</property></emphasis> allows to re-define the target of effect. + The option is overrire the value of <emphasis><property>&quot;for&quot;</property></emphasis> attribute</listitem> + <listitem><emphasis><property>&quot;effectType&quot;</property></emphasis> defines the effect type. + The option is overrire the value of <emphasis><property>&quot;type&quot;</property></emphasis> attribute</listitem> +</itemizedlist> +</para> + + </section> + <section> + <title>Relevant resources links</title> + <para> + <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/effect.jsf?... + you can see the example of <emphasis role="bold">&lt;rich:effect&gt;</emphasis> usage. </para> + </section> + + --> +</section> Modified: trunk/docs/userguide/en/src/main/docbook/included/treeNodes.desc.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/treeNodes.desc.xml 2007-08-31 15:43:09 UTC (rev 2664) +++ trunk/docs/userguide/en/src/main/docbook/included/treeNodes.desc.xml 2007-08-31 16:23:02 UTC (rev 2665) @@ -8,8 +8,7 @@ <section> <title>Description</title> <para> - The <property>rich:treeNodes</property> provides possibility to combine <property>rich:treeNode</property> - to logical groups. + The <property>rich:treeNodes</property> provides possibility to define data models and create representations to them. </para> <figure> @@ -25,9 +24,9 @@ <section> <title>Key Features</title> <itemizedlist> - <listitem>Allows to define a set of nodes</listitem> - <listitem>No developers JavaScript writing needed to use it on pages</listitem> - <listitem>Built-in Ajax processing</listitem> + <listitem>Allows to define combined data models</listitem> + <listitem>Possibility to define nodes for processing via attributes</listitem> + <listitem>Allows to process nodes recursively</listitem> </itemizedlist> </section> </section> Modified: trunk/docs/userguide/en/src/main/docbook/included/treeNodes.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/treeNodes.xml 2007-08-31 15:43:09 UTC (rev 2664) +++ trunk/docs/userguide/en/src/main/docbook/included/treeNodes.xml 2007-08-31 16:23:02 UTC (rev 2665) @@ -78,106 +78,37 @@ ... ]]></programlisting> </section> -<!-- + <section> <title>Details of Usage</title> -<para> - It is possible to use <property>&lt;rich:effect&gt;</property> in two modes: -<itemizedlist> - <listitem>attached to the JSF components or html tags and triggered by particular event. - Wiring effect with JSF components might be occurs on the server or client. - Wiring with html tag is possible only on the client side </listitem> - <listitem>invoking from the javascript code by effect name. - During the rendering, <property>rich:effect</property> generates the javascript function with defined name. When the function is called, - the effect is applied </listitem> -</itemizedlist> -</para> <para> - <emphasis role="bold">Those a the typical variants of using:</emphasis> + <emphasis role="bold">The typical variant of using:</emphasis> </para> <programlisting role="XML"><![CDATA[... - -<rich:panel> - <rich:effect event="onmouseout" type="Opacity" params="duration:0.8,from:1.0,to:0.3" /> - .... panel content .... -</rich:panel> + <rich:tree adviseNodeOpened="#{treeModelBean.adviseNodeOpened}" switchType="client"> + <rich:treeNodes id="project" nodes="#{loaderBean.projects}" var="project"> + <rich:treeNode> + <h:commandLink action="#{project.click}" value="Project: #{project.name}" /> + </rich:treeNode> + <rich:treeNodes id="srcDir" var="srcDir" nodes="#{project.srcDirs}"> + <rich:treeNode> + <h:commandLink action="#{srcDir.click}" value="Source directory: #{srcDir.name}" /> + </rich:treeNode> + <rich:treeNodes id="pkg" var="pkg" nodes="#{srcDir.packages}"> + <rich:treeNode> + <h:commandLink action="#{pkg.click}" value="Package: #{pkg.name}" /> + </rich:treeNode> + <rich:treeNodes id="class" var="class" nodes="#{pkg.classes}"> + <rich:treeNode> + <h:commandLink action="#{class.click}" value="Class: #{class.name}" /> + </rich:treeNode> + </rich:treeNodes> + </rich:treeNodes> + </rich:treeNodes> + </rich:treeNodes> + </rich:tree> ... - - -<div id="contentDiv"> - ..... div content ...... -</div> - -<input type="button" onclick="hideDiv({duration:0.7})" value="Hide" /> -<input type="button" onclick="showDiv()" value="Show" /> - -<rich:effect name="hideDiv" for="contentDiv" type="Fade" /> -<rich:effect name="showDiv" for="contentDiv" type="Appear" /> - - -<rich:effect for="window" event="onload" type="Appear" params="id:'contentDiv',duration:0.8,from:0.3,to:1.0" /> -... ]]></programlisting> - <figure> - <title>Initial:</title> - - <mediaobject> - <imageobject> - <imagedata fileref="images/effect1.png"/> - </imageobject> - </mediaobject> - </figure> - - <figure> - <title>When the mouse cursor is over:</title> - - <mediaobject> - <imageobject> - <imagedata fileref="images/effect0.png"/> - </imageobject> - </mediaobject> - </figure> - -<para> -<emphasis><property>&quot;name&quot;</property></emphasis> attribute defines the name of the javascript function will -be generated on the page when the component is rendered. You can invoke this function to activate the effect. The function access one parameter. -It is a set of effect options in JSON format. -</para> - -<para> -<emphasis><property>&quot;type&quot;</property></emphasis> attribute defines the type of effect. For example, "Fade", "Blind", "Opacity". Take a look at scriptaculous documentation -for set of available effect. -</para> - -<para> -<emphasis><property>&quot;for&quot;</property></emphasis> attribute defines the id of the component or html tag, the effect will be attached to. -Richfaces converts the <emphasis><property>&quot;for&quot;</property></emphasis> attribute value to the client id of the component if such component is found. If not, the value is left as is for possible -wiring with on the DOM element's id on the client side. -By default, the target of the effect is the same element that effect pointed to. However, the target element -is might be overridden with <emphasis><property>&quot;effectId&quot;</property></emphasis> option passed with <emphasis><property>&quot;params&quot;</property></emphasis> -attribute of with function paramenter. -</para> - -<para> -<emphasis><property>&quot;params&quot;</property></emphasis> attribute allows to define the set of options possible for particurar effect. -For example, 'duration', 'delay', 'from', 'to'. Additionally to the options used by the effect itself, there are two option that might override -the <property>rich:effect</property> attribute. Those are: -<itemizedlist> - <listitem><emphasis><property>&quot;effectId&quot;</property></emphasis> allows to re-define the target of effect. - The option is overrire the value of <emphasis><property>&quot;for&quot;</property></emphasis> attribute</listitem> - <listitem><emphasis><property>&quot;effectType&quot;</property></emphasis> defines the effect type. - The option is overrire the value of <emphasis><property>&quot;type&quot;</property></emphasis> attribute</listitem> -</itemizedlist> -</para> - </section> - <section> - <title>Relevant resources links</title> - <para> - <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/effect.jsf?... - you can see the example of <emphasis role="bold">&lt;rich:effect&gt;</emphasis> usage. </para> - </section> - - --> </section> Added: trunk/docs/userguide/en/src/main/resources/images/recursiveTreeNodes1.png =================================================================== (Binary files differ) Property changes on: trunk/docs/userguide/en/src/main/resources/images/recursiveTreeNodes1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream