From richfaces-svn-commits at lists.jboss.org Thu Aug 30 14:30:24 2007
Content-Type: multipart/mixed; boundary="===============3901034291895011834=="
MIME-Version: 1.0
From: richfaces-svn-commits at lists.jboss.org
To: richfaces-svn-commits at lists.jboss.org
Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r2628 - in
 trunk/docs/userguide/en/src/main: resources/images and 1 other directory.
Date: Thu, 30 Aug 2007 14:30:24 -0400
Message-ID: <E1IQome-0003Cj-JV@committer01.frg.pub.inap.atl.jboss.com>

--===============3901034291895011834==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: vkukharchuk
Date: 2007-08-30 14:30:24 -0400 (Thu, 30 Aug 2007)
New Revision: 2628

Added:
   trunk/docs/userguide/en/src/main/docbook/included/treeNodes.desc.xml
   trunk/docs/userguide/en/src/main/docbook/included/treeNodes.xml
   trunk/docs/userguide/en/src/main/resources/images/treeNodes1.png
Log:
http://jira.jboss.com/jira/browse/RF-658

Added: trunk/docs/userguide/en/src/main/docbook/included/treeNodes.desc.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/docs/userguide/en/src/main/docbook/included/treeNodes.desc.xml	  =
                      (rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/treeNodes.desc.xml	20=
07-08-30 18:30:24 UTC (rev 2628)
@@ -0,0 +1,33 @@
+<?xml version=3D"1.0" encoding=3D"UTF-8"?>
+<section>
+    <sectioninfo>
+        <keywordset>
+            <keyword>treeNodes</keyword>
+        </keywordset>
+    </sectioninfo>
+    <section>
+        <title>Description</title>
+        <para>
+		The <property>rich:treeNodes</property> provides possibility to combine =
<property>rich:treeNode</property>
+		to logical groups.
+		</para>
+		=

+		<figure>
+        <title>Expanded tree with treeNodes</title>    =

+		<mediaobject> =

+			<imageobject>
+				<imagedata fileref=3D"images/treeNodes1.png"/>
+			</imageobject>
+		</mediaobject>
+		</figure>
+		=

+    </section>	=

+    <section>
+        <title>Key Features</title>
+        <itemizedlist>
+			<listitem>Allows to define set of nodes</listitem>
+            <listitem>No developers JavaScript writing needed to use on th=
e pages</listitem>
+			<listitem>Built-in Ajax processing</listitem>
+        </itemizedlist>
+    </section>
+</section>

Added: trunk/docs/userguide/en/src/main/docbook/included/treeNodes.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/docs/userguide/en/src/main/docbook/included/treeNodes.xml	       =
                 (rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/treeNodes.xml	2007-08=
-30 18:30:24 UTC (rev 2628)
@@ -0,0 +1,183 @@
+<?xml version=3D'1.0' encoding=3D'UTF-8'?>
+<section>
+  <sectioninfo>
+    <keywordset>
+      <keyword>treeNodes</keyword>
+      <keyword>rich:treeNodes</keyword>
+      <keyword>HtmlTreeNodes</keyword>
+    </keywordset>
+  </sectioninfo>
+
+  <table>
+    <title>Component identification parameters </title>
+    <tgroup cols=3D"2">
+      <thead>
+        <row>
+          <entry>Name</entry>
+          <entry>Value</entry>
+        </row>
+      </thead>
+      <tbody>
+        <row>
+          <entry>component-type</entry>
+          <entry>org.richfaces.TreeNodes</entry>
+        </row>
+        <row>
+          <entry>component-class</entry>
+          <entry>org.richfaces.component.html.HtmlTreeNodes</entry>
+        </row>
+        <row>
+          <entry>component-family</entry>
+          <entry>org.richfaces.TreeNodes</entry>
+        </row>
+        <!--
+		<row>
+          <entry>renderer-type</entry>
+          <entry>org.richfaces.EffectRenderer</entry>
+        </row>
+		-->
+        <row>
+          <entry>tag-class</entry>
+          <entry>org.richfaces.taglib.TreeNodesTag</entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </table>
+
+  <section>
+    <title>Creating the Component with a Page Tag</title>
+    <para>To create the simplest variant of <property>rich:treeNodes</prop=
erty> on a page, use the
+      following syntax:</para>
+
+    <para>
+      <emphasis role=3D"bold">Example:</emphasis>
+    </para>
+    <programlisting role=3D"XML"><![CDATA[...
+<rich:treeNodes var=3D"issue" nodes=3D"#{model.issues}">
+	...
+	<rich:treeNode>
+		<!-- node content -->							=

+	</rich:treeNode>
+	... =

+	<!-- Others nodes -->							=

+	...
+</rich:treeNodes>
+...
+]]></programlisting>
+  </section>
+
+  <section>
+    <title>Creating the Component Dynamically Using Java</title>
+
+    <para>
+      <emphasis role=3D"bold">Example:</emphasis>
+    </para>
+    <programlisting role=3D"JAVA"><![CDATA[import org.richfaces.component.=
html.HtmlTreeNodes;
+...
+HtmlTreeNodes myTreeNodes =3D new HtmlTreeNodes();
+...
+]]></programlisting>
+  </section>
+<!--
+  <section>
+    <title>Details of Usage</title>
+<para>	=

+	It is possible to use <property>&lt;rich:effect&gt;</property> in two mod=
es: =

+<itemizedlist>
+        <listitem>attached to the JSF components or html tags and triggere=
d by particular event.
+		Wiring effect with JSF components might be occurs on the server or clien=
t.
+		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 jav=
ascript function with defined name. When the function is called,
+		the effect is applied </listitem>
+</itemizedlist>
+</para>
+    <para>
+      <emphasis role=3D"bold">Those a the typical variants of using:</emph=
asis>
+    </para>
+    <programlisting role=3D"XML"><![CDATA[...
+
+<rich:panel>
+	<rich:effect event=3D"onmouseout" type=3D"Opacity" params=3D"duration:0.8=
,from:1.0,to:0.3" />
+    .... panel content ....
+</rich:panel>
+...
+
+
+<div id=3D"contentDiv">
+  ..... div content ......
+</div>
+
+<input type=3D"button" onclick=3D"hideDiv({duration:0.7})" value=3D"Hide" =
/>
+<input type=3D"button" onclick=3D"showDiv()" value=3D"Show" />
+
+<rich:effect  name=3D"hideDiv"  for=3D"contentDiv" type=3D"Fade" />
+<rich:effect  name=3D"showDiv"  for=3D"contentDiv" type=3D"Appear" />
+
+
+<rich:effect for=3D"window" event=3D"onload" type=3D"Appear" params=3D"id:=
'contentDiv',duration:0.8,from:0.3,to:1.0" />
+...
+]]></programlisting>
+
+    <figure>
+      <title>Initial:</title>
+
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref=3D"images/effect1.png"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
+	=

+	<figure>
+      <title>When the mouse cursor is over:</title>
+
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref=3D"images/effect0.png"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
+
+<para>
+<emphasis><property>&quot;name&quot;</property></emphasis> attribute defin=
es the name of the javascript function will
+be generated on the page when the component is rendered. You can invoke th=
is 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 defin=
es 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 define=
s the id of the component or html tag, the effect will be attached to.
+Richfaces converts the <emphasis><property>&quot;for&quot;</property></emp=
hasis> 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 point=
ed to. However, the target element
+is might be overridden with <emphasis><property>&quot;effectId&quot;</prop=
erty></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 all=
ows to define the set of options possible for particurar effect.
+For example, 'duration', 'delay', 'from', 'to'. Additionally to the option=
s 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></emp=
hasis> 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></e=
mphasis> 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=3D"http://livedemo.exadel.com/richfaces-demo/richfaces/ef=
fect.jsf?c=3Deffect">Here</ulink>
+      you can see the example of <emphasis role=3D"bold">&lt;rich:effect&g=
t;</emphasis> usage. </para>
+  </section>
+  =

+  -->
+</section>

Added: trunk/docs/userguide/en/src/main/resources/images/treeNodes1.png
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
(Binary files differ)


Property changes on: trunk/docs/userguide/en/src/main/resources/images/tree=
Nodes1.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream


--===============3901034291895011834==--