Author: lfryc(a)redhat.com
Date: 2011-11-14 17:23:00 -0500 (Mon, 14 Nov 2011)
New Revision: 22934
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocomplete-Customizing_the_filter.xml_sample
Log:
RFPL-1727: renamed attribute clientFilter to clientFilterFunction
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2011-11-14
20:33:24 UTC (rev 22933)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2011-11-14
22:23:00 UTC (rev 22934)
@@ -153,12 +153,12 @@
<section
id="sect-Component_Reference-richautocomplete-Customizing_the_filter_in_client_and_lazyClient_modes">
<title>Customizing the filter in <literal>client</literal> and
<literal>lazyClient</literal> modes</title>
<para>
- The <sgmltag><rich:autocomplete></sgmltag> component uses
the JavaScript <function>startsWith()</function> method to create the list of
suggestions. The filtering is performed on the client side. Alternatively, use the
<varname>clientFilter</varname> attribute to specify a custom filtering
function. The custom function must accept two parameters: the
<varname>subString</varname> parameter is the filtering value as typed into
the text box by the user, and the <varname>value</varname> parameter is an
item in the list of suggestions against which the <varname>subString</varname>
must be checked. Each item is iterated through and passed to the function as the
<varname>value</varname> parameter. The custom function must return a boolean
value indicating whether the passed item meets the conditions of the filter, and the
suggestion list is constructed from successful items.
+ The <sgmltag><rich:autocomplete></sgmltag> component uses
the JavaScript <function>startsWith()</function> method to create the list of
suggestions. The filtering is performed on the client side. Alternatively, use the
<varname>clientFilterFunction</varname> attribute to specify a custom
filtering function. The custom function must accept two parameters: the
<varname>subString</varname> parameter is the filtering value as typed into
the text box by the user, and the <varname>value</varname> parameter is an
item in the list of suggestions against which the <varname>subString</varname>
must be checked. Each item is iterated through and passed to the function as the
<varname>value</varname> parameter. The custom function must return a boolean
value indicating whether the passed item meets the conditions of the filter, and the
suggestion list is constructed from successful items.
</para>
<example
id="exam-Component_Reference-richautocomplete-Customizing_the_filter">
<title>Customizing the filter</title>
<para>
- This example demonstrates how to use a custom filter with the
<varname>clientFilter</varname> attribute. The custom filter determines if the
sub-string is contained anywhere in the suggestion item, instead of just at the start.
+ This example demonstrates how to use a custom filter with the
<varname>clientFilterFunction</varname> attribute. The custom filter
determines if the sub-string is contained anywhere in the suggestion item, instead of just
at the start.
</para>
<programlisting language="XML" role="XML"><xi:include
parse="text"
href="extras/exam-Component_Reference-richautocomplete-Customizing_the_filter.xml_sample"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
</example>
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocomplete-Customizing_the_filter.xml_sample
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocomplete-Customizing_the_filter.xml_sample 2011-11-14
20:33:24 UTC (rev 22933)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richautocomplete-Customizing_the_filter.xml_sample 2011-11-14
22:23:00 UTC (rev 22934)
@@ -8,6 +8,6 @@
</script>
<h:form>
<rich:autocomplete mode="client" minChars="0"
autofill="false"
- clientFilter="customFilter"
+ clientFilterFunction="customFilter"
autocompleteMethod="#{autocompleteBean.autocomplete}"
/>
-</h:form>
+</h:form>
\ No newline at end of file