From richfaces-svn-commits at lists.jboss.org Tue Feb  1 01:40:03 2011
Content-Type: multipart/mixed; boundary="===============7913330567397451876=="
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: r21346 - in
 modules/docs/trunk/Component_Reference/src/main/docbook/en-US: extras and 1
 other directory.
Date: Tue, 01 Feb 2011 01:40:03 -0500
Message-ID: <201102010640.p116e3cT025262@svn01.web.mwc.hst.phx2.redhat.com>

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

Author: SeanRogers
Date: 2011-02-01 01:40:03 -0500 (Tue, 01 Feb 2011)
New Revision: 21346

Added:
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exa=
m-Component_Reference-richtreeModelAdaptor-Nested_richtreeModelAdaptor_comp=
onents.xml_sample
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exa=
m-Component_Reference-richtreeModelRecursiveAdaptor-Basic_usage.xml_sample
Modified:
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo=
nent_Reference-Trees.xml
Log:
Added tree adaptors RFPL-976

Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha=
p-Component_Reference-Trees.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
--- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Trees.xml	2011-01-31 23:13:58 UTC (rev 21345)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Trees.xml	2011-02-01 06:40:03 UTC (rev 21346)
@@ -14,30 +14,6 @@
 		Read this chapter for details on components that use tree structures.
 	</para>
 =

-	<!-- TODO not in M5 -->
-	<!--
-	<section id=3D"sect-Component_Reference-Trees-richchangeExpandListener">
-		<title><sgmltag>&lt;rich:changeExpandListener&gt;</sgmltag></title>
-		<para>
-			Incomplete
-		</para>
-	</section>
-	=

-	<section id=3D"sect-Component_Reference-Trees-richnodeSelectListener">
-		<title><sgmltag>&lt;rich:nodeSelectListener&gt;</sgmltag></title>
-		<para>
-			Incomplete
-		</para>
-	</section>
-	=

-	<section id=3D"sect-Component_Reference-Trees-richrecursiveTreeNodesAdapt=
er">
-		<title><sgmltag>&lt;rich:recursiveTreeNodesAdapter&gt;</sgmltag></title>
-		<para>
-			Incomplete
-		</para>
-	</section>
-	-->
-	=

 	<section id=3D"sect-Component_Reference-Trees-richtree">
 		<title><sgmltag>&lt;rich:tree&gt;</sgmltag></title>
 		<para>
@@ -394,14 +370,120 @@
 		</section>
 	</section>
 =

-	<!--
-	<section id=3D"sect-Component_Reference-Trees-richtreeNodesAdapter">
-		<title><sgmltag>&lt;rich:treeNodesAdapter&gt;</sgmltag></title>
+	<section id=3D"sect-Component_Reference-Trees-Tree_adaptors">
+		<title>Tree adaptors</title>
 		<para>
-			Incomplete
+			Use a tree adaptor to create a tree and populate it with data from a de=
fined data model.
 		</para>
+
+		<section id=3D"sect-Component_Reference-Tree_adaptors-richtreeModelAdapt=
or">
+			<title><sgmltag>&lt;rich:treeModelAdaptor&gt;</sgmltag></title>
+			<para>
+				The <sgmltag>&lt;rich:treeModelAdaptor&gt;</sgmltag> component takes a=
 defined data model and uses it to populate an associated <sgmltag>&lt;rich=
:tree&gt;</sgmltag> component.
+			</para>
+
+			<section id=3D"sect-Component_Reference-richtreeModelAdaptor-Basic_usag=
e">
+				<title>Basic usage</title>
+				<para>
+					The <sgmltag>&lt;rich:treeModelAdaptor&gt;</sgmltag> component is add=
ed as a nested child component to the <sgmltag>&lt;rich:tree&gt;</sgmltag> =
component it will populate.
+				</para>
+				<para>
+					The <sgmltag>&lt;rich:treeModelAdaptor&gt;</sgmltag> component requir=
es the <varname>nodes</varname> attribute for basic usage. The <varname>nod=
es</varname> attribute defines a collection of elements to iterate through =
for populating the tree.
+				</para>
+			</section>
+
+			<section id=3D"sect-Component_Reference-richtreeModelAdaptor-Multiple_l=
evels">
+				<title>Multiple levels</title>
+				<para>
+					<sgmltag>&lt;rich:treeModelAdaptor&gt;</sgmltag> components can furth=
er be nested in other <sgmltag>&lt;rich:treeModelAdaptor&gt;</sgmltag> comp=
onents to subsequently populate lower levels of the tree.
+				</para>
+				<para>
+					Use the <varname>var</varname> attribute to access the current collec=
tion element at each level. <xref linkend=3D"exam-Component_Reference-richt=
reeModelAdaptor-Nested_richtreeModelAdaptor_components" /> demonstrates a s=
eries of nested <sgmltag>&lt;rich:treeModelAdaptor&gt;</sgmltag> components=
, each using the parent's <varname>var</varname> attribute to reference the=
 current element.
+				</para>
+				<example id=3D"exam-Component_Reference-richtreeModelAdaptor-Nested_ri=
chtreeModelAdaptor_components">
+					<title><sgmltag>Nested &lt;rich:treeModelAdaptor&gt; components</sgml=
tag></title>
+					<programlisting language=3D"XML" role=3D"XML"><xi:include parse=3D"te=
xt" href=3D"extras/exam-Component_Reference-richtreeModelAdaptor-Nested_ric=
htreeModelAdaptor_components.xml_sample" xmlns:xi=3D"http://www.w3.org/2001=
/XInclude" /></programlisting>
+				</example>
+			</section>
+
+			<section id=3D"sect-Component_Reference-richtreeModelAdaptor-Reference_=
data">
+				<title>Reference data</title>
+				<itemizedlist>
+					<listitem>
+						<para>
+							<parameter>component-type</parameter>: <classname>org.richfaces.tre=
eModelAdaptor</classname>
+						</para>
+					</listitem>
+					<listitem>
+						<para>
+							<parameter>component-class</parameter>: <classname>org.richfaces.co=
mponent.html.HtmltreeModelAdaptor</classname>
+						</para>
+					</listitem>
+					<listitem>
+						<para>
+							<parameter>component-family</parameter>: <classname>org.richfaces.t=
reeModelAdaptor</classname>
+						</para>
+					</listitem>
+					<listitem>
+						<para>
+							<parameter>tag-class</parameter>: <classname>org.richfaces.taglib.t=
reeModelAdaptorTag</classname>
+						</para>
+					</listitem>
+				</itemizedlist>
+			</section>
+		</section>
+
+		<section id=3D"sect-Component_Reference-Tree_adaptors-richtreeModelRecur=
siveAdaptor">
+			<title><sgmltag>&lt;rich:treeModelRecursiveAdaptor&gt;</sgmltag></title>
+			<para>
+				The <sgmltag>&lt;rich:treeModelRecursiveAdaptor&gt;</sgmltag> componen=
t recursively populates a tree with hierarchical nodes, such as for a file =
system with multiple levels of directories and files.
+			</para>
+
+			<section id=3D"sect-Component_Reference-richtreeModelRecursiveAdaptor-B=
asic_usage">
+				<title>Basic usage</title>
+				<para>
+					The <sgmltag>&lt;rich:treeModelRecursiveAdaptor&gt;</sgmltag> compone=
nt is an extension of the <sgmltag>&lt;rich:treeModelAdaptor&gt;</sgmltag> =
component. As such, the <sgmltag>&lt;rich:treeModelRecursiveAdaptor&gt;</sg=
mltag> component uses all of the same attributes. Refer to <xref linkend=3D=
"sect-Component_Reference-Tree_adaptors-richtreeModelAdaptor" /> for detail=
s on the <sgmltag>&lt;rich:treeModelAdaptor&gt;</sgmltag> component.
+				</para>
+				<para>
+					In addition, the <sgmltag>&lt;rich:treeModelRecursiveAdaptor&gt;</sgm=
ltag> component requires the <varname>root</varname> attribute. The <varnam=
e>root</varname> attribute defines the collection to use at the top of the =
recursion.
+				</para>
+				<para>
+					<xref linkend=3D"exam-Component_Reference-richtreeModelRecursiveAdapt=
or-Basic_usage" /> demonstrates how the <sgmltag>&lt;rich:treeModelRecursiv=
eAdaptor&gt;</sgmltag> component can be used in conjunction with the <sgmlt=
ag>&lt;rich:treeModelAdaptor&gt;</sgmltag> component to recursively iterate=
 through a file system and create a tree of directories and files.
+				</para>
+				<example id=3D"exam-Component_Reference-richtreeModelRecursiveAdaptor-=
Basic_usage">
+					<title>Basic usage</title>
+					<programlisting language=3D"XML" role=3D"XML"><xi:include parse=3D"te=
xt" href=3D"extras/exam-Component_Reference-richtreeModelRecursiveAdaptor-B=
asic_usage.xml_sample" xmlns:xi=3D"http://www.w3.org/2001/XInclude" /></pro=
gramlisting>
+				</example>
+			</section>
+
+			<section id=3D"sect-Component_Reference-richtreeModelRecursiveAdaptor-R=
eference_data">
+				<title>Reference data</title>
+				<itemizedlist>
+					<listitem>
+						<para>
+							<parameter>component-type</parameter>: <classname>org.richfaces.tre=
eModelRecursiveAdaptor</classname>
+						</para>
+					</listitem>
+					<listitem>
+						<para>
+							<parameter>component-class</parameter>: <classname>org.richfaces.co=
mponent.html.HtmltreeModelRecursiveAdaptor</classname>
+						</para>
+					</listitem>
+					<listitem>
+						<para>
+							<parameter>component-family</parameter>: <classname>org.richfaces.t=
reeModelRecursiveAdaptor</classname>
+						</para>
+					</listitem>
+					<listitem>
+						<para>
+							<parameter>tag-class</parameter>: <classname>org.richfaces.taglib.t=
reeModelRecursiveAdaptorTag</classname>
+						</para>
+					</listitem>
+				</itemizedlist>
+			</section>
+		</section>
+		=

 	</section>
-	-->
 	=

 </chapter>
 =


Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras=
/exam-Component_Reference-richtreeModelAdaptor-Nested_richtreeModelAdaptor_=
components.xml_sample
=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
--- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex=
am-Component_Reference-richtreeModelAdaptor-Nested_richtreeModelAdaptor_com=
ponents.xml_sample	                        (rev 0)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex=
am-Component_Reference-richtreeModelAdaptor-Nested_richtreeModelAdaptor_com=
ponents.xml_sample	2011-02-01 06:40:03 UTC (rev 21346)
@@ -0,0 +1,22 @@
+<rich:tree>
+   <rich:treeNodesAdaptor id=3D"project" nodes=3D"#{loaderBean.projects}" =
var=3D"project">
+      <rich:treeNode>
+         <h:commandLink action=3D"#{project.click}" value=3D"Project: #{pr=
oject.name}" />
+      </rich:treeNode>
+      <rich:treeNodesAdaptor id=3D"srcDir" var=3D"srcDir" nodes=3D"#{proje=
ct.srcDirs}">
+         <rich:treeNode>
+            <h:commandLink action=3D"#{srcDir.click}" value=3D"Source dire=
ctory: #{srcDir.name}" />
+         </rich:treeNode>
+         <rich:treeNodesAdaptor id=3D"pkg" var=3D"pkg" nodes=3D"#{srcDir.p=
ackages}">
+            <rich:treeNode>
+               <h:commandLink action=3D"#{pkg.click}" value=3D"Package: #{=
pkg.name}" />
+            </rich:treeNode>
+            <rich:treeNodesAdaptor id=3D"class" var=3D"class" nodes=3D"#{p=
kg.classes}">
+               <rich:treeNode>
+                  <h:commandLink action=3D"#{class.click}" value=3D"Class:=
 #{class.name}" />
+               </rich:treeNode>
+            </rich:treeNodesAdaptor>
+         </rich:treeNodesAdaptor>
+      </rich:treeNodesAdaptor>
+   </rich:treeNodesAdaptor>
+</rich:tree>

Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras=
/exam-Component_Reference-richtreeModelRecursiveAdaptor-Basic_usage.xml_sam=
ple
=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
--- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex=
am-Component_Reference-richtreeModelRecursiveAdaptor-Basic_usage.xml_sample=
	                        (rev 0)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex=
am-Component_Reference-richtreeModelRecursiveAdaptor-Basic_usage.xml_sample=
	2011-02-01 06:40:03 UTC (rev 21346)
@@ -0,0 +1,10 @@
+<rich:tree var=3D"item">
+   <rich:treeModelRecursiveAdaptor roots=3D"#{fileSystemBean.sourceRoots}"=
 nodes=3D"#{item.directories}" >
+      <rich:treeNode>
+         #{item.shortPath}
+      </rich:treeNode>
+      <rich:treeModelAdaptor nodes=3D"#{item.files}">
+         <rich:treeNode>#{item}</rich:treeNode>
+      </rich:treeModelAdaptor>
+   </rich:treeModelRecursiveAdaptor>
+</rich:tree>


--===============7913330567397451876==--