Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
<html xmlns:javaee="http://java.sun.com/xml/ns/javaee">
   <head>
      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
      <title>autocomplete
         (VDL Documentation)
         
      </title>
      <meta name="keywords" content="$tagname">
      <link rel="stylesheet" type="text/css" href="../css/stylesheet.css" title="Style">
   </head><script>
                function asd()
                {
                parent.document.title="autocomplete (VDL Documentation)";
                }
            </script><body bgcolor="white" onload="asd();"><a name="navbar_top"></a><table border="0" width="100%" cellpadding="1" cellspacing="0">
         <tr>
            <td COLSPAN="3" BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><a NAME="navbar_top_firstrow"></a><table BORDER="0" CELLPADDING="0" CELLSPACING="3">
                  <tr ALIGN="center" VALIGN="top">
                     <td BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    &nbsp;
                        <a href="../overview-summary.html"><font CLASS="NavBarFont1"><b>Overview</b></font></a>
                        &nbsp;
                        
                     </td>
                     <td BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    &nbsp;
                        <a href="tld-summary.html"><font CLASS="NavBarFont1"><b>Library</b></font></a>
                        &nbsp;
                        
                     </td>
                     <td BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<font CLASS="NavBarFont1Rev">&nbsp;Tag&nbsp;</font>&nbsp;
                        
                     </td>
                     <td BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    &nbsp;
                        <a HREF="../help-doc.html"><font CLASS="NavBarFont1"><b>Help</b></font></a>
                        &nbsp;
                        
                     </td>
                  </tr>
               </table>
            </td>
            <td ALIGN="right" VALIGN="top" ROWSPAN="3"><em></em></td>
         </tr>
         <tr>
            <td BGCOLOR="white" CLASS="NavBarCell2"><font SIZE="-2"></font></td>
            <td BGCOLOR="white" CLASS="NavBarCell2"><font SIZE="-2">
                  &nbsp;
                  <a HREF="../index.html" TARGET="_top"><b>FRAMES</b></a>
                  &nbsp;
                  &nbsp;
                  <a href="autocomplete.html" target="_top"><b>NO FRAMES</b></a>
                  &nbsp;
                  <script></script><noscript><a HREF="../alltags-noframe.html" TARGET=""><b>All Tags</b></a></noscript></font></td>
         </tr>
      </table>
      <hr>
      <h2><font size="-1">rich</font><br>
         Tag
         autocomplete
      </h2>
      <hr><p>The &lt;rich:autocomplete&gt; component is an auto-completing input-box with built-in Ajax capabilities. It supports client-side
      suggestions, browser-like selection, and customization of the look and feel.</p> @author Nick Belaevski<br><p></p>
      <hr>
      <table border="1" cellpadding="3" cellspacing="0" width="100%">
         <tr bgcolor="#CCCCFF" class="TableHeadingColor">
            <td colspan="2"><font size="+2"><b>Tag Information</b></font></td>
         </tr>
         <tr>
            <td>Component type</td>
            <td>org.richfaces.Autocomplete</td>
         </tr>
         <tr>
            <td>Tag Name</td>
            <td>rich:autocomplete</td>
         </tr>
         <tr>
            <td>Renderer Type</td>
            <td>org.richfaces.AutocompleteRenderer</td>
         </tr>
         <tr>
            <td>Handler Class</td>
            <td>org.richfaces.view.facelets.AutocompleteHandler</td>
         </tr>
      </table><br><p></p>
      <table border="1" cellpadding="3" cellspacing="0" width="100%">
         <tr bgcolor="#CCCCFF" class="TableHeadingColor">
            <td colspan="5"><font size="+2"><b>Attributes</b></font></td>
         </tr>
         <tr>
            <td><b>Name</b></td>
            <td><b>Required</b></td>
            <td><b>Type</b></td>
            <td><b>Description</b></td>
         </tr>
         <tr valign="top">
            <td>autocompleteList</td>
            <td>false</td>
            <td><code>java.lang.Object</code></td>
            <td>A collection of suggestions that will be resented to the user</td>
         </tr>
         <tr valign="top">
            <td>autocompleteMethod</td>
            <td>false</td>
            <td><code>javax.el.MethodExpression</code></td>
            <td>A method which returns a list of suggestions according to a supplied prefix</td>
         </tr>
         <tr valign="top">
            <td>autofill</td>
            <td>false</td>
            <td><code>boolean</code></td>
            <td>Causes the combo-box to fill the text field box with a matching suggestion as the user types</td>
         </tr>
         <tr valign="top">
            <td>binding</td>
            <td>false</td>
            <td><code>javax.faces.component.UIComponent</code></td>
            <td>The value binding expression used to wire up this component to a component property of a JavaBean class</td>
         </tr>
         <tr valign="top">
            <td>clientFilterFunction</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td><p> A javascript function used to filter the result list returned from the ajax call to the server. This function should have
               two parameters; subString(current input value considering tokens) and value (currently iterated item value) and return boolean
               flag which means if the value satisfies the substring passed. The function will be called for every available suggestion in
               order to construct a new list of suggestions. </p> <p>Default: A javascript method called <i>startsWith</i></p>
            </td>
         </tr>
         <tr valign="top">
            <td>converter</td>
            <td>false</td>
            <td><code>javax.faces.convert.Converter</code></td>
            <td>Converter instance registered with this component.</td>
         </tr>
         <tr valign="top">
            <td>converterMessage</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>A ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message
               that comes from the converter.
            </td>
         </tr>
         <tr valign="top">
            <td>disabled</td>
            <td>false</td>
            <td><code>boolean</code></td>
            <td>Boolean value indicating whether this component is disabled <p>Default: false</p></td>
         </tr>
         <tr valign="top">
            <td>fetchValue</td>
            <td>false</td>
            <td><code>java.lang.Object</code></td>
            <td>A value to set in the target input element on a choice suggestion that isn't shown in the suggestion table. It can be used
               for descriptive output comments or suggestions. If not set, all text in the suggestion row is set as a value
            </td>
         </tr>
         <tr valign="top">
            <td>id</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>The component identifier for this component. This value must be unique within the closest parent component that is a naming
               container.
            </td>
         </tr>
         <tr valign="top">
            <td>immediate</td>
            <td>false</td>
            <td><code>boolean</code></td>
            <td>Flag indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values
               phase), rather than waiting until Process Validations phase.
            </td>
         </tr>
         <tr valign="top">
            <td>inputClass</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Assigns one or more space-separated CSS class names to the input element</td>
         </tr>
         <tr valign="top">
            <td>layout</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td><p> Type of the layout encoded using nested components should be defined using layout attribute. Possible values are: </p>
               <dl> <dt>list</dt> <dd>suggestions wrapped to HTML unordered list</dd> <dt>div</dt> <dd>suggestions wrapped with just div
               element</dd> <dt>table</dt> <dd>suggestions are encoded as table rows, column definitions are required in this case</dd> </dl>
               <p>Default: div</p>
            </td>
         </tr>
         <tr valign="top">
            <td>minChars</td>
            <td>false</td>
            <td><code>int</code></td>
            <td>Minimal number of chars in input to activate suggestion popup</td>
         </tr>
         <tr valign="top">
            <td>mode</td>
            <td>false</td>
            <td><code>org.richfaces.component.AutocompleteMode</code></td>
            <td><p>Determine how the suggestion list is requested:</p> <dl> <dt>client</dt> <dd>pre-loads data to the client and uses the
               input to filter the possible suggestions</dd> <dt>ajax</dt> <dd>fetches suggestions with every input change using Ajax requests</dd>
               <dt>lazyClient</dt> <dd> pre-loads data to the client and uses the input to filter the possible suggestions. The filtering
               does not start until the input length matches a minimum value. Set the minimum value with the minChars attribute. </dd> <dt>cachedAjax</dt>
               <dd> pre-loads data via Ajax requests when the input length matches a minimum value. Set the minimum value with the minChars
               attribute. All suggestions are handled on the client until the input prefix is changed, at which point a new request is made
               based on the new input prefix </dd> </dl> <p>Default: cachedAjax</p>
            </td>
         </tr>
         <tr valign="top">
            <td>onbeforedomupdate</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>The client-side script method to be called after the ajax response comes back, but before the DOM is updated</td>
         </tr>
         <tr valign="top">
            <td>onbegin</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>The client-side script method to be called before an ajax request.</td>
         </tr>
         <tr valign="top">
            <td>onblur</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when this element loses focus.</td>
         </tr>
         <tr valign="top">
            <td>onchange</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when this element loses focus and its value has been modified since gaining focus.</td>
         </tr>
         <tr valign="top">
            <td>onclick</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a pointer button is clicked over this element.</td>
         </tr>
         <tr valign="top">
            <td>oncomplete</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>The client-side script method to be called after the DOM is updated</td>
         </tr>
         <tr valign="top">
            <td>ondblclick</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a pointer button is double clicked over this element.</td>
         </tr>
         <tr valign="top">
            <td>onerror</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>The client-side script method to be called when an error has occurred during Ajax communications</td>
         </tr>
         <tr valign="top">
            <td>onfocus</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when this element receives focus.</td>
         </tr>
         <tr valign="top">
            <td>onkeydown</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a key is pressed down over this element.</td>
         </tr>
         <tr valign="top">
            <td>onkeypress</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a key is pressed and released over this element.</td>
         </tr>
         <tr valign="top">
            <td>onkeyup</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a key is released over this element.</td>
         </tr>
         <tr valign="top">
            <td>onlistclick</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a pointer button is clicked over the popup list element.</td>
         </tr>
         <tr valign="top">
            <td>onlistdblclick</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a pointer button is double clicked over this element.</td>
         </tr>
         <tr valign="top">
            <td>onlistkeydown</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a key is pressed down over this element.</td>
         </tr>
         <tr valign="top">
            <td>onlistkeypress</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a key is pressed and released over this element.</td>
         </tr>
         <tr valign="top">
            <td>onlistkeyup</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a key is released over this element.</td>
         </tr>
         <tr valign="top">
            <td>onlistmousedown</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a pointer button is pressed down over this element.</td>
         </tr>
         <tr valign="top">
            <td>onlistmousemove</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a pointer button is moved within this element.</td>
         </tr>
         <tr valign="top">
            <td>onlistmouseout</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a pointer button is moved away from this element.</td>
         </tr>
         <tr valign="top">
            <td>onlistmouseover</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a pointer button is moved onto this element.</td>
         </tr>
         <tr valign="top">
            <td>onlistmouseup</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a pointer button is released over this element.</td>
         </tr>
         <tr valign="top">
            <td>onmousedown</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a pointer button is pressed down over this element.</td>
         </tr>
         <tr valign="top">
            <td>onmousemove</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a pointer button is moved within this element.</td>
         </tr>
         <tr valign="top">
            <td>onmouseout</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a pointer button is moved away from this element.</td>
         </tr>
         <tr valign="top">
            <td>onmouseover</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a pointer button is moved onto this element.</td>
         </tr>
         <tr valign="top">
            <td>onmouseup</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when a pointer button is released over this element.</td>
         </tr>
         <tr valign="top">
            <td>onselectitem</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Javascript code executed when an item is selected</td>
         </tr>
         <tr valign="top">
            <td>popupClass</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Assigns one or more space-separated CSS class names to the content of the popup suggestion element</td>
         </tr>
         <tr valign="top">
            <td>rendered</td>
            <td>false</td>
            <td><code>boolean</code></td>
            <td>Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent
               form submit. The default value for this property is true.
            </td>
         </tr>
         <tr valign="top">
            <td>required</td>
            <td>false</td>
            <td><code>boolean</code></td>
            <td>Flag indicating that the user is required to provide a submitted value for this input component.</td>
         </tr>
         <tr valign="top">
            <td>requiredMessage</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>A ValueExpression enabled attribute that, if present, will be used as the text of the validation message for the "required"
               facility, if the "required" facility is used.
            </td>
         </tr>
         <tr valign="top">
            <td>selectFirst</td>
            <td>false</td>
            <td><code>boolean</code></td>
            <td>Boolean value indicating whether the first suggestion item is selected as the user types <p>Default: true</p></td>
         </tr>
         <tr valign="top">
            <td>selectedItemClass</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Assigns one or more space-separated CSS class names to the selected suggestion entry</td>
         </tr>
         <tr valign="top">
            <td>showButton</td>
            <td>false</td>
            <td><code>boolean</code></td>
            <td><p>Boolean value indicating whether to display a button to expand the popup suggestion element</p> <p>Default: false</p></td>
         </tr>
         <tr valign="top">
            <td>style</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>CSS style(s) to be applied when this component is rendered.</td>
         </tr>
         <tr valign="top">
            <td>styleClass</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through
               as the "class" attribute on generated markup.
            </td>
         </tr>
         <tr valign="top">
            <td>tabindex</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.</td>
         </tr>
         <tr valign="top">
            <td>tokens</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td><p>Allow a user to enter multiple values separated by specific characters. As the user types, a suggestion will present as
               normal. When they enter the specified token character, this begins a new suggestion process, and the component will then only
               use text entered after the token character for suggestions.</p> <p>Make sure that no character defined in tokens is part of
               any suggestion value. E.g. do not use space as a token if you expect to allow spaces in suggestion values.</p> <p>When tokens
               defined, they can be naturally separated by space character - input separated by tokens ', ' or ' ,' will be considered as
               it would be ',' token without any space.</p>
            </td>
         </tr>
         <tr valign="top">
            <td>validator</td>
            <td>false</td>
            <td><code>javax.faces.el.MethodBinding</code></td>
            <td>MethodExpression representing a validator method that will be called during Process Validations to perform correctness checks
               on the value of this component. The expression must evaluate to a public method that takes FacesContext, UIComponent, and
               Object parameters, with a return type of void.
            </td>
         </tr>
         <tr valign="top">
            <td>validatorMessage</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message
               that comes from the validator.
            </td>
         </tr>
         <tr valign="top">
            <td>value</td>
            <td>false</td>
            <td><code>java.lang.Object</code></td>
            <td>The current value of this component.</td>
         </tr>
         <tr valign="top">
            <td>valueChangeListener</td>
            <td>false</td>
            <td><code>javax.faces.el.MethodBinding</code></td>
            <td><p> MethodExpression representing a value change listener method that will be notified when a new value has been set for this
               input component. The expression must evaluate to a public method that takes a <code>ValueChangeEvent</code> parameter, with
               a return type of void, <span class="changed_added_2_0">or to a public method that takes no arguments with a return type of
               void. In the latter case, the method has no way of easily knowing what the new value is, but this can be useful in cases where
               a notification is needed that "this value changed".</span> </p>
            </td>
         </tr>
         <tr valign="top">
            <td>var</td>
            <td>false</td>
            <td><code>java.lang.String</code></td>
            <td>A request-scope attribute via which the data object for the current row will be used when iterating</td>
         </tr>
      </table><br><p></p><a name="navbar_bottom"></a><table border="0" width="100%" cellpadding="1" cellspacing="0">
         <tr>
            <td COLSPAN="3" BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><a NAME="navbar_bottom_firstrow"></a><table BORDER="0" CELLPADDING="0" CELLSPACING="3">
                  <tr ALIGN="center" VALIGN="top">
                     <td BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    &nbsp;
                        <a href="../overview-summary.html"><font CLASS="NavBarFont1"><b>Overview</b></font></a>
                        &nbsp;
                        
                     </td>
                     <td BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    &nbsp;
                        <a href="tld-summary.html"><font CLASS="NavBarFont1"><b>Library</b></font></a>
                        &nbsp;
                        
                     </td>
                     <td BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<font CLASS="NavBarFont1Rev">&nbsp;Tag&nbsp;</font>&nbsp;
                        
                     </td>
                     <td BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    &nbsp;
                        <a HREF="../help-doc.html"><font CLASS="NavBarFont1"><b>Help</b></font></a>
                        &nbsp;
                        
                     </td>
                  </tr>
               </table>
            </td>
            <td ALIGN="right" VALIGN="top" ROWSPAN="3"><em></em></td>
         </tr>
         <tr>
            <td BGCOLOR="white" CLASS="NavBarCell2"><font SIZE="-2"></font></td>
            <td BGCOLOR="white" CLASS="NavBarCell2"><font SIZE="-2">
                  &nbsp;
                  <a HREF="../index.html" TARGET="_top"><b>FRAMES</b></a>
                  &nbsp;
                  &nbsp;
                  <a href="autocomplete.html" target="_top"><b>NO FRAMES</b></a>
                  &nbsp;
                  <script></script><noscript><a HREF="../alltags-noframe.html" TARGET=""><b>All Tags</b></a></noscript></font></td>
         </tr>
      </table>
      <hr><small><i>
            Output Generated by
            <a href="http://taglibrarydoc.dev.java.net/" target="_blank">Tag Library Documentation
               Generator</a>.
            </i></small></body>
</html>
New to GrepCode? Check out our FAQ X