mirror of
https://github.com/alchemy-fr/Phraseanet.git
synced 2025-10-14 05:23:21 +00:00
5529 lines
333 KiB
HTML
5529 lines
333 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
|
|
<title>API: autocomplete YAHOO.widget.AutoComplete (YUI Library)</title>
|
|
|
|
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
|
|
<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">
|
|
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
|
|
<h3>AutoComplete Widget <span class="subtitle">2.8.2r1</span></h3>
|
|
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
|
|
> <a href="./module_autocomplete.html" title="autocomplete">autocomplete</a>
|
|
> YAHOO.widget.AutoComplete
|
|
|
|
<form onsubmit="return false">
|
|
<div id="propertysearch">
|
|
Search: <input autocomplete="off" id="searchinput" />
|
|
<div id="searchresults">
|
|
|
|
</div>
|
|
</div>
|
|
</form>
|
|
</div>
|
|
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
|
|
<fieldset>
|
|
<legend>Filters</legend>
|
|
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
|
|
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
|
|
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
|
|
</fieldset>
|
|
</form>
|
|
|
|
<h2>
|
|
|
|
|
|
|
|
|
|
Class <b property="yui:name">YAHOO.widget.AutoComplete</b>
|
|
<span class="extends">
|
|
</span>
|
|
|
|
</h2>
|
|
<!-- class tree goes here -->
|
|
|
|
|
|
|
|
|
|
<div class="summary description" property="yui: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" rel="yui:constructor" resource="#constructor">
|
|
<h3 id="constructor">Constructor</h3>
|
|
<div class="content">
|
|
<div class="detail">
|
|
<strong property="yui:name">YAHOO.widget.AutoComplete</strong>
|
|
<code>
|
|
(
|
|
|
|
|
|
|
|
elInput
|
|
|
|
|
|
,
|
|
elContainer
|
|
|
|
|
|
,
|
|
oDataSource
|
|
|
|
,
|
|
oConfigs
|
|
)
|
|
</code>
|
|
<div class="description">
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elInput</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> DOM element reference of an input field.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elInput</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> String ID of an input field.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elContainer</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> DOM element reference of an existing DIV.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elContainer</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> String ID of an existing DIV.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oDataSource</span>
|
|
<<span property="yui:type">YAHOO.widget.DataSource</span>>
|
|
</code>
|
|
<span property="yui:description"> DataSource instance.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oConfigs</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> (optional) Object literal of configuration params.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div rel="yui:properties" resource="#properties">
|
|
<div class="section field details">
|
|
<h3 id="properties">Properties</h3>
|
|
<div class="content">
|
|
<div class="private" rel="yui:property" resource="#property__bContainerOpen">
|
|
<h4><a name="property__bContainerOpen" property="yui:name">_bContainerOpen</a>
|
|
- <code>private <span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Whether or not the results container is currently open.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__bFocused">
|
|
<h4><a name="property__bFocused" property="yui:name">_bFocused</a>
|
|
- <code>private <span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Whether or not the widget instance is currently active. 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" rel="yui:property" resource="#property__bItemSelected">
|
|
<h4><a name="property__bItemSelected" property="yui:name">_bItemSelected</a>
|
|
- <code>private <span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" rel="yui:property" resource="#property__bOverContainer">
|
|
<h4><a name="property__bOverContainer" property="yui:name">_bOverContainer</a>
|
|
- <code>private <span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" rel="yui:property" resource="#property__elBody">
|
|
<h4><a name="property__elBody" property="yui:name">_elBody</a>
|
|
- <code>private <span property="yui:type">HTMLElement</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Reference to body element within content element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__elContainer">
|
|
<h4><a name="property__elContainer" property="yui:name">_elContainer</a>
|
|
- <code>private <span property="yui:type">HTMLElement</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Container DOM element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__elContent">
|
|
<h4><a name="property__elContent" property="yui:name">_elContent</a>
|
|
- <code>private <span property="yui:type">HTMLElement</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Reference to content element within container element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__elCurListItem">
|
|
<h4><a name="property__elCurListItem" property="yui:name">_elCurListItem</a>
|
|
- <code>private <span property="yui:type">HTMLElement</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Pointer to the currently highlighted <li> element in the container.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__elCurPrehighlightItem">
|
|
<h4><a name="property__elCurPrehighlightItem" property="yui:name">_elCurPrehighlightItem</a>
|
|
- <code>private <span property="yui:type">HTMLElement</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Pointer to the currently pre-highlighted <li> element in the container.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__elFooter">
|
|
<h4><a name="property__elFooter" property="yui:name">_elFooter</a>
|
|
- <code>private <span property="yui:type">HTMLElement</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Reference to footer element within content element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__elHeader">
|
|
<h4><a name="property__elHeader" property="yui:name">_elHeader</a>
|
|
- <code>private <span property="yui:type">HTMLElement</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Reference to header element within content element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__elIFrame">
|
|
<h4><a name="property__elIFrame" property="yui:name">_elIFrame</a>
|
|
- <code>private <span property="yui:type">HTMLElement</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Reference to iframe element within container element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__elList">
|
|
<h4><a name="property__elList" property="yui:name">_elList</a>
|
|
- <code>private <span property="yui:type">HTMLElement</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Internal reference to <ul> elements that contains query results within the
|
|
results container.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__elShadow">
|
|
<h4><a name="property__elShadow" property="yui:name">_elShadow</a>
|
|
- <code>private <span property="yui:type">HTMLElement</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Reference to shadow element within container element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__elTextbox">
|
|
<h4><a name="property__elTextbox" property="yui:name">_elTextbox</a>
|
|
- <code>private <span property="yui:type">HTMLElement</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Text input field DOM element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__iFrameSrc">
|
|
<h4><a name="property__iFrameSrc" property="yui:name">_iFrameSrc</a>
|
|
- <code>private <span property="yui:type">String</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Src to iFrame used when useIFrame = true. Supports implementations over SSL
|
|
as well.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__nDelayID">
|
|
<h4><a name="property__nDelayID" property="yui:name">_nDelayID</a>
|
|
- <code>private <span property="yui:type">Number</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Delay timeout ID.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__nDisplayedItems">
|
|
<h4><a name="property__nDisplayedItems" property="yui:name">_nDisplayedItems</a>
|
|
- <code>private <span property="yui:type">Number</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Number of <li> elements currently displayed in results container.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__nIndex">
|
|
<h4><a name="property__nIndex" property="yui:name">_nIndex</a>
|
|
- <code>private <span property="yui:type">Number</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Internal class variable to index multiple AutoComplete instances.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: 0
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__nKeyCode">
|
|
<h4><a name="property__nKeyCode" property="yui:name">_nKeyCode</a>
|
|
- <code>private <span property="yui:type">Number</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Key code of the last key pressed in textbox.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__nTypeAheadDelayID">
|
|
<h4><a name="property__nTypeAheadDelayID" property="yui:name">_nTypeAheadDelayID</a>
|
|
- <code>private <span property="yui:type">Number</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
TypeAhead delay timeout ID.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__oAnim">
|
|
<h4><a name="property__oAnim" property="yui:name">_oAnim</a>
|
|
- <code>private <span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Animation instance for container expand/collapse.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__queryInterval">
|
|
<h4><a name="property__queryInterval" property="yui:name">_queryInterval</a>
|
|
- <code>private <span property="yui:type">Object</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" rel="yui:property" resource="#property__sCurQuery">
|
|
<h4><a name="property__sCurQuery" property="yui:name">_sCurQuery</a>
|
|
- <code>private <span property="yui:type">String</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Current query string
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__sInitInputValue">
|
|
<h4><a name="property__sInitInputValue" property="yui:name">_sInitInputValue</a>
|
|
- <code>private <span property="yui:type">String</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Stores initial input value used to determine if textboxChangeEvent should be fired.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__sName">
|
|
<h4><a name="property__sName" property="yui:name">_sName</a>
|
|
- <code>private <span property="yui:type">String</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Name of AutoComplete instance.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__sPastSelections">
|
|
<h4><a name="property__sPastSelections" property="yui:name">_sPastSelections</a>
|
|
- <code>private <span property="yui:type">String</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Selections from previous queries (for saving delimited queries).
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: ""
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_allowBrowserAutocomplete">
|
|
<h4><a name="property_allowBrowserAutocomplete" property="yui:name">allowBrowserAutocomplete</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" property="yui:defaultValue">
|
|
Default Value: true
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_alwaysShowContainer">
|
|
<h4><a name="property_alwaysShowContainer" property="yui:name">alwaysShowContainer</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" property="yui:defaultValue">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_animHoriz">
|
|
<h4><a name="property_animHoriz" property="yui:name">animHoriz</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Whether or not to animate the expansion/collapse of the results container in the
|
|
horizontal direction.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_animSpeed">
|
|
<h4><a name="property_animSpeed" property="yui:name">animSpeed</a>
|
|
- <code><span property="yui:type">Number</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Speed of container expand/collapse animation, in seconds..
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: 0.3
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_animVert">
|
|
<h4><a name="property_animVert" property="yui:name">animVert</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Whether or not to animate the expansion/collapse of the results container in the
|
|
vertical direction.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: true
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_applyLocalFilter">
|
|
<h4><a name="property_applyLocalFilter" property="yui:name">applyLocalFilter</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" property="yui:defaultValue">
|
|
Default Value: true for local arrays and json, otherwise false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_autoHighlight">
|
|
<h4><a name="property_autoHighlight" property="yui:name">autoHighlight</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Whether or not the first item in results container should be automatically highlighted
|
|
on expand.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: true
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_autoSnapContainer">
|
|
<h4><a name="property_autoSnapContainer" property="yui:name">autoSnapContainer</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
If true, before each time the container expands, the container element will be
|
|
positioned to snap to the bottom-left corner of the input element. If
|
|
autoSnapContainer is set to false, this positioning will not be done.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: true
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_dataSource">
|
|
<h4><a name="property_dataSource" property="yui:name">dataSource</a>
|
|
- <code><span property="yui:type">YAHOO.widget.DataSource</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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="" rel="yui:property" resource="#property_delimChar">
|
|
<h4><a name="property_delimChar" property="yui:name">delimChar</a>
|
|
- <code><span property="yui:type">String | String[]</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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="" rel="yui:property" resource="#property_forceSelection">
|
|
<h4><a name="property_forceSelection" property="yui:name">forceSelection</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" property="yui:defaultValue">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_highlightClassName">
|
|
<h4><a name="property_highlightClassName" property="yui:name">highlightClassName</a>
|
|
- <code><span property="yui:type">String</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Class name of a highlighted item within results container.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: "yui-ac-highlight"
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_maxResultsDisplayed">
|
|
<h4><a name="property_maxResultsDisplayed" property="yui:name">maxResultsDisplayed</a>
|
|
- <code><span property="yui:type">Number</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Maximum number of results to display in results container.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: 10
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_minQueryLength">
|
|
<h4><a name="property_minQueryLength" property="yui:name">minQueryLength</a>
|
|
- <code><span property="yui:type">Number</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" property="yui:defaultValue">
|
|
Default Value: 1
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_prehighlightClassName">
|
|
<h4><a name="property_prehighlightClassName" property="yui:name">prehighlightClassName</a>
|
|
- <code><span property="yui:type">String</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Class name of a pre-highlighted item within results container.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_queryDelay">
|
|
<h4><a name="property_queryDelay" property="yui:name">queryDelay</a>
|
|
- <code><span property="yui:type">Number</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" property="yui:defaultValue">
|
|
Default Value: 0.2
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_queryInterval">
|
|
<h4><a name="property_queryInterval" property="yui:name">queryInterval</a>
|
|
- <code><span property="yui:type">Number</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
When IME usage is detected or interval detection is explicitly enabled,
|
|
AutoComplete will detect the input value at the given interval and send a
|
|
query if the value has changed.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: 500
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_queryMatchCase">
|
|
<h4><a name="property_queryMatchCase" property="yui:name">queryMatchCase</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
When applyLocalFilter is true, the local filtering algorthim can have case sensitivity
|
|
enabled.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_queryMatchContains">
|
|
<h4><a name="property_queryMatchContains" property="yui:name">queryMatchContains</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" property="yui:defaultValue">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_queryMatchSubset">
|
|
<h4><a name="property_queryMatchSubset" property="yui:name">queryMatchSubset</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" property="yui:defaultValue">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_queryQuestionMark">
|
|
<h4><a name="property_queryQuestionMark" property="yui:name">queryQuestionMark</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" property="yui:defaultValue">
|
|
Default Value: true
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_resultTypeList">
|
|
<h4><a name="property_resultTypeList" property="yui:name">resultTypeList</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" property="yui:defaultValue">
|
|
Default Value: true
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_suppressInputUpdate">
|
|
<h4><a name="property_suppressInputUpdate" property="yui:name">suppressInputUpdate</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Whether or not the input field should be updated with selections.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_typeAhead">
|
|
<h4><a name="property_typeAhead" property="yui:name">typeAhead</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" property="yui:defaultValue">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_typeAheadDelay">
|
|
<h4><a name="property_typeAheadDelay" property="yui:name">typeAheadDelay</a>
|
|
- <code><span property="yui:type">Number</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" property="yui:defaultValue">
|
|
Default Value: 0.5
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_useIFrame">
|
|
<h4><a name="property_useIFrame" property="yui:name">useIFrame</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui: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" property="yui:defaultValue">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:property" resource="#property_useShadow">
|
|
<h4><a name="property_useShadow" property="yui:name">useShadow</a>
|
|
- <code><span property="yui:type">Boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Whether or not the results container should have a shadow.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div rel="yui:methods" resource="#methods">
|
|
<div class="section method details">
|
|
<h3 id="methods">Methods</h3>
|
|
<div class="content">
|
|
<div class="private" rel="yui:method" resource="#method___initProps">
|
|
<h4>
|
|
<a name="method___initProps">__initProps</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">__initProps</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Updates and validates latest public config properties.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__clearInterval">
|
|
<h4>
|
|
<a name="method__clearInterval">_clearInterval</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_clearInterval</strong>
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Cancels text input detection by intervals.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__clearSelection">
|
|
<h4>
|
|
<a name="method__clearSelection">_clearSelection</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_clearSelection</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui: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">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__doBeforeExpandContainer">
|
|
<h4>
|
|
<a name="method__doBeforeExpandContainer">_doBeforeExpandContainer</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
Boolean
|
|
<strong property="yui:name">_doBeforeExpandContainer</strong>
|
|
(
|
|
|
|
|
|
elTextbox
|
|
|
|
|
|
,
|
|
elContainer
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
,
|
|
aResults
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Called before container expands, by default snaps container to the
|
|
bottom-left corner of the input element, then calls public overrideable method.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elTextbox</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The text input box.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elContainer</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The container element.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The query string.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">aResults</span>
|
|
<<span property="yui:type">Object[]</span>>
|
|
</code>
|
|
<span property="yui:description"> An array of query results.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Return true to continue expanding container, false to cancel the expand.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__enableIntervalDetection">
|
|
<h4>
|
|
<a name="method__enableIntervalDetection">_enableIntervalDetection</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_enableIntervalDetection</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Enables interval detection for IME support.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__extractQuery">
|
|
<h4>
|
|
<a name="method__extractQuery">_extractQuery</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
Object
|
|
<strong property="yui:name">_extractQuery</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Extracts rightmost query from delimited string.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> String to parse</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Object
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Object literal containing properties "query" and "previous".</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__focus">
|
|
<h4>
|
|
<a name="method__focus">_focus</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_focus</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Focuses input field.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__initContainerEl">
|
|
<h4>
|
|
<a name="method__initContainerEl">_initContainerEl</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_initContainerEl</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Initializes the results container once at object creation
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__initContainerHelperEls">
|
|
<h4>
|
|
<a name="method__initContainerHelperEls">_initContainerHelperEls</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_initContainerHelperEls</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Initializes the results container helpers if they are enabled and do
|
|
not exist
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__initListEl">
|
|
<h4>
|
|
<a name="method__initListEl">_initListEl</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_initListEl</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui: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">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__isIgnoreKey">
|
|
<h4>
|
|
<a name="method__isIgnoreKey">_isIgnoreKey</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
Boolean
|
|
<strong property="yui:name">_isIgnoreKey</strong>
|
|
(
|
|
|
|
|
|
nKeycode
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui: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 rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">nKeycode</span>
|
|
<<span property="yui:type">Number</span>>
|
|
</code>
|
|
<span property="yui:description"> Code of key pressed.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">True if key should be ignored, false otherwise.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__jumpSelection">
|
|
<h4>
|
|
<a name="method__jumpSelection">_jumpSelection</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_jumpSelection</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui: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">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__moveSelection">
|
|
<h4>
|
|
<a name="method__moveSelection">_moveSelection</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_moveSelection</strong>
|
|
(
|
|
|
|
|
|
nKeyCode
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Triggered by up and down arrow keys, changes the current highlighted
|
|
<li> element item. Scrolls container if necessary.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">nKeyCode</span>
|
|
<<span property="yui:type">Number</span>>
|
|
</code>
|
|
<span property="yui:description"> Code of key pressed.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__onContainerClick">
|
|
<h4>
|
|
<a name="method__onContainerClick">_onContainerClick</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_onContainerClick</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Handles container click events.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">v</span>
|
|
<<span property="yui:type">HTMLEvent</span>>
|
|
</code>
|
|
<span property="yui:description"> The click event.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__onContainerMouseout">
|
|
<h4>
|
|
<a name="method__onContainerMouseout">_onContainerMouseout</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_onContainerMouseout</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Handles container mouseout events.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">v</span>
|
|
<<span property="yui:type">HTMLEvent</span>>
|
|
</code>
|
|
<span property="yui:description"> The mouseout event.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__onContainerMouseover">
|
|
<h4>
|
|
<a name="method__onContainerMouseover">_onContainerMouseover</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_onContainerMouseover</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Handles container mouseover events.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">v</span>
|
|
<<span property="yui:type">HTMLEvent</span>>
|
|
</code>
|
|
<span property="yui:description"> The mouseover event.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__onContainerResize">
|
|
<h4>
|
|
<a name="method__onContainerResize">_onContainerResize</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_onContainerResize</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Handles container resize events.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">v</span>
|
|
<<span property="yui:type">HTMLEvent</span>>
|
|
</code>
|
|
<span property="yui:description"> The resize event.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__onContainerScroll">
|
|
<h4>
|
|
<a name="method__onContainerScroll">_onContainerScroll</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_onContainerScroll</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Handles container scroll events.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">v</span>
|
|
<<span property="yui:type">HTMLEvent</span>>
|
|
</code>
|
|
<span property="yui:description"> The scroll event.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__onInterval">
|
|
<h4>
|
|
<a name="method__onInterval">_onInterval</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_onInterval</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Enables query triggers based on text input detection by intervals (rather
|
|
than by key events).
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__onTextboxBlur">
|
|
<h4>
|
|
<a name="method__onTextboxBlur">_onTextboxBlur</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_onTextboxBlur</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Handles text input box losing focus.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">v</span>
|
|
<<span property="yui:type">HTMLEvent</span>>
|
|
</code>
|
|
<span property="yui:description"> The focus event.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__onTextboxFocus">
|
|
<h4>
|
|
<a name="method__onTextboxFocus">_onTextboxFocus</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_onTextboxFocus</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Handles text input box receiving focus.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">v</span>
|
|
<<span property="yui:type">HTMLEvent</span>>
|
|
</code>
|
|
<span property="yui:description"> The focus event.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__onTextboxKeyDown">
|
|
<h4>
|
|
<a name="method__onTextboxKeyDown">_onTextboxKeyDown</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_onTextboxKeyDown</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Handles textbox keydown events of functional keys, mainly for UI behavior.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">v</span>
|
|
<<span property="yui:type">HTMLEvent</span>>
|
|
</code>
|
|
<span property="yui:description"> The keydown event.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__onTextboxKeyPress">
|
|
<h4>
|
|
<a name="method__onTextboxKeyPress">_onTextboxKeyPress</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_onTextboxKeyPress</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Handles textbox keypress events.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">v</span>
|
|
<<span property="yui:type">HTMLEvent</span>>
|
|
</code>
|
|
<span property="yui:description"> The keypress event.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__onTextboxKeyUp">
|
|
<h4>
|
|
<a name="method__onTextboxKeyUp">_onTextboxKeyUp</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_onTextboxKeyUp</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Handles textbox keyup events to trigger queries.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">v</span>
|
|
<<span property="yui:type">HTMLEvent</span>>
|
|
</code>
|
|
<span property="yui:description"> The keyup event.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__onWindowUnload">
|
|
<h4>
|
|
<a name="method__onWindowUnload">_onWindowUnload</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_onWindowUnload</strong>
|
|
(
|
|
|
|
|
|
v
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Handles window unload event.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">v</span>
|
|
<<span property="yui:type">HTMLEvent</span>>
|
|
</code>
|
|
<span property="yui:description"> The unload event.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__populateList">
|
|
<h4>
|
|
<a name="method__populateList">_populateList</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_populateList</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
,
|
|
oResponse
|
|
|
|
|
|
,
|
|
oPayload
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Populates the array of <li> elements in the container with query
|
|
results.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> Original request.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oResponse</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> Response object.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oPayload</span>
|
|
<<span property="yui:type">MIXED</span>>
|
|
</code>
|
|
<span property="yui:description"> (optional) Additional argument(s)</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__populateListItem">
|
|
<h4>
|
|
<a name="method__populateListItem">_populateListItem</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_populateListItem</strong>
|
|
(
|
|
|
|
|
|
elListItem
|
|
|
|
|
|
,
|
|
oResult
|
|
|
|
|
|
,
|
|
sCurQuery
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Populates the given <li> element with return value from formatResult().
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elListItem</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The LI element.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oResult</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> The result object.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sCurQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The query string.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__selectItem">
|
|
<h4>
|
|
<a name="method__selectItem">_selectItem</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_selectItem</strong>
|
|
(
|
|
|
|
|
|
elListItem
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Selects a result item from the container
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elListItem</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The selected <li> element item.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__selectText">
|
|
<h4>
|
|
<a name="method__selectText">_selectText</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_selectText</strong>
|
|
(
|
|
|
|
|
|
elTextbox
|
|
|
|
|
|
,
|
|
nStart
|
|
|
|
|
|
,
|
|
nEnd
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Selects text in the input field.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elTextbox</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> Text input box element in which to select text.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">nStart</span>
|
|
<<span property="yui:type">Number</span>>
|
|
</code>
|
|
<span property="yui:description"> Starting index of text string to select.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">nEnd</span>
|
|
<<span property="yui:type">Number</span>>
|
|
</code>
|
|
<span property="yui:description"> Ending index of text selection.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__sendQuery">
|
|
<h4>
|
|
<a name="method__sendQuery">_sendQuery</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_sendQuery</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Makes query request to the DataSource.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> Query string.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__textMatchesOption">
|
|
<h4>
|
|
<a name="method__textMatchesOption">_textMatchesOption</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
HTMLElement
|
|
<strong property="yui:name">_textMatchesOption</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui: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 property="yui:return">
|
|
HTMLElement
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Matching list item element if user-input text matches
|
|
a result, null otherwise.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__toggleContainer">
|
|
<h4>
|
|
<a name="method__toggleContainer">_toggleContainer</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_toggleContainer</strong>
|
|
(
|
|
|
|
|
|
bShow
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Animates expansion or collapse of the container.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">bShow</span>
|
|
<<span property="yui:type">Boolean</span>>
|
|
</code>
|
|
<span property="yui:description"> True if container should be expanded, false if container should be collapsed</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__toggleContainerHelpers">
|
|
<h4>
|
|
<a name="method__toggleContainerHelpers">_toggleContainerHelpers</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_toggleContainerHelpers</strong>
|
|
(
|
|
|
|
|
|
bShow
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Syncs results container with its helpers.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">bShow</span>
|
|
<<span property="yui:type">Boolean</span>>
|
|
</code>
|
|
<span property="yui:description"> True if container is expanded, false if collapsed</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__toggleHighlight">
|
|
<h4>
|
|
<a name="method__toggleHighlight">_toggleHighlight</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_toggleHighlight</strong>
|
|
(
|
|
|
|
|
|
elNewListItem
|
|
|
|
|
|
,
|
|
sType
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui: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 rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elNewListItem</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The <li> element item to receive highlight behavior.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sType</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> Type "mouseover" will toggle highlight on, and "mouseout" will toggle highlight off.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__togglePrehighlight">
|
|
<h4>
|
|
<a name="method__togglePrehighlight">_togglePrehighlight</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_togglePrehighlight</strong>
|
|
(
|
|
|
|
|
|
elNewListItem
|
|
|
|
|
|
,
|
|
sType
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Toggles the pre-highlight on or off for an item in the container, and also cleans
|
|
up pre-highlighting of any previous item.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elNewListItem</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The <li> element item to receive highlight behavior.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sType</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> Type "mouseover" will toggle highlight on, and "mouseout" will toggle highlight off.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__typeAhead">
|
|
<h4>
|
|
<a name="method__typeAhead">_typeAhead</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_typeAhead</strong>
|
|
(
|
|
|
|
|
|
elListItem
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui: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 rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elListItem</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The <li> element item whose data populates the input field.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> Query string.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__updateValue">
|
|
<h4>
|
|
<a name="method__updateValue">_updateValue</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_updateValue</strong>
|
|
(
|
|
|
|
|
|
elListItem
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui: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 rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elListItem</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The <li> element item with which to update the value.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method_AutoComplete._cloneObject">
|
|
<h4>
|
|
<a name="method_AutoComplete._cloneObject">AutoComplete._cloneObject</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
static
|
|
|
|
void
|
|
<strong property="yui:name">AutoComplete._cloneObject</strong>
|
|
(
|
|
|
|
|
|
o
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Clones object literal or array of object literals.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">o</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> Object.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_clearList">
|
|
<h4>
|
|
<a name="method_clearList">clearList</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">clearList</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Clears entire list of suggestions.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_collapseContainer">
|
|
<h4>
|
|
<a name="method_collapseContainer">collapseContainer</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">collapseContainer</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Collapses container.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_destroy">
|
|
<h4>
|
|
<a name="method_destroy">destroy</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">destroy</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui: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 myAutoComplete = null. Use with caution!
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_doBeforeExpandContainer">
|
|
<h4>
|
|
<a name="method_doBeforeExpandContainer">doBeforeExpandContainer</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong property="yui:name">doBeforeExpandContainer</strong>
|
|
(
|
|
|
|
|
|
elTextbox
|
|
|
|
|
|
,
|
|
elContainer
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
,
|
|
aResults
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Overridable method called before container expands allows implementers to access data
|
|
and DOM elements.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elTextbox</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The text input box.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elContainer</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The container element.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The query string.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">aResults</span>
|
|
<<span property="yui:type">Object[]</span>>
|
|
</code>
|
|
<span property="yui:description"> An array of query results.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Return true to continue expanding container, false to cancel the expand.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_doBeforeLoadData">
|
|
<h4>
|
|
<a name="method_doBeforeLoadData">doBeforeLoadData</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong property="yui:name">doBeforeLoadData</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
,
|
|
oResponse
|
|
|
|
|
|
,
|
|
oPayload
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Overridable method called before container is loaded with result data.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> Original request.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oResponse</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> Response object.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oPayload</span>
|
|
<<span property="yui:type">MIXED</span>>
|
|
</code>
|
|
<span property="yui:description"> (optional) Additional argument(s)</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Return true to continue loading data, false to cancel.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class=" deprecated" rel="yui:method" resource="#method_doBeforeSendQuery">
|
|
<h4>
|
|
<a name="method_doBeforeSendQuery">doBeforeSendQuery</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">doBeforeSendQuery</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="deprecated">
|
|
<strong>Deprecated</strong> Use generateRequest.
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_enableIntervalDetection">
|
|
<h4>
|
|
<a name="method_enableIntervalDetection">enableIntervalDetection</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">enableIntervalDetection</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Enables interval detection for a less performant but brute force mechanism to
|
|
detect input values at an interval set by queryInterval and send queries if
|
|
input value has changed. Needed to support right-click+paste or shift+insert
|
|
edge cases. Please note that intervals are cleared at the end of each interaction,
|
|
so enableIntervalDetection must be called for each new interaction. The
|
|
recommended approach is to call it in response to textboxFocusEvent.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_expandContainer">
|
|
<h4>
|
|
<a name="method_expandContainer">expandContainer</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">expandContainer</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Expands container.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_filterResults">
|
|
<h4>
|
|
<a name="method_filterResults">filterResults</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
Object
|
|
<strong property="yui:name">filterResults</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
,
|
|
oFullResponse
|
|
|
|
|
|
,
|
|
oParsedResponse
|
|
|
|
|
|
,
|
|
oCallback
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Executed by DataSource (within DataSource scope via doBeforeCallback()) to
|
|
filter results through a simple client-side matching algorithm.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> Original request.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oFullResponse</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> Full response object.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oParsedResponse</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> Parsed response object.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oCallback</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> Callback object.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Object
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Filtered response object.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_formatResult">
|
|
<h4>
|
|
<a name="method_formatResult">formatResult</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
String
|
|
<strong property="yui:name">formatResult</strong>
|
|
(
|
|
|
|
|
|
oResultData
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
,
|
|
sResultMatch
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Overridable method that returns HTML markup for one result to be populated
|
|
as innerHTML of an <LI> element.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oResultData</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> Result data object.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The corresponding query string.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sResultMatch</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The current query string.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
String
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">HTML markup of formatted result data.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_generateRequest">
|
|
<h4>
|
|
<a name="method_generateRequest">generateRequest</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
MIXED
|
|
<strong property="yui:name">generateRequest</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui: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 rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> Query string</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
MIXED
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Request</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getContainerEl">
|
|
<h4>
|
|
<a name="method_getContainerEl">getContainerEl</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
HTMLELement
|
|
<strong property="yui:name">getContainerEl</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns DOM reference to container element.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
HTMLELement
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">DOM reference to container element.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getInputEl">
|
|
<h4>
|
|
<a name="method_getInputEl">getInputEl</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
HTMLELement
|
|
<strong property="yui:name">getInputEl</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns DOM reference to input element.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
HTMLELement
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">DOM reference to input element.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getListEl">
|
|
<h4>
|
|
<a name="method_getListEl">getListEl</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
HTMLElement[]
|
|
<strong property="yui:name">getListEl</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Public accessor to the <ul> element that displays query results within the results container.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
HTMLElement[]
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Reference to <ul> element within the results container.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getListItemData">
|
|
<h4>
|
|
<a name="method_getListItemData">getListItemData</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
Object
|
|
<strong property="yui:name">getListItemData</strong>
|
|
(
|
|
|
|
|
|
elListItem
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Public accessor to the result data associated with a given <li> result.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elListItem</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> Reference to <LI> element.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Object
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Result data.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getListItemIndex">
|
|
<h4>
|
|
<a name="method_getListItemIndex">getListItemIndex</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
Number
|
|
<strong property="yui:name">getListItemIndex</strong>
|
|
(
|
|
|
|
|
|
elListItem
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Public accessor to the index of the associated with a given <li> result.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elListItem</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> Reference to <LI> element.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Number
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Index.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getListItemMatch">
|
|
<h4>
|
|
<a name="method_getListItemMatch">getListItemMatch</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
String
|
|
<strong property="yui:name">getListItemMatch</strong>
|
|
(
|
|
|
|
|
|
elListItem
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Public accessor to the matching string associated with a given <li> result.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elListItem</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> Reference to <LI> element.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
String
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Matching string.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class=" deprecated" rel="yui:method" resource="#method_getListItems">
|
|
<h4>
|
|
<a name="method_getListItems">getListItems</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">getListItems</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="deprecated">
|
|
<strong>Deprecated</strong> Use getListEl().childNodes.
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getSubsetMatches">
|
|
<h4>
|
|
<a name="method_getSubsetMatches">getSubsetMatches</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
Object
|
|
<strong property="yui:name">getSubsetMatches</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Handles subset matching for when queryMatchSubset is enabled.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> Query string.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Object
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">oParsedResponse or null.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_handleResponse">
|
|
<h4>
|
|
<a name="method_handleResponse">handleResponse</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">handleResponse</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
,
|
|
oResponse
|
|
|
|
|
|
,
|
|
oPayload
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui: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 rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> Original request.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oResponse</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> Response object.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oPayload</span>
|
|
<<span property="yui:type">MIXED</span>>
|
|
</code>
|
|
<span property="yui:description"> (optional) Additional argument(s)</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_isContainerOpen">
|
|
<h4>
|
|
<a name="method_isContainerOpen">isContainerOpen</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong property="yui:name">isContainerOpen</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns true if container is in an expanded state, false otherwise.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Returns true if container is in an expanded state, false otherwise.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_isFocused">
|
|
<h4>
|
|
<a name="method_isFocused">isFocused</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong property="yui:name">isFocused</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns true if widget instance is currently active.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Returns true if widget instance is currently active.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_preparseRawResponse">
|
|
<h4>
|
|
<a name="method_preparseRawResponse">preparseRawResponse</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
Object
|
|
<strong property="yui:name">preparseRawResponse</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Executed by DataSource (within DataSource scope via doBeforeParseData()) to
|
|
handle responseStripAfter cleanup.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> Query string.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Object
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">oParsedResponse or null.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_sendQuery">
|
|
<h4>
|
|
<a name="method_sendQuery">sendQuery</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">sendQuery</strong>
|
|
(
|
|
|
|
|
|
sQuery
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Makes query request to the DataSource.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> Query string.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_setBody">
|
|
<h4>
|
|
<a name="method_setBody">setBody</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">setBody</strong>
|
|
(
|
|
|
|
|
|
sBody
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui: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 rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sBody</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> HTML markup for results container body.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_setFooter">
|
|
<h4>
|
|
<a name="method_setFooter">setFooter</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">setFooter</strong>
|
|
(
|
|
|
|
|
|
sFooter
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui: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 rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sFooter</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> HTML markup for results container footer.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_setHeader">
|
|
<h4>
|
|
<a name="method_setHeader">setHeader</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">setHeader</strong>
|
|
(
|
|
|
|
|
|
sHeader
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui: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 rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sHeader</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> HTML markup for results container header.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_snapContainer">
|
|
<h4>
|
|
<a name="method_snapContainer">snapContainer</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">snapContainer</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Snaps container to bottom-left corner of input element
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_toString">
|
|
<h4>
|
|
<a name="method_toString">toString</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
String
|
|
<strong property="yui:name">toString</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Public accessor to the unique name of the AutoComplete instance.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
String
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Unique name of the AutoComplete instance.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div rel="yui:events" resource="#events">
|
|
<div class="section method details">
|
|
<h3 id="events">Events</h3>
|
|
<div class="content">
|
|
<div class="private" rel="yui:event" resource="#event__sLastTextboxValue">
|
|
<h4>
|
|
<a name="event__sLastTextboxValue">_sLastTextboxValue</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
<strong property="yui:name">_sLastTextboxValue</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui: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="" rel="yui:event" resource="#event_containerCollapseEvent">
|
|
<h4>
|
|
<a name="event_containerCollapseEvent">containerCollapseEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">containerCollapseEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when the results container is collapsed.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_containerExpandEvent">
|
|
<h4>
|
|
<a name="event_containerExpandEvent">containerExpandEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">containerExpandEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when the results container is expanded.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_containerPopulateEvent">
|
|
<h4>
|
|
<a name="event_containerPopulateEvent">containerPopulateEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">containerPopulateEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when the results container is populated.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_dataErrorEvent">
|
|
<h4>
|
|
<a name="event_dataErrorEvent">dataErrorEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">dataErrorEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
,
|
|
oResponse
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when the AutoComplete instance does not receive query results from the
|
|
DataSource due to an error.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The query string.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oResponse</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> The response object, if available.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_dataRequestEvent">
|
|
<h4>
|
|
<a name="event_dataRequestEvent">dataRequestEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">dataRequestEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
,
|
|
oRequest
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when the AutoComplete instance makes a request to the DataSource.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The query string.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oRequest</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> The request.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_dataReturnEvent">
|
|
<h4>
|
|
<a name="event_dataReturnEvent">dataReturnEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">dataReturnEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
,
|
|
aResults
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when the AutoComplete instance receives query results from the data
|
|
source.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The query string.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">aResults</span>
|
|
<<span property="yui:type">Object[]</span>>
|
|
</code>
|
|
<span property="yui:description"> Results array.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_itemArrowFromEvent">
|
|
<h4>
|
|
<a name="event_itemArrowFromEvent">itemArrowFromEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">itemArrowFromEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
elItem
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when result item has been arrowed away from.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elItem</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The <li> element item arrowed from.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_itemArrowToEvent">
|
|
<h4>
|
|
<a name="event_itemArrowToEvent">itemArrowToEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">itemArrowToEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
elItem
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when result item has been arrowed to.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elItem</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The <li> element item arrowed to.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_itemMouseOutEvent">
|
|
<h4>
|
|
<a name="event_itemMouseOutEvent">itemMouseOutEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">itemMouseOutEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
elItem
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when result item has been moused out.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elItem</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The <li> element item moused from.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_itemMouseOverEvent">
|
|
<h4>
|
|
<a name="event_itemMouseOverEvent">itemMouseOverEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">itemMouseOverEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
elItem
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when result item has been moused over.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elItem</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The <li> element item moused to.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_itemSelectEvent">
|
|
<h4>
|
|
<a name="event_itemSelectEvent">itemSelectEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">itemSelectEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
elItem
|
|
|
|
|
|
,
|
|
oData
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when an item is selected via mouse click, ENTER key, or TAB key.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">elItem</span>
|
|
<<span property="yui:type">HTMLElement</span>>
|
|
</code>
|
|
<span property="yui:description"> The selected <li> element item.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oData</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> The data returned for the item, either as an object,
|
|
or mapped from the schema into an array.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_selectionEnforceEvent">
|
|
<h4>
|
|
<a name="event_selectionEnforceEvent">selectionEnforceEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">selectionEnforceEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
sClearedValue
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui: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 rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sClearedValue</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The cleared value (including delimiters if applicable).</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_textboxBlurEvent">
|
|
<h4>
|
|
<a name="event_textboxBlurEvent">textboxBlurEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">textboxBlurEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when the input field loses focus.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_textboxChangeEvent">
|
|
<h4>
|
|
<a name="event_textboxChangeEvent">textboxChangeEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">textboxChangeEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when the input field value has changed when it loses focus.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_textboxFocusEvent">
|
|
<h4>
|
|
<a name="event_textboxFocusEvent">textboxFocusEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">textboxFocusEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when the input field receives focus.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_textboxKeyEvent">
|
|
<h4>
|
|
<a name="event_textboxKeyEvent">textboxKeyEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">textboxKeyEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
nKeycode
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when the input field receives key input.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">nKeycode</span>
|
|
<<span property="yui:type">Number</span>>
|
|
</code>
|
|
<span property="yui:description"> The keycode number.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_typeAheadEvent">
|
|
<h4>
|
|
<a name="event_typeAheadEvent">typeAheadEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">typeAheadEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
sQuery
|
|
|
|
|
|
,
|
|
sPrefill
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when the input field has been prefilled by the type-ahead
|
|
feature.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sQuery</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The query string.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sPrefill</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The prefill string.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:event" resource="#event_unmatchedItemSelectEvent">
|
|
<h4>
|
|
<a name="event_unmatchedItemSelectEvent">unmatchedItemSelectEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">unmatchedItemSelectEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oSelf
|
|
|
|
|
|
,
|
|
sSelection
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when a user selection does not match any of the displayed result items.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">oSelf</span>
|
|
<<span property="yui:type">YAHOO.widget.AutoComplete</span>>
|
|
</code>
|
|
<span property="yui:description"> The AutoComplete instance.</span>
|
|
</dd>
|
|
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">sSelection</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The selected string.</span>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div rel="yui:attributes" resource="#configattributes">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="yui-b">
|
|
<div class="nav">
|
|
|
|
<div id="moduleList" class="module">
|
|
<h4>Modules</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="module_animation.html" title="animation">animation</a></li>
|
|
<li class="selected"><a href="module_autocomplete.html" title="autocomplete">autocomplete</a></li>
|
|
<li class=""><a href="module_button.html" title="button">button</a></li>
|
|
<li class=""><a href="module_calendar.html" title="calendar">calendar</a></li>
|
|
<li class=""><a href="module_carousel.html" title="carousel">carousel</a></li>
|
|
<li class=""><a href="module_charts.html" title="charts">charts</a></li>
|
|
<li class=""><a href="module_colorpicker.html" title="colorpicker">colorpicker</a></li>
|
|
<li class=""><a href="module_connection.html" title="connection">connection</a></li>
|
|
<li class=""><a href="module_container.html" title="container">container</a></li>
|
|
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
|
|
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
|
|
<li class=""><a href="module_datatable.html" title="datatable">datatable</a></li>
|
|
<li class=""><a href="module_datemath.html" title="datemath">datemath</a></li>
|
|
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
|
|
<li class=""><a href="module_dragdrop.html" title="dragdrop">dragdrop</a></li>
|
|
<li class=""><a href="module_editor.html" title="editor">editor</a></li>
|
|
<li class=""><a href="module_element.html" title="element">element</a></li>
|
|
<li class=""><a href="module_element-delegate.html" title="element-delegate">element-delegate</a></li>
|
|
<li class=""><a href="module_event.html" title="event">event</a></li>
|
|
<li class=""><a href="module_event-delegate.html" title="event-delegate">event-delegate</a></li>
|
|
<li class=""><a href="module_event-mouseenter.html" title="event-mouseenter">event-mouseenter</a></li>
|
|
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
|
|
<li class=""><a href="module_get.html" title="get">get</a></li>
|
|
<li class=""><a href="module_history.html" title="history">history</a></li>
|
|
<li class=""><a href="module_imagecropper.html" title="imagecropper">imagecropper</a></li>
|
|
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
|
|
<li class=""><a href="module_json.html" title="json">json</a></li>
|
|
<li class=""><a href="module_layout.html" title="layout">layout</a></li>
|
|
<li class=""><a href="module_logger.html" title="logger">logger</a></li>
|
|
<li class=""><a href="module_menu.html" title="menu">menu</a></li>
|
|
<li class=""><a href="module_paginator.html" title="paginator">paginator</a></li>
|
|
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
|
|
<li class=""><a href="module_profilerviewer.html" title="profilerviewer">profilerviewer</a></li>
|
|
<li class=""><a href="module_progressbar.html" title="progressbar">progressbar</a></li>
|
|
<li class=""><a href="module_resize.html" title="resize">resize</a></li>
|
|
<li class=""><a href="module_selector.html" title="selector">selector</a></li>
|
|
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
|
|
<li class=""><a href="module_storage.html" title="Storage">Storage</a></li>
|
|
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
|
|
<li class=""><a href="module_swf.html" title="swf">swf</a></li>
|
|
<li class=""><a href="module_swfdetect.html" title="swfdetect">swfdetect</a></li>
|
|
<li class=""><a href="module_swfstore.html" title="swfstore">swfstore</a></li>
|
|
<li class=""><a href="module_tabview.html" title="tabview">tabview</a></li>
|
|
<li class=""><a href="module_treeview.html" title="treeview">treeview</a></li>
|
|
<li class=""><a href="module_uploader.html" title="uploader">uploader</a></li>
|
|
<li class=""><a href="module_yahoo.html" title="yahoo">yahoo</a></li>
|
|
<li class=""><a href="module_yuiloader.html" title="yuiloader">yuiloader</a></li>
|
|
<li class=""><a href="module_yuitest.html" title="yuitest">yuitest</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="classList" class="module">
|
|
<h4>Classes</h4>
|
|
<ul class="content">
|
|
<li class="selected"><a href="YAHOO.widget.AutoComplete.html" title="YAHOO.widget.AutoComplete">YAHOO.widget.AutoComplete</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="fileList" class="module">
|
|
<h4>Files</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="AutoComplete.js.html" title="AutoComplete.js">AutoComplete.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="propertyList" class="module">
|
|
<h4>Properties</h4>
|
|
<ul class="content">
|
|
<li class="private"><a href="#property__bContainerOpen" title="_bContainerOpen">_bContainerOpen</a></li>
|
|
<li class="private"><a href="#property__bFocused" title="_bFocused">_bFocused</a></li>
|
|
<li class="private"><a href="#property__bItemSelected" title="_bItemSelected">_bItemSelected</a></li>
|
|
<li class="private"><a href="#property__bOverContainer" title="_bOverContainer">_bOverContainer</a></li>
|
|
<li class="private"><a href="#property__elBody" title="_elBody">_elBody</a></li>
|
|
<li class="private"><a href="#property__elContainer" title="_elContainer">_elContainer</a></li>
|
|
<li class="private"><a href="#property__elContent" title="_elContent">_elContent</a></li>
|
|
<li class="private"><a href="#property__elCurListItem" title="_elCurListItem">_elCurListItem</a></li>
|
|
<li class="private"><a href="#property__elCurPrehighlightItem" title="_elCurPrehighlightItem">_elCurPrehighlightItem</a></li>
|
|
<li class="private"><a href="#property__elFooter" title="_elFooter">_elFooter</a></li>
|
|
<li class="private"><a href="#property__elHeader" title="_elHeader">_elHeader</a></li>
|
|
<li class="private"><a href="#property__elIFrame" title="_elIFrame">_elIFrame</a></li>
|
|
<li class="private"><a href="#property__elList" title="_elList">_elList</a></li>
|
|
<li class="private"><a href="#property__elShadow" title="_elShadow">_elShadow</a></li>
|
|
<li class="private"><a href="#property__elTextbox" title="_elTextbox">_elTextbox</a></li>
|
|
<li class="private"><a href="#property__iFrameSrc" title="_iFrameSrc">_iFrameSrc</a></li>
|
|
<li class="private"><a href="#property__nDelayID" title="_nDelayID">_nDelayID</a></li>
|
|
<li class="private"><a href="#property__nDisplayedItems" title="_nDisplayedItems">_nDisplayedItems</a></li>
|
|
<li class="private"><a href="#property__nIndex" title="_nIndex">_nIndex</a></li>
|
|
<li class="private"><a href="#property__nKeyCode" title="_nKeyCode">_nKeyCode</a></li>
|
|
<li class="private"><a href="#property__nTypeAheadDelayID" title="_nTypeAheadDelayID">_nTypeAheadDelayID</a></li>
|
|
<li class="private"><a href="#property__oAnim" title="_oAnim">_oAnim</a></li>
|
|
<li class="private"><a href="#property__queryInterval" title="_queryInterval">_queryInterval</a></li>
|
|
<li class="private"><a href="#property__sCurQuery" title="_sCurQuery">_sCurQuery</a></li>
|
|
<li class="private"><a href="#property__sInitInputValue" title="_sInitInputValue">_sInitInputValue</a></li>
|
|
<li class="private"><a href="#property__sName" title="_sName">_sName</a></li>
|
|
<li class="private"><a href="#property__sPastSelections" title="_sPastSelections">_sPastSelections</a></li>
|
|
<li class=""><a href="#property_allowBrowserAutocomplete" title="allowBrowserAutocomplete">allowBrowserAutocomplete</a></li>
|
|
<li class=""><a href="#property_alwaysShowContainer" title="alwaysShowContainer">alwaysShowContainer</a></li>
|
|
<li class=""><a href="#property_animHoriz" title="animHoriz">animHoriz</a></li>
|
|
<li class=""><a href="#property_animSpeed" title="animSpeed">animSpeed</a></li>
|
|
<li class=""><a href="#property_animVert" title="animVert">animVert</a></li>
|
|
<li class=""><a href="#property_applyLocalFilter" title="applyLocalFilter">applyLocalFilter</a></li>
|
|
<li class=""><a href="#property_autoHighlight" title="autoHighlight">autoHighlight</a></li>
|
|
<li class=""><a href="#property_autoSnapContainer" title="autoSnapContainer">autoSnapContainer</a></li>
|
|
<li class=""><a href="#property_dataSource" title="dataSource">dataSource</a></li>
|
|
<li class=""><a href="#property_delimChar" title="delimChar">delimChar</a></li>
|
|
<li class=""><a href="#property_forceSelection" title="forceSelection">forceSelection</a></li>
|
|
<li class=""><a href="#property_highlightClassName" title="highlightClassName">highlightClassName</a></li>
|
|
<li class=""><a href="#property_maxResultsDisplayed" title="maxResultsDisplayed">maxResultsDisplayed</a></li>
|
|
<li class=""><a href="#property_minQueryLength" title="minQueryLength">minQueryLength</a></li>
|
|
<li class=""><a href="#property_prehighlightClassName" title="prehighlightClassName">prehighlightClassName</a></li>
|
|
<li class=""><a href="#property_queryDelay" title="queryDelay">queryDelay</a></li>
|
|
<li class=""><a href="#property_queryInterval" title="queryInterval">queryInterval</a></li>
|
|
<li class=""><a href="#property_queryMatchCase" title="queryMatchCase">queryMatchCase</a></li>
|
|
<li class=""><a href="#property_queryMatchContains" title="queryMatchContains">queryMatchContains</a></li>
|
|
<li class=""><a href="#property_queryMatchSubset" title="queryMatchSubset">queryMatchSubset</a></li>
|
|
<li class=""><a href="#property_queryQuestionMark" title="queryQuestionMark">queryQuestionMark</a></li>
|
|
<li class=""><a href="#property_resultTypeList" title="resultTypeList">resultTypeList</a></li>
|
|
<li class=""><a href="#property_suppressInputUpdate" title="suppressInputUpdate">suppressInputUpdate</a></li>
|
|
<li class=""><a href="#property_typeAhead" title="typeAhead">typeAhead</a></li>
|
|
<li class=""><a href="#property_typeAheadDelay" title="typeAheadDelay">typeAheadDelay</a></li>
|
|
<li class=""><a href="#property_useIFrame" title="useIFrame">useIFrame</a></li>
|
|
<li class=""><a href="#property_useShadow" title="useShadow">useShadow</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="methodsList" class="module">
|
|
<h4>Methods</h4>
|
|
<ul class="content">
|
|
<li class="private"><a href="#method___initProps" title="__initProps">__initProps</a></li>
|
|
<li class="private"><a href="#method__clearInterval" title="_clearInterval">_clearInterval</a></li>
|
|
<li class="private"><a href="#method__clearSelection" title="_clearSelection">_clearSelection</a></li>
|
|
<li class="private"><a href="#method__doBeforeExpandContainer" title="_doBeforeExpandContainer">_doBeforeExpandContainer</a></li>
|
|
<li class="private"><a href="#method__enableIntervalDetection" title="_enableIntervalDetection">_enableIntervalDetection</a></li>
|
|
<li class="private"><a href="#method__extractQuery" title="_extractQuery">_extractQuery</a></li>
|
|
<li class="private"><a href="#method__focus" title="_focus">_focus</a></li>
|
|
<li class="private"><a href="#method__initContainerEl" title="_initContainerEl">_initContainerEl</a></li>
|
|
<li class="private"><a href="#method__initContainerHelperEls" title="_initContainerHelperEls">_initContainerHelperEls</a></li>
|
|
<li class="private"><a href="#method__initListEl" title="_initListEl">_initListEl</a></li>
|
|
<li class="private"><a href="#method__isIgnoreKey" title="_isIgnoreKey">_isIgnoreKey</a></li>
|
|
<li class="private"><a href="#method__jumpSelection" title="_jumpSelection">_jumpSelection</a></li>
|
|
<li class="private"><a href="#method__moveSelection" title="_moveSelection">_moveSelection</a></li>
|
|
<li class="private"><a href="#method__onContainerClick" title="_onContainerClick">_onContainerClick</a></li>
|
|
<li class="private"><a href="#method__onContainerMouseout" title="_onContainerMouseout">_onContainerMouseout</a></li>
|
|
<li class="private"><a href="#method__onContainerMouseover" title="_onContainerMouseover">_onContainerMouseover</a></li>
|
|
<li class="private"><a href="#method__onContainerResize" title="_onContainerResize">_onContainerResize</a></li>
|
|
<li class="private"><a href="#method__onContainerScroll" title="_onContainerScroll">_onContainerScroll</a></li>
|
|
<li class="private"><a href="#method__onInterval" title="_onInterval">_onInterval</a></li>
|
|
<li class="private"><a href="#method__onTextboxBlur" title="_onTextboxBlur">_onTextboxBlur</a></li>
|
|
<li class="private"><a href="#method__onTextboxFocus" title="_onTextboxFocus">_onTextboxFocus</a></li>
|
|
<li class="private"><a href="#method__onTextboxKeyDown" title="_onTextboxKeyDown">_onTextboxKeyDown</a></li>
|
|
<li class="private"><a href="#method__onTextboxKeyPress" title="_onTextboxKeyPress">_onTextboxKeyPress</a></li>
|
|
<li class="private"><a href="#method__onTextboxKeyUp" title="_onTextboxKeyUp">_onTextboxKeyUp</a></li>
|
|
<li class="private"><a href="#method__onWindowUnload" title="_onWindowUnload">_onWindowUnload</a></li>
|
|
<li class="private"><a href="#method__populateList" title="_populateList">_populateList</a></li>
|
|
<li class="private"><a href="#method__populateListItem" title="_populateListItem">_populateListItem</a></li>
|
|
<li class="private"><a href="#method__selectItem" title="_selectItem">_selectItem</a></li>
|
|
<li class="private"><a href="#method__selectText" title="_selectText">_selectText</a></li>
|
|
<li class="private"><a href="#method__sendQuery" title="_sendQuery">_sendQuery</a></li>
|
|
<li class="private"><a href="#method__textMatchesOption" title="_textMatchesOption">_textMatchesOption</a></li>
|
|
<li class="private"><a href="#method__toggleContainer" title="_toggleContainer">_toggleContainer</a></li>
|
|
<li class="private"><a href="#method__toggleContainerHelpers" title="_toggleContainerHelpers">_toggleContainerHelpers</a></li>
|
|
<li class="private"><a href="#method__toggleHighlight" title="_toggleHighlight">_toggleHighlight</a></li>
|
|
<li class="private"><a href="#method__togglePrehighlight" title="_togglePrehighlight">_togglePrehighlight</a></li>
|
|
<li class="private"><a href="#method__typeAhead" title="_typeAhead">_typeAhead</a></li>
|
|
<li class="private"><a href="#method__updateValue" title="_updateValue">_updateValue</a></li>
|
|
<li class="private"><a href="#method_AutoComplete._cloneObject" title="AutoComplete._cloneObject">AutoComplete._cloneObject</a></li>
|
|
<li class=""><a href="#method_clearList" title="clearList">clearList</a></li>
|
|
<li class=""><a href="#method_collapseContainer" title="collapseContainer">collapseContainer</a></li>
|
|
<li class=""><a href="#method_destroy" title="destroy">destroy</a></li>
|
|
<li class=""><a href="#method_doBeforeExpandContainer" title="doBeforeExpandContainer">doBeforeExpandContainer</a></li>
|
|
<li class=""><a href="#method_doBeforeLoadData" title="doBeforeLoadData">doBeforeLoadData</a></li>
|
|
<li class=" deprecated"><a href="#method_doBeforeSendQuery" title="doBeforeSendQuery">doBeforeSendQuery</a></li>
|
|
<li class=""><a href="#method_enableIntervalDetection" title="enableIntervalDetection">enableIntervalDetection</a></li>
|
|
<li class=""><a href="#method_expandContainer" title="expandContainer">expandContainer</a></li>
|
|
<li class=""><a href="#method_filterResults" title="filterResults">filterResults</a></li>
|
|
<li class=""><a href="#method_formatResult" title="formatResult">formatResult</a></li>
|
|
<li class=""><a href="#method_generateRequest" title="generateRequest">generateRequest</a></li>
|
|
<li class=""><a href="#method_getContainerEl" title="getContainerEl">getContainerEl</a></li>
|
|
<li class=""><a href="#method_getInputEl" title="getInputEl">getInputEl</a></li>
|
|
<li class=""><a href="#method_getListEl" title="getListEl">getListEl</a></li>
|
|
<li class=""><a href="#method_getListItemData" title="getListItemData">getListItemData</a></li>
|
|
<li class=""><a href="#method_getListItemIndex" title="getListItemIndex">getListItemIndex</a></li>
|
|
<li class=""><a href="#method_getListItemMatch" title="getListItemMatch">getListItemMatch</a></li>
|
|
<li class=" deprecated"><a href="#method_getListItems" title="getListItems">getListItems</a></li>
|
|
<li class=""><a href="#method_getSubsetMatches" title="getSubsetMatches">getSubsetMatches</a></li>
|
|
<li class=""><a href="#method_handleResponse" title="handleResponse">handleResponse</a></li>
|
|
<li class=""><a href="#method_isContainerOpen" title="isContainerOpen">isContainerOpen</a></li>
|
|
<li class=""><a href="#method_isFocused" title="isFocused">isFocused</a></li>
|
|
<li class=""><a href="#method_preparseRawResponse" title="preparseRawResponse">preparseRawResponse</a></li>
|
|
<li class=""><a href="#method_sendQuery" title="sendQuery">sendQuery</a></li>
|
|
<li class=""><a href="#method_setBody" title="setBody">setBody</a></li>
|
|
<li class=""><a href="#method_setFooter" title="setFooter">setFooter</a></li>
|
|
<li class=""><a href="#method_setHeader" title="setHeader">setHeader</a></li>
|
|
<li class=""><a href="#method_snapContainer" title="snapContainer">snapContainer</a></li>
|
|
<li class=""><a href="#method_toString" title="toString">toString</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="eventsList" class="module">
|
|
<h4>Events</h4>
|
|
<ul class="content">
|
|
<li class="private"><a href="#event__sLastTextboxValue" title="_sLastTextboxValue">_sLastTextboxValue</a></li>
|
|
<li class=""><a href="#event_containerCollapseEvent" title="containerCollapseEvent">containerCollapseEvent</a></li>
|
|
<li class=""><a href="#event_containerExpandEvent" title="containerExpandEvent">containerExpandEvent</a></li>
|
|
<li class=""><a href="#event_containerPopulateEvent" title="containerPopulateEvent">containerPopulateEvent</a></li>
|
|
<li class=""><a href="#event_dataErrorEvent" title="dataErrorEvent">dataErrorEvent</a></li>
|
|
<li class=""><a href="#event_dataRequestEvent" title="dataRequestEvent">dataRequestEvent</a></li>
|
|
<li class=""><a href="#event_dataReturnEvent" title="dataReturnEvent">dataReturnEvent</a></li>
|
|
<li class=""><a href="#event_itemArrowFromEvent" title="itemArrowFromEvent">itemArrowFromEvent</a></li>
|
|
<li class=""><a href="#event_itemArrowToEvent" title="itemArrowToEvent">itemArrowToEvent</a></li>
|
|
<li class=""><a href="#event_itemMouseOutEvent" title="itemMouseOutEvent">itemMouseOutEvent</a></li>
|
|
<li class=""><a href="#event_itemMouseOverEvent" title="itemMouseOverEvent">itemMouseOverEvent</a></li>
|
|
<li class=""><a href="#event_itemSelectEvent" title="itemSelectEvent">itemSelectEvent</a></li>
|
|
<li class=""><a href="#event_selectionEnforceEvent" title="selectionEnforceEvent">selectionEnforceEvent</a></li>
|
|
<li class=""><a href="#event_textboxBlurEvent" title="textboxBlurEvent">textboxBlurEvent</a></li>
|
|
<li class=""><a href="#event_textboxChangeEvent" title="textboxChangeEvent">textboxChangeEvent</a></li>
|
|
<li class=""><a href="#event_textboxFocusEvent" title="textboxFocusEvent">textboxFocusEvent</a></li>
|
|
<li class=""><a href="#event_textboxKeyEvent" title="textboxKeyEvent">textboxKeyEvent</a></li>
|
|
<li class=""><a href="#event_typeAheadEvent" title="typeAheadEvent">typeAheadEvent</a></li>
|
|
<li class=""><a href="#event_unmatchedItemSelectEvent" title="unmatchedItemSelectEvent">unmatchedItemSelectEvent</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2010 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
|
|
var ALL_YUI_PROPS = [{"access": "", "host": "YAHOO.widget.AutoComplete", "name": "allowBrowserAutocomplete", "url": "YAHOO.widget.AutoComplete.html#property_allowBrowserAutocomplete", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "alwaysShowContainer", "url": "YAHOO.widget.AutoComplete.html#property_alwaysShowContainer", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "animHoriz", "url": "YAHOO.widget.AutoComplete.html#property_animHoriz", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "animSpeed", "url": "YAHOO.widget.AutoComplete.html#property_animSpeed", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "animVert", "url": "YAHOO.widget.AutoComplete.html#property_animVert", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "applyLocalFilter", "url": "YAHOO.widget.AutoComplete.html#property_applyLocalFilter", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "AutoComplete._cloneObject", "url": "YAHOO.widget.AutoComplete.html#method_AutoComplete._cloneObject", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "autoHighlight", "url": "YAHOO.widget.AutoComplete.html#property_autoHighlight", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "autoSnapContainer", "url": "YAHOO.widget.AutoComplete.html#property_autoSnapContainer", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_bContainerOpen", "url": "YAHOO.widget.AutoComplete.html#property__bContainerOpen", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_bFocused", "url": "YAHOO.widget.AutoComplete.html#property__bFocused", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_bItemSelected", "url": "YAHOO.widget.AutoComplete.html#property__bItemSelected", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_bOverContainer", "url": "YAHOO.widget.AutoComplete.html#property__bOverContainer", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_clearInterval", "url": "YAHOO.widget.AutoComplete.html#method__clearInterval", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "clearList", "url": "YAHOO.widget.AutoComplete.html#method_clearList", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_clearSelection", "url": "YAHOO.widget.AutoComplete.html#method__clearSelection", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "collapseContainer", "url": "YAHOO.widget.AutoComplete.html#method_collapseContainer", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "containerCollapseEvent", "url": "YAHOO.widget.AutoComplete.html#event_containerCollapseEvent", "type": "event"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "containerExpandEvent", "url": "YAHOO.widget.AutoComplete.html#event_containerExpandEvent", "type": "event"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "containerPopulateEvent", "url": "YAHOO.widget.AutoComplete.html#event_containerPopulateEvent", "type": "event"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "dataErrorEvent", "url": "YAHOO.widget.AutoComplete.html#event_dataErrorEvent", "type": "event"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "dataRequestEvent", "url": "YAHOO.widget.AutoComplete.html#event_dataRequestEvent", "type": "event"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "dataReturnEvent", "url": "YAHOO.widget.AutoComplete.html#event_dataReturnEvent", "type": "event"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "dataSource", "url": "YAHOO.widget.AutoComplete.html#property_dataSource", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "delimChar", "url": "YAHOO.widget.AutoComplete.html#property_delimChar", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "destroy", "url": "YAHOO.widget.AutoComplete.html#method_destroy", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_doBeforeExpandContainer", "url": "YAHOO.widget.AutoComplete.html#method__doBeforeExpandContainer", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "doBeforeExpandContainer", "url": "YAHOO.widget.AutoComplete.html#method_doBeforeExpandContainer", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "doBeforeLoadData", "url": "YAHOO.widget.AutoComplete.html#method_doBeforeLoadData", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "doBeforeSendQuery", "url": "YAHOO.widget.AutoComplete.html#method_doBeforeSendQuery", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_elBody", "url": "YAHOO.widget.AutoComplete.html#property__elBody", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_elContainer", "url": "YAHOO.widget.AutoComplete.html#property__elContainer", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_elContent", "url": "YAHOO.widget.AutoComplete.html#property__elContent", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_elCurListItem", "url": "YAHOO.widget.AutoComplete.html#property__elCurListItem", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_elCurPrehighlightItem", "url": "YAHOO.widget.AutoComplete.html#property__elCurPrehighlightItem", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_elFooter", "url": "YAHOO.widget.AutoComplete.html#property__elFooter", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_elHeader", "url": "YAHOO.widget.AutoComplete.html#property__elHeader", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_elIFrame", "url": "YAHOO.widget.AutoComplete.html#property__elIFrame", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_elList", "url": "YAHOO.widget.AutoComplete.html#property__elList", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_elShadow", "url": "YAHOO.widget.AutoComplete.html#property__elShadow", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_elTextbox", "url": "YAHOO.widget.AutoComplete.html#property__elTextbox", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_enableIntervalDetection", "url": "YAHOO.widget.AutoComplete.html#method__enableIntervalDetection", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "enableIntervalDetection", "url": "YAHOO.widget.AutoComplete.html#method_enableIntervalDetection", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "expandContainer", "url": "YAHOO.widget.AutoComplete.html#method_expandContainer", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_extractQuery", "url": "YAHOO.widget.AutoComplete.html#method__extractQuery", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "filterResults", "url": "YAHOO.widget.AutoComplete.html#method_filterResults", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_focus", "url": "YAHOO.widget.AutoComplete.html#method__focus", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "forceSelection", "url": "YAHOO.widget.AutoComplete.html#property_forceSelection", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "formatResult", "url": "YAHOO.widget.AutoComplete.html#method_formatResult", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "generateRequest", "url": "YAHOO.widget.AutoComplete.html#method_generateRequest", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "getContainerEl", "url": "YAHOO.widget.AutoComplete.html#method_getContainerEl", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "getInputEl", "url": "YAHOO.widget.AutoComplete.html#method_getInputEl", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "getListEl", "url": "YAHOO.widget.AutoComplete.html#method_getListEl", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "getListItemData", "url": "YAHOO.widget.AutoComplete.html#method_getListItemData", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "getListItemIndex", "url": "YAHOO.widget.AutoComplete.html#method_getListItemIndex", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "getListItemMatch", "url": "YAHOO.widget.AutoComplete.html#method_getListItemMatch", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "getListItems", "url": "YAHOO.widget.AutoComplete.html#method_getListItems", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "getSubsetMatches", "url": "YAHOO.widget.AutoComplete.html#method_getSubsetMatches", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "handleResponse", "url": "YAHOO.widget.AutoComplete.html#method_handleResponse", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "highlightClassName", "url": "YAHOO.widget.AutoComplete.html#property_highlightClassName", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_iFrameSrc", "url": "YAHOO.widget.AutoComplete.html#property__iFrameSrc", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_initContainerEl", "url": "YAHOO.widget.AutoComplete.html#method__initContainerEl", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_initContainerHelperEls", "url": "YAHOO.widget.AutoComplete.html#method__initContainerHelperEls", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_initListEl", "url": "YAHOO.widget.AutoComplete.html#method__initListEl", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "__initProps", "url": "YAHOO.widget.AutoComplete.html#method___initProps", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "isContainerOpen", "url": "YAHOO.widget.AutoComplete.html#method_isContainerOpen", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "isFocused", "url": "YAHOO.widget.AutoComplete.html#method_isFocused", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_isIgnoreKey", "url": "YAHOO.widget.AutoComplete.html#method__isIgnoreKey", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "itemArrowFromEvent", "url": "YAHOO.widget.AutoComplete.html#event_itemArrowFromEvent", "type": "event"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "itemArrowToEvent", "url": "YAHOO.widget.AutoComplete.html#event_itemArrowToEvent", "type": "event"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "itemMouseOutEvent", "url": "YAHOO.widget.AutoComplete.html#event_itemMouseOutEvent", "type": "event"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "itemMouseOverEvent", "url": "YAHOO.widget.AutoComplete.html#event_itemMouseOverEvent", "type": "event"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "itemSelectEvent", "url": "YAHOO.widget.AutoComplete.html#event_itemSelectEvent", "type": "event"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_jumpSelection", "url": "YAHOO.widget.AutoComplete.html#method__jumpSelection", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "maxResultsDisplayed", "url": "YAHOO.widget.AutoComplete.html#property_maxResultsDisplayed", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "minQueryLength", "url": "YAHOO.widget.AutoComplete.html#property_minQueryLength", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_moveSelection", "url": "YAHOO.widget.AutoComplete.html#method__moveSelection", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_nDelayID", "url": "YAHOO.widget.AutoComplete.html#property__nDelayID", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_nDisplayedItems", "url": "YAHOO.widget.AutoComplete.html#property__nDisplayedItems", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_nIndex", "url": "YAHOO.widget.AutoComplete.html#property__nIndex", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_nKeyCode", "url": "YAHOO.widget.AutoComplete.html#property__nKeyCode", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_nTypeAheadDelayID", "url": "YAHOO.widget.AutoComplete.html#property__nTypeAheadDelayID", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_oAnim", "url": "YAHOO.widget.AutoComplete.html#property__oAnim", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_onContainerClick", "url": "YAHOO.widget.AutoComplete.html#method__onContainerClick", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_onContainerMouseout", "url": "YAHOO.widget.AutoComplete.html#method__onContainerMouseout", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_onContainerMouseover", "url": "YAHOO.widget.AutoComplete.html#method__onContainerMouseover", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_onContainerResize", "url": "YAHOO.widget.AutoComplete.html#method__onContainerResize", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_onContainerScroll", "url": "YAHOO.widget.AutoComplete.html#method__onContainerScroll", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_onInterval", "url": "YAHOO.widget.AutoComplete.html#method__onInterval", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_onTextboxBlur", "url": "YAHOO.widget.AutoComplete.html#method__onTextboxBlur", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_onTextboxFocus", "url": "YAHOO.widget.AutoComplete.html#method__onTextboxFocus", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_onTextboxKeyDown", "url": "YAHOO.widget.AutoComplete.html#method__onTextboxKeyDown", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_onTextboxKeyPress", "url": "YAHOO.widget.AutoComplete.html#method__onTextboxKeyPress", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_onTextboxKeyUp", "url": "YAHOO.widget.AutoComplete.html#method__onTextboxKeyUp", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_onWindowUnload", "url": "YAHOO.widget.AutoComplete.html#method__onWindowUnload", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_populateList", "url": "YAHOO.widget.AutoComplete.html#method__populateList", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_populateListItem", "url": "YAHOO.widget.AutoComplete.html#method__populateListItem", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "prehighlightClassName", "url": "YAHOO.widget.AutoComplete.html#property_prehighlightClassName", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "preparseRawResponse", "url": "YAHOO.widget.AutoComplete.html#method_preparseRawResponse", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "queryDelay", "url": "YAHOO.widget.AutoComplete.html#property_queryDelay", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_queryInterval", "url": "YAHOO.widget.AutoComplete.html#property__queryInterval", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "queryInterval", "url": "YAHOO.widget.AutoComplete.html#property_queryInterval", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "queryMatchCase", "url": "YAHOO.widget.AutoComplete.html#property_queryMatchCase", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "queryMatchContains", "url": "YAHOO.widget.AutoComplete.html#property_queryMatchContains", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "queryMatchSubset", "url": "YAHOO.widget.AutoComplete.html#property_queryMatchSubset", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "queryQuestionMark", "url": "YAHOO.widget.AutoComplete.html#property_queryQuestionMark", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "resultTypeList", "url": "YAHOO.widget.AutoComplete.html#property_resultTypeList", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_sCurQuery", "url": "YAHOO.widget.AutoComplete.html#property__sCurQuery", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "selectionEnforceEvent", "url": "YAHOO.widget.AutoComplete.html#event_selectionEnforceEvent", "type": "event"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_selectItem", "url": "YAHOO.widget.AutoComplete.html#method__selectItem", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_selectText", "url": "YAHOO.widget.AutoComplete.html#method__selectText", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_sendQuery", "url": "YAHOO.widget.AutoComplete.html#method__sendQuery", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "sendQuery", "url": "YAHOO.widget.AutoComplete.html#method_sendQuery", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "setBody", "url": "YAHOO.widget.AutoComplete.html#method_setBody", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "setFooter", "url": "YAHOO.widget.AutoComplete.html#method_setFooter", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "setHeader", "url": "YAHOO.widget.AutoComplete.html#method_setHeader", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_sInitInputValue", "url": "YAHOO.widget.AutoComplete.html#property__sInitInputValue", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_sLastTextboxValue", "url": "YAHOO.widget.AutoComplete.html#event__sLastTextboxValue", "type": "event"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_sName", "url": "YAHOO.widget.AutoComplete.html#property__sName", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "snapContainer", "url": "YAHOO.widget.AutoComplete.html#method_snapContainer", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_sPastSelections", "url": "YAHOO.widget.AutoComplete.html#property__sPastSelections", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "suppressInputUpdate", "url": "YAHOO.widget.AutoComplete.html#property_suppressInputUpdate", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "textboxBlurEvent", "url": "YAHOO.widget.AutoComplete.html#event_textboxBlurEvent", "type": "event"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "textboxChangeEvent", "url": "YAHOO.widget.AutoComplete.html#event_textboxChangeEvent", "type": "event"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "textboxFocusEvent", "url": "YAHOO.widget.AutoComplete.html#event_textboxFocusEvent", "type": "event"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "textboxKeyEvent", "url": "YAHOO.widget.AutoComplete.html#event_textboxKeyEvent", "type": "event"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_textMatchesOption", "url": "YAHOO.widget.AutoComplete.html#method__textMatchesOption", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_toggleContainer", "url": "YAHOO.widget.AutoComplete.html#method__toggleContainer", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_toggleContainerHelpers", "url": "YAHOO.widget.AutoComplete.html#method__toggleContainerHelpers", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_toggleHighlight", "url": "YAHOO.widget.AutoComplete.html#method__toggleHighlight", "type": "method"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_togglePrehighlight", "url": "YAHOO.widget.AutoComplete.html#method__togglePrehighlight", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "toString", "url": "YAHOO.widget.AutoComplete.html#method_toString", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "typeAhead", "url": "YAHOO.widget.AutoComplete.html#property_typeAhead", "type": "property"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_typeAhead", "url": "YAHOO.widget.AutoComplete.html#method__typeAhead", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "typeAheadDelay", "url": "YAHOO.widget.AutoComplete.html#property_typeAheadDelay", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "typeAheadEvent", "url": "YAHOO.widget.AutoComplete.html#event_typeAheadEvent", "type": "event"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "unmatchedItemSelectEvent", "url": "YAHOO.widget.AutoComplete.html#event_unmatchedItemSelectEvent", "type": "event"}, {"access": "private", "host": "YAHOO.widget.AutoComplete", "name": "_updateValue", "url": "YAHOO.widget.AutoComplete.html#method__updateValue", "type": "method"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "useIFrame", "url": "YAHOO.widget.AutoComplete.html#property_useIFrame", "type": "property"}, {"access": "", "host": "YAHOO.widget.AutoComplete", "name": "useShadow", "url": "YAHOO.widget.AutoComplete.html#property_useShadow", "type": "property"}];
|
|
</script>
|
|
</body>
|
|
</html>
|