Author: SeanRogers
Date: 2011-04-07 03:08:48 -0400 (Thu, 07 Apr 2011)
New Revision: 22387
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml
Log:
Added information on autocomplete tokens: RFPL-1228
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-04-07
06:21:49 UTC (rev 22386)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2011-04-07
07:08:48 UTC (rev 22387)
@@ -139,6 +139,15 @@
<para>
Setting
<code><varname>autoFill</varname>="true"</code> causes
the combo-box to fill the text field box with a matching suggestion as the user types.
</para>
+ <para>
+ To allow users to enter multiple values separated by specific characters, use the
<varname>tokens</varname> attribute. As the user types, a suggestion will
present as normal. When they enter a character specified as a token, this begins a new
suggestion process, and the component only uses text entered after the token character for
suggestions. For example, if <code>tokens=", "</code> is set, the
<sgmltag><rich:autocomplete></sgmltag> component uses both the
comma and space characters as tokens to separate entries. When the user enters a comma or
a space, a new suggestion process begins.
+ </para>
+ <note>
+ <title>Using tokens</title>
+ <para>
+ When declaring tokens, avoid using any characters that are present in the list of
suggestions. This may cause unexpected behavior as the user expects the character to match
suggestions instead of separating suggested entries.
+ </para>
+ </note>
</section>
<section
id="sect-Component_Reference-richautocomplete-Customizing_the_filter_in_client_and_lazyClient_modes">
Show replies by date