20f8df1291
data tables are going to need some work yet, but the other stuff seems to be working 100%
5621 lines
276 KiB
HTML
5621 lines
276 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>API: autocomplete YAHOO.widget.AutoComplete (YUI Library)</title>
|
|
<link rel="stylesheet" type="text/css" href="assets/api.css">
|
|
<script type="text/javascript" src="assets/api-js"></script>
|
|
<script type="text/javascript" src="assets/ac-js"></script>
|
|
</head>
|
|
|
|
<body id="yahoo-com">
|
|
|
|
<div id="doc3" class="yui-t2">
|
|
|
|
<div id="hd">
|
|
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
|
|
<h3>AutoComplete Widget <span class="subtitle">2.6.0</span></h3>
|
|
<p>
|
|
<a href="./index.html">Yahoo! UI Library</a>
|
|
> <a href="./module_autocomplete.html">autocomplete</a>
|
|
> YAHOO.widget.AutoComplete
|
|
|
|
</p>
|
|
|
|
|
|
</div>
|
|
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
<form name="yui-classopts-form">
|
|
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> <label for="showprivate">Show Private</label></span>
|
|
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
|
|
<span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
|
|
</form>
|
|
|
|
<h2>
|
|
|
|
|
|
|
|
|
|
Class <b>YAHOO.widget.AutoComplete</b>
|
|
<span class="extends">
|
|
</span>
|
|
|
|
<span class="extends">
|
|
</span>
|
|
|
|
</code>
|
|
</h2>
|
|
<!-- class tree goes here -->
|
|
|
|
|
|
|
|
|
|
<div class="summary description">
|
|
The AutoComplete class provides the customizable functionality of a plug-and-play DHTML
|
|
auto completion widget. Some key features:
|
|
<ul>
|
|
<li>Navigate with up/down arrow keys and/or mouse to pick a selection</li>
|
|
<li>The drop down container can "roll down" or "fly out" via configurable
|
|
animation</li>
|
|
<li>UI look-and-feel customizable through CSS, including container
|
|
attributes, borders, position, fonts, etc</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="section constructor details">
|
|
<h3 id="constructor">Constructor</h3>
|
|
<div class="content">
|
|
<div class="detail">
|
|
<strong>YAHOO.widget.AutoComplete</strong>
|
|
<code>
|
|
(
|
|
|
|
|
|
|
|
elInput
|
|
|
|
|
|
,
|
|
elContainer
|
|
|
|
|
|
,
|
|
oDataSource
|
|
|
|
,
|
|
oConfigs
|
|
)
|
|
</code>
|
|
<div class="description">
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elInput
|
|
<HTMLElement>
|
|
</code>
|
|
DOM element reference of an input field.
|
|
</dd>
|
|
<dd>
|
|
<code>elInput
|
|
<String>
|
|
</code>
|
|
String ID of an input field.
|
|
</dd>
|
|
<dd>
|
|
<code>elContainer
|
|
<HTMLElement>
|
|
</code>
|
|
DOM element reference of an existing DIV.
|
|
</dd>
|
|
<dd>
|
|
<code>elContainer
|
|
<String>
|
|
</code>
|
|
String ID of an existing DIV.
|
|
</dd>
|
|
<dd>
|
|
<code>oDataSource
|
|
<YAHOO.widget.DataSource>
|
|
</code>
|
|
DataSource instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oConfigs
|
|
<Object>
|
|
</code>
|
|
(optional) Object literal of configuration params.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field details">
|
|
<h3 id="properties">Properties</h3>
|
|
<div class="content">
|
|
<div class="private">
|
|
<h4><a name="property__bContainerOpen">_bContainerOpen</a>
|
|
<code>- private Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Whether or not the results container is currently open.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__bFocused">_bFocused</a>
|
|
<code>- private Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Whether or not the input field is currently in focus. If query results come back
|
|
but the user has already moved on, do not proceed with auto complete behavior.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__bItemSelected">_bItemSelected</a>
|
|
<code>- private Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Whether or not an item has been selected since the container was populated
|
|
with results. Reset to false by _populateList, and set to true when item is
|
|
selected.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__bOverContainer">_bOverContainer</a>
|
|
<code>- private Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Whether or not the mouse is currently over the results
|
|
container. This is necessary in order to prevent clicks on container items
|
|
from being text input field blur events.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__elBody">_elBody</a>
|
|
<code>- private HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Reference to body element within content element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__elContainer">_elContainer</a>
|
|
<code>- private HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Container DOM element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__elContent">_elContent</a>
|
|
<code>- private HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Reference to content element within container element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__elCurListItem">_elCurListItem</a>
|
|
<code>- private HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Pointer to the currently highlighted <li> element in the container.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__elFooter">_elFooter</a>
|
|
<code>- private HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Reference to footer element within content element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__elHeader">_elHeader</a>
|
|
<code>- private HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Reference to header element within content element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__elIFrame">_elIFrame</a>
|
|
<code>- private HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Reference to iframe element within container element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__elList">_elList</a>
|
|
<code>- private HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Internal reference to <ul> elements that contains query results within the
|
|
results container.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__elShadow">_elShadow</a>
|
|
<code>- private HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Reference to shadow element within container element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__elTextbox">_elTextbox</a>
|
|
<code>- private HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Text input field DOM element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__iFrameSrc">_iFrameSrc</a>
|
|
<code>- private String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Src to iFrame used when useIFrame = true. Supports implementations over SSL
|
|
as well.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__nDelayID">_nDelayID</a>
|
|
<code>- private Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Delay timeout ID.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__nDisplayedItems">_nDisplayedItems</a>
|
|
<code>- private Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Number of <li> elements currently displayed in results container.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__nIndex">_nIndex</a>
|
|
<code>- private Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Internal class variable to index multiple AutoComplete instances.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: 0
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__nKeyCode">_nKeyCode</a>
|
|
<code>- private Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Key code of the last key pressed in textbox.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__nTypeAheadDelayID">_nTypeAheadDelayID</a>
|
|
<code>- private Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
TypeAhead delay timeout ID.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__oAnim">_oAnim</a>
|
|
<code>- private Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Animation instance for container expand/collapse.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__queryInterval">_queryInterval</a>
|
|
<code>- private Object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
For users typing via certain IMEs, queries must be triggered by intervals,
|
|
since key events yet supported across all browsers for all IMEs.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__sCurQuery">_sCurQuery</a>
|
|
<code>- private String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Current query string
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__sInitInputValue">_sInitInputValue</a>
|
|
<code>- private String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Stores initial input value used to determine if textboxChangeEvent should be fired.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__sName">_sName</a>
|
|
<code>- private String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Name of AutoComplete instance.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__sPastSelections">_sPastSelections</a>
|
|
<code>- private String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Selections from previous queries (for saving delimited queries).
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: ""
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_allowBrowserAutocomplete">allowBrowserAutocomplete</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Whether or not to allow browsers to cache user-typed input in the input
|
|
field. Disabling this feature will prevent the widget from setting the
|
|
autocomplete="off" on the input field. When autocomplete="off"
|
|
and users click the back button after form submission, user-typed input can
|
|
be prefilled by the browser from its cache. This caching of user input may
|
|
not be desired for sensitive data, such as credit card numbers, in which
|
|
case, implementers should consider setting allowBrowserAutocomplete to false.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: true
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_alwaysShowContainer">alwaysShowContainer</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Enabling this feature prevents the toggling of the container to a collapsed state.
|
|
Setting to true does not automatically trigger the opening of the container.
|
|
Implementers are advised to pre-load the container with an explicit "sendQuery()" call.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_animHoriz">animHoriz</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Whether or not to animate the expansion/collapse of the results container in the
|
|
horizontal direction.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_animSpeed">animSpeed</a>
|
|
<code>- Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Speed of container expand/collapse animation, in seconds..
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: 0.3
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_animVert">animVert</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Whether or not to animate the expansion/collapse of the results container in the
|
|
vertical direction.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: true
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_applyLocalFilter">applyLocalFilter</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
By default, results from local DataSources will pass through the filterResults
|
|
method to apply a client-side matching algorithm.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: true for local arrays and json, otherwise false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_autoHighlight">autoHighlight</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Whether or not the first item in results container should be automatically highlighted
|
|
on expand.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: true
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_dataSource">dataSource</a>
|
|
<code>- YAHOO.widget.DataSource</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The DataSource object that encapsulates the data used for auto completion.
|
|
This object should be an inherited object from YAHOO.widget.DataSource.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_delimChar">delimChar</a>
|
|
<code>- String | String[]</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Query delimiter. A single character separator for multiple delimited
|
|
selections. Multiple delimiter characteres may be defined as an array of
|
|
strings. A null value or empty string indicates that query results cannot
|
|
be delimited. This feature is not recommended if you need forceSelection to
|
|
be true.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_forceSelection">forceSelection</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Whether or not to force the user's selection to match one of the query
|
|
results. Enabling this feature essentially transforms the input field into a
|
|
<select> field. This feature is not recommended with delimiter character(s)
|
|
defined.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_highlightClassName">highlightClassName</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Class name of a highlighted item within results container.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: "yui-ac-highlight"
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_maxResultsDisplayed">maxResultsDisplayed</a>
|
|
<code>- Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Maximum number of results to display in results container.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: 10
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_minQueryLength">minQueryLength</a>
|
|
<code>- Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Number of characters that must be entered before querying for results. A negative value
|
|
effectively turns off the widget. A value of 0 allows queries of null or empty string
|
|
values.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: 1
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_prehighlightClassName">prehighlightClassName</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Class name of a pre-highlighted item within results container.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_queryDelay">queryDelay</a>
|
|
<code>- Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Number of seconds to delay before submitting a query request. If a query
|
|
request is received before a previous one has completed its delay, the
|
|
previous request is cancelled and the new request is set to the delay. If
|
|
typeAhead is also enabled, this value must always be less than the typeAheadDelay
|
|
in order to avoid certain race conditions.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: 0.2
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_queryInterval">queryInterval</a>
|
|
<code>- Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
When IME usage is detected, AutoComplete will switch to querying the input
|
|
value at the given interval rather than per key event.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: 500
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_queryMatchCase">queryMatchCase</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
When applyLocalFilter is true, the local filtering algorthim can have case sensitivity
|
|
enabled.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_queryMatchContains">queryMatchContains</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
When applyLocalFilter is true, results can be locally filtered to return
|
|
matching strings that "contain" the query string rather than simply "start with"
|
|
the query string.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_queryMatchSubset">queryMatchSubset</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Enables query subset matching. When the DataSource's cache is enabled and queryMatchSubset is
|
|
true, substrings of queries will return matching cached results. For
|
|
instance, if the first query is for "abc" susequent queries that start with
|
|
"abc", like "abcd", will be queried against the cache, and not the live data
|
|
source. Recommended only for DataSources that return comprehensive results
|
|
for queries with very few characters.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_queryQuestionMark">queryQuestionMark</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
For XHR DataSources, AutoComplete will automatically insert a "?" between the server URI and
|
|
the "query" param/value pair. To prevent this behavior, implementers should
|
|
set this value to false. To more fully customize the query syntax, implementers
|
|
should override the generateRequest() method.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: true
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_resultTypeList">resultTypeList</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
For backward compatibility to pre-2.6.0 formatResults() signatures, setting
|
|
resultsTypeList to true will take each object literal result returned by
|
|
DataSource and flatten into an array.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: true
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_supressInputUpdate">supressInputUpdate</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Whether or not the input field should be updated with selections.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_typeAhead">typeAhead</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
If autohighlight is enabled, whether or not the input field should be automatically updated
|
|
with the first query result as the user types, auto-selecting the substring portion
|
|
of the first result that the user has not yet typed.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_typeAheadDelay">typeAheadDelay</a>
|
|
<code>- Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
If typeAhead is true, number of seconds to delay before updating input with
|
|
typeAhead value. In order to prevent certain race conditions, this value must
|
|
always be greater than the queryDelay.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: 0.5
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_useIFrame">useIFrame</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Whether or not to use an iFrame to layer over Windows form elements in
|
|
IE. Set to true only when the results container will be on top of a
|
|
<select> field in IE and thus exposed to the IE z-index bug (i.e.,
|
|
5.5 < IE < 7).
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_useShadow">useShadow</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Whether or not the results container should have a shadow.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="section method details">
|
|
<h3 id="methods">Methods</h3>
|
|
<div class="content">
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method___initProps">__initProps</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>__initProps</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Updates and validates latest public config properties.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__clearInterval">_clearInterval</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_clearInterval</strong>
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Cancels text input detection by intervals.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__clearSelection">_clearSelection</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_clearSelection</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
When forceSelection is true and the user attempts
|
|
leave the text input box without selecting an item from the query results,
|
|
the user selection is cleared.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__enableIntervalDetection">_enableIntervalDetection</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_enableIntervalDetection</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Enables interval detection for IME support.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__initContainerEl">_initContainerEl</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_initContainerEl</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Initializes the results container once at object creation
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__initContainerHelperEls">_initContainerHelperEls</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_initContainerHelperEls</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Initializes the results container helpers if they are enabled and do
|
|
not exist
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__initListEl">_initListEl</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_initListEl</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Clears out contents of container body and creates up to
|
|
YAHOO.widget.AutoComplete#maxResultsDisplayed <li> elements in an
|
|
<ul> element.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__isIgnoreKey">_isIgnoreKey</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
Boolean
|
|
<strong>_isIgnoreKey</strong>
|
|
(
|
|
|
|
|
|
nKeycode
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Whether or not key is functional or should be ignored. Note that the right
|
|
arrow key is NOT an ignored key since it triggers queries for certain intl
|
|
charsets.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>nKeycode <Number></code>
|
|
Code of key pressed.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd>True if key should be ignored, false otherwise.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__jumpSelection">_jumpSelection</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_jumpSelection</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
If an item is highlighted in the container, the right arrow key jumps to the
|
|
end of the textbox and selects the highlighted item, otherwise the container
|
|
is closed.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__moveSelection">_moveSelection</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_moveSelection</strong>
|
|
(
|
|
|
|
|
|
nKeyCode
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Triggered by up and down arrow keys, changes the current highlighted
|
|
<li> element item. Scrolls container if necessary.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>nKeyCode <Number></code>
|
|
Code of key pressed.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onContainerClick">_onContainerClick</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onContainerClick</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles container click events.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>v <HTMLEvent></code>
|
|
The click event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onContainerMouseout">_onContainerMouseout</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onContainerMouseout</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles container mouseout events.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>v <HTMLEvent></code>
|
|
The mouseout event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onContainerMouseover">_onContainerMouseover</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onContainerMouseover</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles container mouseover events.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>v <HTMLEvent></code>
|
|
The mouseover event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onContainerResize">_onContainerResize</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onContainerResize</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles container resize events.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>v <HTMLEvent></code>
|
|
The resize event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onContainerScroll">_onContainerScroll</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onContainerScroll</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles container scroll events.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>v <HTMLEvent></code>
|
|
The scroll event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onInterval">_onInterval</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onInterval</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Enables query triggers based on text input detection by intervals (rather
|
|
than by key events).
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onItemMouseclick">_onItemMouseclick</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onItemMouseclick</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles <li> element click events in the container.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>v <HTMLEvent></code>
|
|
The click event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onItemMouseout">_onItemMouseout</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onItemMouseout</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles <li> element mouseout events in the container.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>v <HTMLEvent></code>
|
|
The mouseout event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onItemMouseover">_onItemMouseover</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onItemMouseover</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles <li> element mouseover events in the container.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>v <HTMLEvent></code>
|
|
The mouseover event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onTextboxBlur">_onTextboxBlur</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onTextboxBlur</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles text input box losing focus.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>v <HTMLEvent></code>
|
|
The focus event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onTextboxFocus">_onTextboxFocus</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onTextboxFocus</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles text input box receiving focus.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>v <HTMLEvent></code>
|
|
The focus event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onTextboxKeyDown">_onTextboxKeyDown</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onTextboxKeyDown</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles textbox keydown events of functional keys, mainly for UI behavior.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>v <HTMLEvent></code>
|
|
The keydown event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onTextboxKeyPress">_onTextboxKeyPress</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onTextboxKeyPress</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles textbox keypress events.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>v <HTMLEvent></code>
|
|
The keypress event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onTextboxKeyUp">_onTextboxKeyUp</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onTextboxKeyUp</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles textbox keyup events to trigger queries.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>v <HTMLEvent></code>
|
|
The keyup event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onWindowUnload">_onWindowUnload</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onWindowUnload</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles window unload event.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>v <HTMLEvent></code>
|
|
The unload event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__populateList">_populateList</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_populateList</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
,
|
|
oResponse
|
|
|
|
|
|
,
|
|
oPayload
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Populates the array of <li> elements in the container with query
|
|
results.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
Original request.
|
|
</dd>
|
|
<dd>
|
|
<code>oResponse <Object></code>
|
|
Response object.
|
|
</dd>
|
|
<dd>
|
|
<code>oPayload <MIXED></code>
|
|
(optional) Additional argument(s)
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__selectItem">_selectItem</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_selectItem</strong>
|
|
(
|
|
|
|
|
|
elListItem
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Selects a result item from the container
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elListItem <HTMLElement></code>
|
|
The selected <li> element item.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__selectText">_selectText</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_selectText</strong>
|
|
(
|
|
|
|
|
|
elTextbox
|
|
|
|
|
|
,
|
|
nStart
|
|
|
|
|
|
,
|
|
nEnd
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Selects text in the input field.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elTextbox <HTMLElement></code>
|
|
Text input box element in which to select text.
|
|
</dd>
|
|
<dd>
|
|
<code>nStart <Number></code>
|
|
Starting index of text string to select.
|
|
</dd>
|
|
<dd>
|
|
<code>nEnd <Number></code>
|
|
Ending index of text selection.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__sendQuery">_sendQuery</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_sendQuery</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Makes query request to the DataSource.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
Query string.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__textMatchesOption">_textMatchesOption</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
HTMLElement
|
|
<strong>_textMatchesOption</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Whether or not user-typed value in the text input box matches any of the
|
|
query results.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
HTMLElement
|
|
</code></dt>
|
|
<dd>Matching list item element if user-input text matches
|
|
a result, null otherwise.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__toggleContainer">_toggleContainer</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_toggleContainer</strong>
|
|
(
|
|
|
|
|
|
bShow
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Animates expansion or collapse of the container.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>bShow <Boolean></code>
|
|
True if container should be expanded, false if container should be collapsed
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__toggleContainerHelpers">_toggleContainerHelpers</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_toggleContainerHelpers</strong>
|
|
(
|
|
|
|
|
|
bShow
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Syncs results container with its helpers.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>bShow <Boolean></code>
|
|
True if container is expanded, false if collapsed
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__toggleHighlight">_toggleHighlight</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_toggleHighlight</strong>
|
|
(
|
|
|
|
|
|
elNewListItem
|
|
|
|
|
|
,
|
|
sType
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Toggles the highlight on or off for an item in the container, and also cleans
|
|
up highlighting of any previous item.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elNewListItem <HTMLElement></code>
|
|
The <li> element item to receive highlight behavior.
|
|
</dd>
|
|
<dd>
|
|
<code>sType <String></code>
|
|
Type "mouseover" will toggle highlight on, and "mouseout" will toggle highlight off.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__togglePrehighlight">_togglePrehighlight</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_togglePrehighlight</strong>
|
|
(
|
|
|
|
|
|
elNewListItem
|
|
|
|
|
|
,
|
|
sType
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Toggles the pre-highlight on or off for an item in the container.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elNewListItem <HTMLElement></code>
|
|
The <li> element item to receive highlight behavior.
|
|
</dd>
|
|
<dd>
|
|
<code>sType <String></code>
|
|
Type "mouseover" will toggle highlight on, and "mouseout" will toggle highlight off.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__typeAhead">_typeAhead</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_typeAhead</strong>
|
|
(
|
|
|
|
|
|
elListItem
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Updates in the text input box with the first query result as the user types,
|
|
selecting the substring that the user has not typed.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elListItem <HTMLElement></code>
|
|
The <li> element item whose data populates the input field.
|
|
</dd>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
Query string.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__updateValue">_updateValue</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_updateValue</strong>
|
|
(
|
|
|
|
|
|
elListItem
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Updates the text input box value with selected query result. If a delimiter
|
|
has been defined, then the value gets appended with the delimiter.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elListItem <HTMLElement></code>
|
|
The <li> element item with which to update the value.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method_AutoComplete._cloneObject">AutoComplete._cloneObject</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
static
|
|
|
|
void
|
|
<strong>AutoComplete._cloneObject</strong>
|
|
(
|
|
|
|
|
|
o
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Clones object literal or array of object literals.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>o <Object></code>
|
|
Object.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_collapseContainer">collapseContainer</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>collapseContainer</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Collapses container.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_destroy">destroy</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>destroy</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Nulls out the entire AutoComplete instance and related objects, removes attached
|
|
event listeners, and clears out DOM elements inside the container. After
|
|
calling this method, the instance reference should be expliclitly nulled by
|
|
implementer, as in myDataTable = null. Use with caution!
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_doBeforeExpandContainer">doBeforeExpandContainer</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>doBeforeExpandContainer</strong>
|
|
(
|
|
|
|
|
|
elTextbox
|
|
|
|
|
|
,
|
|
elContainer
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
,
|
|
aResults
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Overridable method called before container expands allows implementers to access data
|
|
and DOM elements.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elTextbox <HTMLElement></code>
|
|
The text input box.
|
|
</dd>
|
|
<dd>
|
|
<code>elContainer <HTMLElement></code>
|
|
The container element.
|
|
</dd>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
The query string.
|
|
</dd>
|
|
<dd>
|
|
<code>aResults <Object[]></code>
|
|
An array of query results.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd>Return true to continue expanding container, false to cancel the expand.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_doBeforeLoadData">doBeforeLoadData</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>doBeforeLoadData</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
,
|
|
oResponse
|
|
|
|
|
|
,
|
|
oPayload
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Overridable method called before container is loaded with result data.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
Original request.
|
|
</dd>
|
|
<dd>
|
|
<code>oResponse <Object></code>
|
|
Response object.
|
|
</dd>
|
|
<dd>
|
|
<code>oPayload <MIXED></code>
|
|
(optional) Additional argument(s)
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd>Return true to continue loading data, false to cancel.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class=" deprecated">
|
|
<h4>
|
|
<a name="method_doBeforeSendQuery">doBeforeSendQuery</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>doBeforeSendQuery</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<div class="deprecated">
|
|
<strong>Deprecated</strong> Use generateRequest.
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_filterResults">filterResults</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Object
|
|
<strong>filterResults</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
,
|
|
oFullResponse
|
|
|
|
|
|
,
|
|
oParsedResponse
|
|
|
|
|
|
,
|
|
oCallback
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Executed by DataSource (within DataSource scope via doBeforeCallback()) to
|
|
filter results through a simple client-side matching algorithm.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
Original request.
|
|
</dd>
|
|
<dd>
|
|
<code>oFullResponse <Object></code>
|
|
Full response object.
|
|
</dd>
|
|
<dd>
|
|
<code>oParsedResponse <Object></code>
|
|
Parsed response object.
|
|
</dd>
|
|
<dd>
|
|
<code>oCallback <Object></code>
|
|
Callback object.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Object
|
|
</code></dt>
|
|
<dd>Filtered response object.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_formatResult">formatResult</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
String
|
|
<strong>formatResult</strong>
|
|
(
|
|
|
|
|
|
oResultData
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
,
|
|
sResultMatch
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Overridable method that returns HTML markup for one result to be populated
|
|
as innerHTML of an <LI> element.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oResultData <Object></code>
|
|
Result data object.
|
|
</dd>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
The corresponding query string.
|
|
</dd>
|
|
<dd>
|
|
<code>sResultMatch <HTMLElement></code>
|
|
The current query string.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
String
|
|
</code></dt>
|
|
<dd>HTML markup of formatted result data.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_generateRequest">generateRequest</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>generateRequest</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
A function that converts an AutoComplete query into a request value which is then
|
|
passed to the DataSource's sendRequest method in order to retrieve data for
|
|
the query. By default, returns a String with the syntax: "query={query}"
|
|
Implementers can customize this method for custom request syntaxes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
Query string
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getContainerEl">getContainerEl</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
HTMLELement
|
|
<strong>getContainerEl</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns DOM reference to container element.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
HTMLELement
|
|
</code></dt>
|
|
<dd>DOM reference to container element.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getInputEl">getInputEl</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
HTMLELement
|
|
<strong>getInputEl</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns DOM reference to input element.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
HTMLELement
|
|
</code></dt>
|
|
<dd>DOM reference to input element.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getListEl">getListEl</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
HTMLElement[]
|
|
<strong>getListEl</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Public accessor to the <ul> element that displays query results within the results container.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
HTMLElement[]
|
|
</code></dt>
|
|
<dd>Reference to <ul> element within the results container.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getListItemData">getListItemData</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Object
|
|
<strong>getListItemData</strong>
|
|
(
|
|
|
|
|
|
elListItem
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Public accessor to the result data associated with a given <li> result.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elListItem <HTMLElement></code>
|
|
Reference to <LI> element.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Object
|
|
</code></dt>
|
|
<dd>Result data.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getListItemIndex">getListItemIndex</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Number
|
|
<strong>getListItemIndex</strong>
|
|
(
|
|
|
|
|
|
elListItem
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Public accessor to the index of the associated with a given <li> result.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elListItem <HTMLElement></code>
|
|
Reference to <LI> element.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Number
|
|
</code></dt>
|
|
<dd>Index.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getListItemMatch">getListItemMatch</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
String
|
|
<strong>getListItemMatch</strong>
|
|
(
|
|
|
|
|
|
elListItem
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Public accessor to the matching string associated with a given <li> result.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elListItem <HTMLElement></code>
|
|
Reference to <LI> element.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
String
|
|
</code></dt>
|
|
<dd>Matching string.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class=" deprecated">
|
|
<h4>
|
|
<a name="method_getListItems">getListItems</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>getListItems</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<div class="deprecated">
|
|
<strong>Deprecated</strong> Use getListEl().childNodes.
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getSubsetMatches">getSubsetMatches</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Object
|
|
<strong>getSubsetMatches</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles subset matching for when queryMatchSubset is enabled.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
Query string.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Object
|
|
</code></dt>
|
|
<dd>oParsedResponse or null.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_handleResponse">handleResponse</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>handleResponse</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
,
|
|
oResponse
|
|
|
|
|
|
,
|
|
oPayload
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles response for display. This is the callback function method passed to
|
|
YAHOO.util.DataSourceBase#sendRequest so results from the DataSource are
|
|
returned to the AutoComplete instance.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
Original request.
|
|
</dd>
|
|
<dd>
|
|
<code>oResponse <Object></code>
|
|
Response object.
|
|
</dd>
|
|
<dd>
|
|
<code>oPayload <MIXED></code>
|
|
(optional) Additional argument(s)
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_isContainerOpen">isContainerOpen</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>isContainerOpen</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns true if container is in an expanded state, false otherwise.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd>Returns true if container is in an expanded state, false otherwise.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_isFocused">isFocused</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>isFocused</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns true if widget instance is currently focused.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd>Returns true if widget instance is currently focused.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_preparseRawResponse">preparseRawResponse</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Object
|
|
<strong>preparseRawResponse</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Executed by DataSource (within DataSource scope via doBeforeParseData()) to
|
|
handle responseStripAfter cleanup.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
Query string.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Object
|
|
</code></dt>
|
|
<dd>oParsedResponse or null.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_sendQuery">sendQuery</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>sendQuery</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Makes query request to the DataSource.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
Query string.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_setBody">setBody</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>setBody</strong>
|
|
(
|
|
|
|
|
|
sBody
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Sets HTML markup for the results container body. This markup will be
|
|
inserted within a <div> tag with a class of "yui-ac-bd".
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>sBody <String></code>
|
|
HTML markup for results container body.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_setFooter">setFooter</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>setFooter</strong>
|
|
(
|
|
|
|
|
|
sFooter
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Sets HTML markup for the results container footer. This markup will be
|
|
inserted within a <div> tag with a class of "yui-ac-ft".
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>sFooter <String></code>
|
|
HTML markup for results container footer.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_setHeader">setHeader</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>setHeader</strong>
|
|
(
|
|
|
|
|
|
sHeader
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Sets HTML markup for the results container header. This markup will be
|
|
inserted within a <div> tag with a class of "yui-ac-hd".
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>sHeader <String></code>
|
|
HTML markup for results container header.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_toString">toString</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
String
|
|
<strong>toString</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Public accessor to the unique name of the AutoComplete instance.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
String
|
|
</code></dt>
|
|
<dd>Unique name of the AutoComplete instance.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="section method details">
|
|
<h3 id="events">Events</h3>
|
|
<div class="content">
|
|
<div class="private">
|
|
<h4>
|
|
<a name="event__sLastTextboxValue">_sLastTextboxValue</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
<strong>_sLastTextboxValue</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Internal tracker to last known textbox value, used to determine whether or not
|
|
to trigger a query via interval for certain IME users.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_containerCollapseEvent">containerCollapseEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>containerCollapseEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when the results container is collapsed.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_containerExpandEvent">containerExpandEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>containerExpandEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
,
|
|
aResults
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when the results container is expanded.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
The query string.
|
|
</dd>
|
|
<dd>
|
|
<code>aResults <Object[]></code>
|
|
Results array.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_containerPopulateEvent">containerPopulateEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>containerPopulateEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when the results container is populated.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_dataErrorEvent">dataErrorEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>dataErrorEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when the AutoComplete instance does not receive query results from the
|
|
DataSource due to an error.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
The query string.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_dataRequestEvent">dataRequestEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>dataRequestEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
,
|
|
oRequest
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when the AutoComplete instance makes a request to the DataSource.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
The query string.
|
|
</dd>
|
|
<dd>
|
|
<code>oRequest <Object></code>
|
|
The request.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_dataReturnEvent">dataReturnEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>dataReturnEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
,
|
|
aResults
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when the AutoComplete instance receives query results from the data
|
|
source.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
The query string.
|
|
</dd>
|
|
<dd>
|
|
<code>aResults <Object[]></code>
|
|
Results array.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_itemArrowFromEvent">itemArrowFromEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>itemArrowFromEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
elItem
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when result item has been arrowed away from.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
<dd>
|
|
<code>elItem <HTMLElement></code>
|
|
The <li> element item arrowed from.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_itemArrowToEvent">itemArrowToEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>itemArrowToEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
elItem
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when result item has been arrowed to.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
<dd>
|
|
<code>elItem <HTMLElement></code>
|
|
The <li> element item arrowed to.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_itemMouseOutEvent">itemMouseOutEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>itemMouseOutEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
elItem
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when result item has been moused out.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
<dd>
|
|
<code>elItem <HTMLElement></code>
|
|
The <li> element item moused from.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_itemMouseOverEvent">itemMouseOverEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>itemMouseOverEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
elItem
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when result item has been moused over.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
<dd>
|
|
<code>elItem <HTMLElement></code>
|
|
The <li> element item moused to.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_itemSelectEvent">itemSelectEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>itemSelectEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
elItem
|
|
|
|
|
|
,
|
|
oData
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when an item is selected via mouse click, ENTER key, or TAB key.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
<dd>
|
|
<code>elItem <HTMLElement></code>
|
|
The selected <li> element item.
|
|
</dd>
|
|
<dd>
|
|
<code>oData <Object></code>
|
|
The data returned for the item, either as an object,
|
|
or mapped from the schema into an array.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_selectionEnforceEvent">selectionEnforceEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>selectionEnforceEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired if forceSelection is enabled and the user's input has been cleared
|
|
because it did not match one of the returned query results.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_textboxBlurEvent">textboxBlurEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>textboxBlurEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when the input field loses focus.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_textboxChangeEvent">textboxChangeEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>textboxChangeEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when the input field value has changed when it loses focus.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_textboxFocusEvent">textboxFocusEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>textboxFocusEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when the input field receives focus.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_textboxKeyEvent">textboxKeyEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>textboxKeyEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
nKeycode
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when the input field receives key input.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
<dd>
|
|
<code>nKeycode <Number></code>
|
|
The keycode number.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_typeAheadEvent">typeAheadEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>typeAheadEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
,
|
|
sPrefill
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when the input field has been prefilled by the type-ahead
|
|
feature.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
<dd>
|
|
<code>sQuery <String></code>
|
|
The query string.
|
|
</dd>
|
|
<dd>
|
|
<code>sPrefill <String></code>
|
|
The prefill string.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_unmatchedItemSelectEvent">unmatchedItemSelectEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>unmatchedItemSelectEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
sSelection
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when a user selection does not match any of the displayed result items.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oSelf <YAHOO.widget.AutoComplete></code>
|
|
The AutoComplete instance.
|
|
</dd>
|
|
<dd>
|
|
<code>sSelection <String></code>
|
|
The selected string.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="yui-b">
|
|
<div class="nav">
|
|
|
|
<div class="module">
|
|
<h4>Modules</h4>
|
|
<ul class="content">
|
|
|
|
<li class=""><a href="module_animation.html">animation</a></li>
|
|
|
|
<li class="selected"><a href="module_autocomplete.html">autocomplete</a></li>
|
|
|
|
<li class=""><a href="module_button.html">button</a></li>
|
|
|
|
<li class=""><a href="module_calendar.html">calendar</a></li>
|
|
|
|
<li class=""><a href="module_carousel.html">carousel</a></li>
|
|
|
|
<li class=""><a href="module_charts.html">charts</a></li>
|
|
|
|
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
|
|
|
|
<li class=""><a href="module_connection.html">connection</a></li>
|
|
|
|
<li class=""><a href="module_container.html">container</a></li>
|
|
|
|
<li class=""><a href="module_cookie.html">cookie</a></li>
|
|
|
|
<li class=""><a href="module_datasource.html">datasource</a></li>
|
|
|
|
<li class=""><a href="module_datatable.html">datatable</a></li>
|
|
|
|
<li class=""><a href="module_dom.html">dom</a></li>
|
|
|
|
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
|
|
|
|
<li class=""><a href="module_editor.html">editor</a></li>
|
|
|
|
<li class=""><a href="module_element.html">element</a></li>
|
|
|
|
<li class=""><a href="module_event.html">event</a></li>
|
|
|
|
<li class=""><a href="module_get.html">get</a></li>
|
|
|
|
<li class=""><a href="module_history.html">history</a></li>
|
|
|
|
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
|
|
|
|
<li class=""><a href="module_imageloader.html">imageloader</a></li>
|
|
|
|
<li class=""><a href="module_json.html">json</a></li>
|
|
|
|
<li class=""><a href="module_layout.html">layout</a></li>
|
|
|
|
<li class=""><a href="module_logger.html">logger</a></li>
|
|
|
|
<li class=""><a href="module_menu.html">menu</a></li>
|
|
|
|
<li class=""><a href="module_paginator.html">paginator</a></li>
|
|
|
|
<li class=""><a href="module_profiler.html">profiler</a></li>
|
|
|
|
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
|
|
|
|
<li class=""><a href="module_resize.html">resize</a></li>
|
|
|
|
<li class=""><a href="module_selector.html">selector</a></li>
|
|
|
|
<li class=""><a href="module_slider.html">slider</a></li>
|
|
|
|
<li class=""><a href="module_tabview.html">tabview</a></li>
|
|
|
|
<li class=""><a href="module_treeview.html">treeview</a></li>
|
|
|
|
<li class=""><a href="module_uploader.html">uploader</a></li>
|
|
|
|
<li class=""><a href="module_yahoo.html">yahoo</a></li>
|
|
|
|
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
|
|
|
|
<li class=""><a href="module_yuitest.html">yuitest</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Classes</h4>
|
|
<ul class="content">
|
|
<li class="selected"><a href="YAHOO.widget.AutoComplete.html">YAHOO.widget.AutoComplete</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Files</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="AutoComplete.js.html">AutoComplete.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Properties</h4>
|
|
<ul class="content">
|
|
<li class="private"><a href="#property__bContainerOpen">_bContainerOpen</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__bFocused">_bFocused</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__bItemSelected">_bItemSelected</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__bOverContainer">_bOverContainer</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elBody">_elBody</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elContainer">_elContainer</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elContent">_elContent</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elCurListItem">_elCurListItem</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elFooter">_elFooter</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elHeader">_elHeader</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elIFrame">_elIFrame</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elList">_elList</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elShadow">_elShadow</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elTextbox">_elTextbox</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__iFrameSrc">_iFrameSrc</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__nDelayID">_nDelayID</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__nDisplayedItems">_nDisplayedItems</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__nIndex">_nIndex</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__nKeyCode">_nKeyCode</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__nTypeAheadDelayID">_nTypeAheadDelayID</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__oAnim">_oAnim</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__queryInterval">_queryInterval</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__sCurQuery">_sCurQuery</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__sInitInputValue">_sInitInputValue</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__sName">_sName</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__sPastSelections">_sPastSelections</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_allowBrowserAutocomplete">allowBrowserAutocomplete</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_alwaysShowContainer">alwaysShowContainer</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_animHoriz">animHoriz</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_animSpeed">animSpeed</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_animVert">animVert</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_applyLocalFilter">applyLocalFilter</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_autoHighlight">autoHighlight</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_dataSource">dataSource</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_delimChar">delimChar</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_forceSelection">forceSelection</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_highlightClassName">highlightClassName</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_maxResultsDisplayed">maxResultsDisplayed</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_minQueryLength">minQueryLength</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_prehighlightClassName">prehighlightClassName</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_queryDelay">queryDelay</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_queryInterval">queryInterval</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_queryMatchCase">queryMatchCase</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_queryMatchContains">queryMatchContains</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_queryMatchSubset">queryMatchSubset</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_queryQuestionMark">queryQuestionMark</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_resultTypeList">resultTypeList</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_supressInputUpdate">supressInputUpdate</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_typeAhead">typeAhead</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_typeAheadDelay">typeAheadDelay</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_useIFrame">useIFrame</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_useShadow">useShadow</a>
|
|
<!--<code><Boolean></code>-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Methods</h4>
|
|
<ul class="content">
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method___initProps">__initProps</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__clearInterval">_clearInterval</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__clearSelection">_clearSelection</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__enableIntervalDetection">_enableIntervalDetection</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__initContainerEl">_initContainerEl</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__initContainerHelperEls">_initContainerHelperEls</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__initListEl">_initListEl</a>
|
|
</li>
|
|
<li class="private"><!--<code>Boolean</code>-->
|
|
<a href="#method__isIgnoreKey">_isIgnoreKey</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__jumpSelection">_jumpSelection</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__moveSelection">_moveSelection</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onContainerClick">_onContainerClick</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onContainerMouseout">_onContainerMouseout</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onContainerMouseover">_onContainerMouseover</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onContainerResize">_onContainerResize</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onContainerScroll">_onContainerScroll</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onInterval">_onInterval</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onItemMouseclick">_onItemMouseclick</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onItemMouseout">_onItemMouseout</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onItemMouseover">_onItemMouseover</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onTextboxBlur">_onTextboxBlur</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onTextboxFocus">_onTextboxFocus</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onTextboxKeyDown">_onTextboxKeyDown</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onTextboxKeyPress">_onTextboxKeyPress</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onTextboxKeyUp">_onTextboxKeyUp</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onWindowUnload">_onWindowUnload</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__populateList">_populateList</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__selectItem">_selectItem</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__selectText">_selectText</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__sendQuery">_sendQuery</a>
|
|
</li>
|
|
<li class="private"><!--<code>HTMLElement</code>-->
|
|
<a href="#method__textMatchesOption">_textMatchesOption</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__toggleContainer">_toggleContainer</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__toggleContainerHelpers">_toggleContainerHelpers</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__toggleHighlight">_toggleHighlight</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__togglePrehighlight">_togglePrehighlight</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__typeAhead">_typeAhead</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__updateValue">_updateValue</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method_AutoComplete._cloneObject">AutoComplete._cloneObject</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_collapseContainer">collapseContainer</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_destroy">destroy</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_doBeforeExpandContainer">doBeforeExpandContainer</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_doBeforeLoadData">doBeforeLoadData</a>
|
|
</li>
|
|
<li class=" deprecated"><!--<code>void</code>-->
|
|
<a href="#method_doBeforeSendQuery">doBeforeSendQuery</a>
|
|
</li>
|
|
<li class=""><!--<code>Object</code>-->
|
|
<a href="#method_filterResults">filterResults</a>
|
|
</li>
|
|
<li class=""><!--<code>String</code>-->
|
|
<a href="#method_formatResult">formatResult</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_generateRequest">generateRequest</a>
|
|
</li>
|
|
<li class=""><!--<code>HTMLELement</code>-->
|
|
<a href="#method_getContainerEl">getContainerEl</a>
|
|
</li>
|
|
<li class=""><!--<code>HTMLELement</code>-->
|
|
<a href="#method_getInputEl">getInputEl</a>
|
|
</li>
|
|
<li class=""><!--<code>HTMLElement[]</code>-->
|
|
<a href="#method_getListEl">getListEl</a>
|
|
</li>
|
|
<li class=""><!--<code>Object</code>-->
|
|
<a href="#method_getListItemData">getListItemData</a>
|
|
</li>
|
|
<li class=""><!--<code>Number</code>-->
|
|
<a href="#method_getListItemIndex">getListItemIndex</a>
|
|
</li>
|
|
<li class=""><!--<code>String</code>-->
|
|
<a href="#method_getListItemMatch">getListItemMatch</a>
|
|
</li>
|
|
<li class=" deprecated"><!--<code>void</code>-->
|
|
<a href="#method_getListItems">getListItems</a>
|
|
</li>
|
|
<li class=""><!--<code>Object</code>-->
|
|
<a href="#method_getSubsetMatches">getSubsetMatches</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_handleResponse">handleResponse</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_isContainerOpen">isContainerOpen</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_isFocused">isFocused</a>
|
|
</li>
|
|
<li class=""><!--<code>Object</code>-->
|
|
<a href="#method_preparseRawResponse">preparseRawResponse</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_sendQuery">sendQuery</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_setBody">setBody</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_setFooter">setFooter</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_setHeader">setHeader</a>
|
|
</li>
|
|
<li class=""><!--<code>String</code>-->
|
|
<a href="#method_toString">toString</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Events</h4>
|
|
<ul class="content">
|
|
<li class="private">
|
|
<a href="#event__sLastTextboxValue">_sLastTextboxValue</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_containerCollapseEvent">containerCollapseEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_containerExpandEvent">containerExpandEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_containerPopulateEvent">containerPopulateEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_dataErrorEvent">dataErrorEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_dataRequestEvent">dataRequestEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_dataReturnEvent">dataReturnEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_itemArrowFromEvent">itemArrowFromEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_itemArrowToEvent">itemArrowToEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_itemMouseOutEvent">itemMouseOutEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_itemMouseOverEvent">itemMouseOverEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_itemSelectEvent">itemSelectEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_selectionEnforceEvent">selectionEnforceEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_textboxBlurEvent">textboxBlurEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_textboxChangeEvent">textboxChangeEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_textboxFocusEvent">textboxFocusEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_textboxKeyEvent">textboxKeyEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_typeAheadEvent">typeAheadEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_unmatchedItemSelectEvent">unmatchedItemSelectEvent</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2008 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|