From richfaces-svn-commits at lists.jboss.org Thu Nov 11 02:15:57 2010
Content-Type: multipart/mixed; boundary="===============4702572537448058740=="
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: r20026 - in
 modules/docs/trunk/Component_Reference/src/main/docbook/en-US: extras and 1
 other directories.
Date: Thu, 11 Nov 2010 02:15:57 -0500
Message-ID: <201011110715.oAB7FvHu029487@svn01.web.mwc.hst.phx2.redhat.com>

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

Author: SeanRogers
Date: 2010-11-11 02:15:57 -0500 (Thu, 11 Nov 2010)
New Revision: 20026

Added:
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exa=
m-Component_Reference-Table_filtering-Basic_filtering.xml_sample
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exa=
m-Component_Reference-Table_filtering-External_filtering.xml_sample
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/fig=
u-Component_Reference-Table_filtering-Basic_filtering.png
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/fig=
u-Component_Reference-Table_filtering-External_filtering.png
Modified:
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo=
nent_Reference-Actions.xml
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo=
nent_Reference-Tables_and_grids.xml
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exa=
m-Component_Reference-a4jajax-a4jajax_example.xml_sample
Log:
Added table filtering section

Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha=
p-Component_Reference-Actions.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-Actions.xml	2010-11-10 22:36:12 UTC (rev 20025)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Actions.xml	2010-11-11 07:15:57 UTC (rev 20026)
@@ -6,6 +6,50 @@
 	<para>
 		This chapter details the basic components that respond to a user action =
and submit an Ajax request.
 	</para>
+	=

+	<section id=3D"sect-Component_Reference-Actions-a4jajax">
+		<title><sgmltag>&lt;a4j:ajax&gt;</sgmltag></title>
+		<para>
+			The <sgmltag>&lt;a4j:ajax&gt;</sgmltag> component allows Ajax capabilit=
y to be added to any non-Ajax component. It is placed as a direct child to =
the component that requires Ajax support. The <sgmltag>&lt;a4j:ajax&gt;</sg=
mltag> component uses the common attributes listed in <xref linkend=3D"chap=
-Component_Reference-Common_Ajax_attributes" />.
+		</para>
+		<note>
+			<title>Attaching JavaScript functions</title>
+			<para>
+				When attaching the <sgmltag>&lt;a4j:ajax&gt;</sgmltag> component to no=
n-Ajax JavaServer Faces command components, such as <sgmltag>&lt;h:commandB=
utton&gt;</sgmltag> and <sgmltag>&lt;h:commandLink&gt;</sgmltag>, it is imp=
ortant to set <code>disabledDefault=3D"true"</code>. If this attribute is n=
ot set, a non-Ajax request is sent after the Ajax request and the page is r=
efreshed unexpectedly.
+			</para>
+		</note>
+		<example id=3D"exam-Component_Reference-a4jajax-a4jajax_example">
+			<title><sgmltag>&lt;a4j:ajax&gt;</sgmltag> example</title>
+			<programlisting language=3D"XML" role=3D"XML"><xi:include href=3D"extra=
s/exam-Component_Reference-a4jajax-a4jajax_example.xml_sample" parse=3D"tex=
t" xmlns:xi=3D"http://www.w3.org/2001/XInclude" /></programlisting>
+		</example>
+		=

+		<section id=3D"sect-Component_Reference-a4jajax-Reference_data">
+			<title>Reference data</title>
+			<itemizedlist>
+				<listitem>
+					<para>
+						<parameter>component-type</parameter>: <classname>org.ajax4jsf.Ajax<=
/classname>
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<parameter>component-class</parameter>: <classname>org.ajax4jsf.comp=
onent.html.HtmlAjaxSupport</classname>
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<parameter>component-family</parameter>: <classname>org.ajax4jsf.Aja=
x</classname>
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<parameter>renderer-type</parameter>: <classname>org.ajax4jsf.compon=
ents.AjaxSupportRenderer</classname>
+					</para>
+				</listitem>
+			</itemizedlist>
+		</section>
+	</section>
+
 	<section id=3D"sect-Component_Reference-Actions-a4jactionParam">
 		<title><sgmltag>&lt;a4j:actionParam&gt;</sgmltag></title>
 		<para>
@@ -544,49 +588,6 @@
 			</itemizedlist>
 		</section>
 	</section>
-	=

-	<section id=3D"sect-Component_Reference-Actions-a4jajax">
-		<title><sgmltag>&lt;a4j:ajax&gt;</sgmltag></title>
-		<para>
-			The <sgmltag>&lt;a4j:ajax&gt;</sgmltag> component allows Ajax capabilit=
y to be added to any non-Ajax component. It is placed as a direct child to =
the component that requires Ajax support. The <sgmltag>&lt;a4j:ajax&gt;</sg=
mltag> component uses the common attributes listed in <xref linkend=3D"chap=
-Component_Reference-Common_Ajax_attributes" />.
-		</para>
-		<note>
-			<title>Attaching JavaScript functions</title>
-			<para>
-				When attaching the <sgmltag>&lt;a4j:ajax&gt;</sgmltag> component to no=
n-Ajax JavaServer Faces command components, such as <sgmltag>&lt;h:commandB=
utton&gt;</sgmltag> and <sgmltag>&lt;h:commandLink&gt;</sgmltag>, it is imp=
ortant to set <code>disabledDefault=3D"true"</code>. If this attribute is n=
ot set, a non-Ajax request is sent after the Ajax request and the page is r=
efreshed unexpectedly.
-			</para>
-		</note>
-		<example id=3D"exam-Component_Reference-a4jajax-a4jajax_example">
-			<title><sgmltag>&lt;a4j:ajax&gt;</sgmltag> example</title>
-			<programlisting language=3D"XML" role=3D"XML"><xi:include href=3D"extra=
s/exam-Component_Reference-a4jajax-a4jajax_example.xml_sample" parse=3D"tex=
t" xmlns:xi=3D"http://www.w3.org/2001/XInclude" /></programlisting>
-		</example>
-		=

-		<section id=3D"sect-Component_Reference-a4jajax-Reference_data">
-			<title>Reference data</title>
-			<itemizedlist>
-				<listitem>
-					<para>
-						<parameter>component-type</parameter>: <classname>org.ajax4jsf.Ajax<=
/classname>
-					</para>
-				</listitem>
-				<listitem>
-					<para>
-						<parameter>component-class</parameter>: <classname>org.ajax4jsf.comp=
onent.html.HtmlAjaxSupport</classname>
-					</para>
-				</listitem>
-				<listitem>
-					<para>
-						<parameter>component-family</parameter>: <classname>org.ajax4jsf.Aja=
x</classname>
-					</para>
-				</listitem>
-				<listitem>
-					<para>
-						<parameter>renderer-type</parameter>: <classname>org.ajax4jsf.compon=
ents.AjaxSupportRenderer</classname>
-					</para>
-				</listitem>
-			</itemizedlist>
-		</section>
-	</section>
 =

 </chapter>
 =


Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha=
p-Component_Reference-Tables_and_grids.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-Tables_and_grids.xml	2010-11-10 22:36:12 UTC (rev 20025)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Tables_and_grids.xml	2010-11-11 07:15:57 UTC (rev 20026)
@@ -1181,16 +1181,88 @@
 	=

 	<section id=3D"sect-Component_Reference-Tables_and_grids-Table_filtering">
 		<title>Table filtering</title>
+		<!--  In development notification  -->
+		<important>
+			<title>Documentation in development</title>
+			<para>
+				This section is currently under development. Any features it describes=
 may not be available in the current release of RichFaces.
+			</para>
+		</important>
+
+		<!-- TODO: not in M4
 		<para>
-			Under development.
+			Tables entries can be filtered by the user using either the basic metho=
d built in to the <sgmltag>&lt;rich:column&gt;</sgmltag> component, or by d=
efining external filters. Refer to <xref linkend=3D"sect-Component_Referenc=
e-Tables_and_grids-richcolumn" /> for details on using the <sgmltag>&lt;ric=
h:column&gt;</sgmltag> component in tables.
 		</para>
+		<section id=3D"sect-Component_Reference-Table_filtering-Basic_filtering">
+			<title>Basic filtering</title>
+			<para>
+				The built-in filtering abilities of the <sgmltag>&lt;rich:column&gt;</=
sgmltag> component allow the user to enter text as a filtering value. The t=
able displays only those entries that begin with the filter value.
+			</para>
+			<para>
+				Set the <varname>filterValue</varname> attribute to point to the value=
 used to filter the column. This can be either an initial filtering value o=
n the page, or a value binding on the server. The <varname>filterValue</var=
name> value is then used with the JavaScript <function>startsWith()</functi=
on> method to filter the column entries based on the data specified with th=
e <varname>filterBy</varname> attribute. Expressions in the <varname>filter=
By</varname> attribute must refer to the variable declared in the table's <=
varname>var</varname> attribute, which is used to fill the contents of the =
table.
+			</para>
+			<para>
+				The filter is processed and the table is rendered when the <literal>on=
blur</literal> event occurs for the column. This can be changed by defining=
 a different event with the <varname>filterEvent</varname> attribute. For e=
xample, to implement live updating such that the filter refreshes after eve=
ry keystroke, set <code>filterEvent=3D"onkeyup"</code>.
+			</para>
+			<example id=3D"exam-Component_Reference-Table_filtering-Basic_filtering=
">
+				<title>Basic filtering</title>
+				<programlisting language=3D"XML" role=3D"XML"><xi:include parse=3D"tex=
t" href=3D"extras/exam-Component_Reference-Table_filtering-Basic_filtering.=
xml_sample" xmlns:xi=3D"http://www.w3.org/2001/XInclude" /></programlisting>
+				<para>
+					The example uses the basic filtering method on both columns in the ta=
ble.
+				</para>
+				<mediaobject>
+					<imageobject>
+						<imagedata fileref=3D"images/figu-Component_Reference-Table_filterin=
g-Basic_filtering.png" format=3D"PNG" />
+					</imageobject>
+					<textobject>
+						<para>
+							A table of state capitals filtered by states beginning with the let=
ter "<wordasword>n</wordasword>".
+						</para>
+					</textobject>
+				</mediaobject>
+			</example>
+		</section>
+		<section id=3D"sect-Component_Reference-Table_filtering-External_filteri=
ng">
+			<title>External filtering</title>
+			<para>
+				If you require more advanced filtering using custom functions or expre=
ssions, use the external filtering properties of the <sgmltag>&lt;rich:colu=
mn&gt;</sgmltag> component.
+			</para>
+			<para>
+				Use the <varname>filterExpression</varname> attribute to define an exp=
ression that can be evaluated as a boolean value. The expression checks if =
each table entry satisfies the filtering condition when the table is render=
ed.
+			</para>
+			<para>
+				Use the <varname>filterMethod</varname> attribute to define a method b=
inding. The method needs to accept an object as a parameter and return a bo=
olean value. Similar to the <varname>filterExpression</varname> attribute, =
the table is rendered only with those entries that satisfy the filtering co=
ndition. By defining a custom filtering method, you can implement complex b=
usiness logic to filter a table.
+			</para>
+			<example id=3D"exam-Component_Reference-Table_filtering-External_filter=
ing">
+				<title>External filtering</title>
+				<programlisting language=3D"XML" role=3D"XML"><xi:include parse=3D"tex=
t" href=3D"extras/exam-Component_Reference-Table_filtering-External_filteri=
ng.xml_sample" xmlns:xi=3D"http://www.w3.org/2001/XInclude" /></programlist=
ing>
+				<para>
+					The example uses a filter expression on the first column and a filter=
 method on the second column.
+				</para>
+				<mediaobject>
+					<imageobject>
+						<imagedata fileref=3D"images/figu-Component_Reference-Table_filterin=
g-External_filtering.png" format=3D"PNG" />
+					</imageobject>
+					<textobject>
+						<para>
+							A table of state capitals filtered by states beginning with the let=
ter "<wordasword>a</wordasword>", further filtered to those states in the G=
MT-5 time zone.
+						</para>
+					</textobject>
+				</mediaobject>
+			</example>
+		</section>
+		-->
 	</section>
 	=

 	<section id=3D"sect-Component_Reference-Tables_and_grids-Table_sorting">
 		<title>Table sorting</title>
-		<para>
-			Under development.
-		</para>
+		<!--  In development notification  -->
+		<important>
+			<title>Documentation in development</title>
+			<para>
+				This section is currently under development. Any features it describes=
 may not be available in the current release of RichFaces.
+			</para>
+		</important>
 	</section>
 =

 </chapter>

Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras=
/exam-Component_Reference-Table_filtering-Basic_filtering.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-Table_filtering-Basic_filtering.xml_sample	         =
               (rev 0)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex=
am-Component_Reference-Table_filtering-Basic_filtering.xml_sample	2010-11-1=
1 07:15:57 UTC (rev 20026)
@@ -0,0 +1,18 @@
+<rich:dataTable value=3D"#{capitalsBean.capitals}" var=3D"cap">
+   <f:facet name=3D"header">
+      <rich:column>
+         <h:outputText value=3D"State Name">
+      </rich:column>
+      <rich:column>
+         <h:outputText value=3D"State Capital">
+      </rich:column>
+   </f:facet>
+   <rich:column filterValue=3D"#{capitalsBean.currentStateFilterValue}"
+                filterBy=3D"#{cap.state}" filterEvent=3D"onkeyup">
+      <h:outputText value=3D"#{cap.state}"/>
+   </rich:column> =

+   <rich:column filterValue=3D"#{capitalsBean.currentNameFilterValue}"
+                filterBy=3D"#{cap.name}" filterEvent=3D"onkeyup">
+      <h:outputText value=3D"#{cap.name}"/> =

+   </rich:column>
+</rich:dataTable>

Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras=
/exam-Component_Reference-Table_filtering-External_filtering.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-Table_filtering-External_filtering.xml_sample	      =
                  (rev 0)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex=
am-Component_Reference-Table_filtering-External_filtering.xml_sample	2010-1=
1-11 07:15:57 UTC (rev 20026)
@@ -0,0 +1,29 @@
+<rich:dataTable value=3D"#{capitalsBean.capitals}" var=3D"cap" id=3D"table=
">
+   <f:facet name=3D"header">
+      <rich:column>
+         <h:outputText value=3D"State Name">
+      </rich:column>
+      <rich:column>
+         <h:outputText value=3D"State Time Zone">
+      </rich:column>
+   </f:facet>
+   <rich:column filterMethod=3D"#{filteringBean.filterStates}">
+		<f:facet name=3D"header">
+			<h:inputText value=3D"#{filteringBean.filterValue}" id=3D"input">
+				<a4j:ajax event=3D"onkeyup" render=3D"table"
+					          ignoreDupResponses=3D"true" requestDelay=3D"700"/>
+			</h:inputText>
+		</f:facet>
+      <h:outputText value=3D"#{cap.state}"/>
+   </rich:column> =

+   <rich:column filterExpression=3D
+      "#{fn:containsIgnoreCase(cap.timeZone, filteringBean.filterZone)}">
+		<f:facet name=3D"header">
+			<h:selectOneMenu value=3D"#{filteringBean.filterZone}">
+				<f:selectItems value=3D"#{filteringBean.filterZones}" />
+				<a4j:ajax event=3D"onchange" render=3D"table" />
+			</h:selectOneMenu>
+		</f:facet>
+      <h:outputText value=3D"#{cap.timeZone}"/> =

+   </rich:column>
+</rich:dataTable>

Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/ext=
ras/exam-Component_Reference-a4jajax-a4jajax_example.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-a4jajax-a4jajax_example.xml_sample	2010-11-10 22:36:=
12 UTC (rev 20025)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex=
am-Component_Reference-a4jajax-a4jajax_example.xml_sample	2010-11-11 07:15:=
57 UTC (rev 20026)
@@ -1,6 +1,6 @@
 <h:panelGrid columns=3D"2">
     <h:inputText id=3D"myinput" value=3D"#{userBean.name}">
-        <a4j:ajax event=3D"onkeyup" reRender=3D"outtext" />
+        <a4j:ajax event=3D"onkeyup" render=3D"outtext" />
     </h:inputText>
     <h:outputText id=3D"outtext" value=3D"#{userBean.name}" />
 </h:panelGrid>

Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images=
/figu-Component_Reference-Table_filtering-Basic_filtering.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: modules/docs/trunk/Component_Reference/src/main/docboo=
k/en-US/images/figu-Component_Reference-Table_filtering-Basic_filtering.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images=
/figu-Component_Reference-Table_filtering-External_filtering.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: modules/docs/trunk/Component_Reference/src/main/docboo=
k/en-US/images/figu-Component_Reference-Table_filtering-External_filtering.=
png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream


--===============4702572537448058740==--