docs/source/Combo.html

   1 <html>
   2 <head>
   3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   4   <title>The source code</title>
   5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
   6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   7 </head>
   8 <body  onload="prettyPrint();">
   9     <pre class="prettyprint lang-js">/*!
  10  * Ext JS Library 3.2.1
  11  * Copyright(c) 2006-2010 Ext JS, Inc.
  12  * licensing@extjs.com
  13  * http://www.extjs.com/license
  14  */
  15 <div id="cls-Ext.form.ComboBox"></div>/**
  16  * @class Ext.form.ComboBox
  17  * @extends Ext.form.TriggerField
  18  * <p>A combobox control with support for autocomplete, remote-loading, paging and many other features.</p>
  19  * <p>A ComboBox works in a similar manner to a traditional HTML &lt;select> field. The difference is
  20  * that to submit the {@link #valueField}, you must specify a {@link #hiddenName} to create a hidden input
  21  * field to hold the value of the valueField. The <i>{@link #displayField}</i> is shown in the text field
  22  * which is named according to the {@link #name}.</p>
  23  * <p><b><u>Events</u></b></p>
  24  * <p>To do something when something in ComboBox is selected, configure the select event:<pre><code>
  25 var cb = new Ext.form.ComboBox({
  26     // all of your config options
  27     listeners:{
  28          scope: yourScope,
  29          'select': yourFunction
  30     }
  31 });
  32
  33 // Alternatively, you can assign events after the object is created:
  34 var cb = new Ext.form.ComboBox(yourOptions);
  35 cb.on('select', yourFunction, yourScope);
  36  * </code></pre></p>
  37  *
  38  * <p><b><u>ComboBox in Grid</u></b></p>
  39  * <p>If using a ComboBox in an {@link Ext.grid.EditorGridPanel Editor Grid} a {@link Ext.grid.Column#renderer renderer}
  40  * will be needed to show the displayField when the editor is not active.  Set up the renderer manually, or implement
  41  * a reusable render, for example:<pre><code>
  42 // create reusable renderer
  43 Ext.util.Format.comboRenderer = function(combo){
  44     return function(value){
  45         var record = combo.findRecord(combo.{@link #valueField}, value);
  46         return record ? record.get(combo.{@link #displayField}) : combo.{@link #valueNotFoundText};
  47     }
  48 }
  49
  50 // create the combo instance
  51 var combo = new Ext.form.ComboBox({
  52     {@link #typeAhead}: true,
  53     {@link #triggerAction}: 'all',
  54     {@link #lazyRender}:true,
  55     {@link #mode}: 'local',
  56     {@link #store}: new Ext.data.ArrayStore({
  57         id: 0,
  58         fields: [
  59             'myId',
  60             'displayText'
  61         ],
  62         data: [[1, 'item1'], [2, 'item2']]
  63     }),
  64     {@link #valueField}: 'myId',
  65     {@link #displayField}: 'displayText'
  66 });
  67
  68 // snippet of column model used within grid
  69 var cm = new Ext.grid.ColumnModel([{
  70        ...
  71     },{
  72        header: "Some Header",
  73        dataIndex: 'whatever',
  74        width: 130,
  75        editor: combo, // specify reference to combo instance
  76        renderer: Ext.util.Format.comboRenderer(combo) // pass combo instance to reusable renderer
  77     },
  78     ...
  79 ]);
  80  * </code></pre></p>
  81  *
  82  * <p><b><u>Filtering</u></b></p>
  83  * <p>A ComboBox {@link #doQuery uses filtering itself}, for information about filtering the ComboBox
  84  * store manually see <tt>{@link #lastQuery}</tt>.</p>
  85  * @constructor
  86  * Create a new ComboBox.
  87  * @param {Object} config Configuration options
  88  * @xtype combo
  89  */
  90 Ext.form.ComboBox = Ext.extend(Ext.form.TriggerField, {
  91     <div id="cfg-Ext.form.ComboBox-transform"></div>/**
  92      * @cfg {Mixed} transform The id, DOM node or element of an existing HTML SELECT to convert to a ComboBox.
  93      * Note that if you specify this and the combo is going to be in an {@link Ext.form.BasicForm} or
  94      * {@link Ext.form.FormPanel}, you must also set <tt>{@link #lazyRender} = true</tt>.
  95      */
  96     <div id="cfg-Ext.form.ComboBox-lazyRender"></div>/**
  97      * @cfg {Boolean} lazyRender <tt>true</tt> to prevent the ComboBox from rendering until requested
  98      * (should always be used when rendering into an {@link Ext.Editor} (e.g. {@link Ext.grid.EditorGridPanel Grids}),
  99      * defaults to <tt>false</tt>).
 100      */
 101     <div id="cfg-Ext.form.ComboBox-autoCreate"></div>/**
 102      * @cfg {String/Object} autoCreate <p>A {@link Ext.DomHelper DomHelper} element spec, or <tt>true</tt> for a default
 103      * element spec. Used to create the {@link Ext.Component#getEl Element} which will encapsulate this Component.
 104      * See <tt>{@link Ext.Component#autoEl autoEl}</tt> for details.  Defaults to:</p>
 105      * <pre><code>{tag: "input", type: "text", size: "24", autocomplete: "off"}</code></pre>
 106      */
 107     <div id="cfg-Ext.form.ComboBox-store"></div>/**
 108      * @cfg {Ext.data.Store/Array} store The data source to which this combo is bound (defaults to <tt>undefined</tt>).
 109      * Acceptable values for this property are:
 110      * <div class="mdetail-params"><ul>
 111      * <li><b>any {@link Ext.data.Store Store} subclass</b></li>
 112      * <li><b>an Array</b> : Arrays will be converted to a {@link Ext.data.ArrayStore} internally,
 113      * automatically generating {@link Ext.data.Field#name field names} to work with all data components.
 114      * <div class="mdetail-params"><ul>
 115      * <li><b>1-dimensional array</b> : (e.g., <tt>['Foo','Bar']</tt>)<div class="sub-desc">
 116      * A 1-dimensional array will automatically be expanded (each array item will be used for both the combo
 117      * {@link #valueField} and {@link #displayField})</div></li>
 118      * <li><b>2-dimensional array</b> : (e.g., <tt>[['f','Foo'],['b','Bar']]</tt>)<div class="sub-desc">
 119      * For a multi-dimensional array, the value in index 0 of each item will be assumed to be the combo
 120      * {@link #valueField}, while the value at index 1 is assumed to be the combo {@link #displayField}.
 121      * </div></li></ul></div></li></ul></div>
 122      * <p>See also <tt>{@link #mode}</tt>.</p>
 123      */
 124     <div id="cfg-Ext.form.ComboBox-title"></div>/**
 125      * @cfg {String} title If supplied, a header element is created containing this text and added into the top of
 126      * the dropdown list (defaults to undefined, with no header element)
 127      */
 128
 129     // private
 130     defaultAutoCreate : {tag: "input", type: "text", size: "24", autocomplete: "off"},
 131     <div id="cfg-Ext.form.ComboBox-listWidth"></div>/**
 132      * @cfg {Number} listWidth The width (used as a parameter to {@link Ext.Element#setWidth}) of the dropdown
 133      * list (defaults to the width of the ComboBox field).  See also <tt>{@link #minListWidth}
 134      */
 135     <div id="cfg-Ext.form.ComboBox-displayField"></div>/**
 136      * @cfg {String} displayField The underlying {@link Ext.data.Field#name data field name} to bind to this
 137      * ComboBox (defaults to undefined if <tt>{@link #mode} = 'remote'</tt> or <tt>'field1'</tt> if
 138      * {@link #transform transforming a select} or if the {@link #store field name is autogenerated based on
 139      * the store configuration}).
 140      * <p>See also <tt>{@link #valueField}</tt>.</p>
 141      * <p><b>Note</b>: if using a ComboBox in an {@link Ext.grid.EditorGridPanel Editor Grid} a
 142      * {@link Ext.grid.Column#renderer renderer} will be needed to show the displayField when the editor is not
 143      * active.</p>
 144      */
 145     <div id="cfg-Ext.form.ComboBox-valueField"></div>/**
 146      * @cfg {String} valueField The underlying {@link Ext.data.Field#name data value name} to bind to this
 147      * ComboBox (defaults to undefined if <tt>{@link #mode} = 'remote'</tt> or <tt>'field2'</tt> if
 148      * {@link #transform transforming a select} or if the {@link #store field name is autogenerated based on
 149      * the store configuration}).
 150      * <p><b>Note</b>: use of a <tt>valueField</tt> requires the user to make a selection in order for a value to be
 151      * mapped.  See also <tt>{@link #hiddenName}</tt>, <tt>{@link #hiddenValue}</tt>, and <tt>{@link #displayField}</tt>.</p>
 152      */
 153     <div id="cfg-Ext.form.ComboBox-hiddenName"></div>/**
 154      * @cfg {String} hiddenName If specified, a hidden form field with this name is dynamically generated to store the
 155      * field's data value (defaults to the underlying DOM element's name). Required for the combo's value to automatically
 156      * post during a form submission.  See also {@link #valueField}.
 157      * <p><b>Note</b>: the hidden field's id will also default to this name if {@link #hiddenId} is not specified.
 158      * The ComboBox {@link Ext.Component#id id} and the <tt>{@link #hiddenId}</tt> <b>should be different</b>, since
 159      * no two DOM nodes should share the same id.  So, if the ComboBox <tt>{@link Ext.form.Field#name name}</tt> and
 160      * <tt>hiddenName</tt> are the same, you should specify a unique <tt>{@link #hiddenId}</tt>.</p>
 161      */
 162     <div id="cfg-Ext.form.ComboBox-hiddenId"></div>/**
 163      * @cfg {String} hiddenId If <tt>{@link #hiddenName}</tt> is specified, <tt>hiddenId</tt> can also be provided
 164      * to give the hidden field a unique id (defaults to the <tt>{@link #hiddenName}</tt>).  The <tt>hiddenId</tt>
 165      * and combo {@link Ext.Component#id id} should be different, since no two DOM
 166      * nodes should share the same id.
 167      */
 168     <div id="cfg-Ext.form.ComboBox-hiddenValue"></div>/**
 169      * @cfg {String} hiddenValue Sets the initial value of the hidden field if {@link #hiddenName} is
 170      * specified to contain the selected {@link #valueField}, from the Store. Defaults to the configured
 171      * <tt>{@link Ext.form.Field#value value}</tt>.
 172      */
 173     <div id="cfg-Ext.form.ComboBox-listClass"></div>/**
 174      * @cfg {String} listClass The CSS class to add to the predefined <tt>'x-combo-list'</tt> class
 175      * applied the dropdown list element (defaults to '').
 176      */
 177     listClass : '',
 178     <div id="cfg-Ext.form.ComboBox-selectedClass"></div>/**
 179      * @cfg {String} selectedClass CSS class to apply to the selected item in the dropdown list
 180      * (defaults to <tt>'x-combo-selected'</tt>)
 181      */
 182     selectedClass : 'x-combo-selected',
 183     <div id="cfg-Ext.form.ComboBox-listEmptyText"></div>/**
 184      * @cfg {String} listEmptyText The empty text to display in the data view if no items are found.
 185      * (defaults to '')
 186      */
 187     listEmptyText: '',
 188     <div id="cfg-Ext.form.ComboBox-triggerClass"></div>/**
 189      * @cfg {String} triggerClass An additional CSS class used to style the trigger button.  The trigger will always
 190      * get the class <tt>'x-form-trigger'</tt> and <tt>triggerClass</tt> will be <b>appended</b> if specified
 191      * (defaults to <tt>'x-form-arrow-trigger'</tt> which displays a downward arrow icon).
 192      */
 193     triggerClass : 'x-form-arrow-trigger',
 194     <div id="cfg-Ext.form.ComboBox-shadow"></div>/**
 195      * @cfg {Boolean/String} shadow <tt>true</tt> or <tt>"sides"</tt> for the default effect, <tt>"frame"</tt> for
 196      * 4-way shadow, and <tt>"drop"</tt> for bottom-right
 197      */
 198     shadow : 'sides',
 199     <div id="cfg-Ext.form.ComboBox-listAlign"></div>/**
 200      * @cfg {String/Array} listAlign A valid anchor position value. See <tt>{@link Ext.Element#alignTo}</tt> for details
 201      * on supported anchor positions and offsets. To specify x/y offsets as well, this value
 202      * may be specified as an Array of <tt>{@link Ext.Element#alignTo}</tt> method arguments.</p>
 203      * <pre><code>[ 'tl-bl?', [6,0] ]</code></pre>(defaults to <tt>'tl-bl?'</tt>)
 204      */
 205     listAlign : 'tl-bl?',
 206     <div id="cfg-Ext.form.ComboBox-maxHeight"></div>/**
 207      * @cfg {Number} maxHeight The maximum height in pixels of the dropdown list before scrollbars are shown
 208      * (defaults to <tt>300</tt>)
 209      */
 210     maxHeight : 300,
 211     <div id="cfg-Ext.form.ComboBox-minHeight"></div>/**
 212      * @cfg {Number} minHeight The minimum height in pixels of the dropdown list when the list is constrained by its
 213      * distance to the viewport edges (defaults to <tt>90</tt>)
 214      */
 215     minHeight : 90,
 216     <div id="cfg-Ext.form.ComboBox-triggerAction"></div>/**
 217      * @cfg {String} triggerAction The action to execute when the trigger is clicked.
 218      * <div class="mdetail-params"><ul>
 219      * <li><b><tt>'query'</tt></b> : <b>Default</b>
 220      * <p class="sub-desc">{@link #doQuery run the query} using the {@link Ext.form.Field#getRawValue raw value}.</p></li>
 221      * <li><b><tt>'all'</tt></b> :
 222      * <p class="sub-desc">{@link #doQuery run the query} specified by the <tt>{@link #allQuery}</tt> config option</p></li>
 223      * </ul></div>
 224      * <p>See also <code>{@link #queryParam}</code>.</p>
 225      */
 226     triggerAction : 'query',
 227     <div id="cfg-Ext.form.ComboBox-minChars"></div>/**
 228      * @cfg {Number} minChars The minimum number of characters the user must type before autocomplete and
 229      * {@link #typeAhead} activate (defaults to <tt>4</tt> if <tt>{@link #mode} = 'remote'</tt> or <tt>0</tt> if
 230      * <tt>{@link #mode} = 'local'</tt>, does not apply if
 231      * <tt>{@link Ext.form.TriggerField#editable editable} = false</tt>).
 232      */
 233     minChars : 4,
 234     <div id="cfg-Ext.form.ComboBox-autoSelect"></div>/**
 235      * @cfg {Boolean} autoSelect <tt>true</tt> to select the first result gathered by the data store (defaults
 236      * to <tt>true</tt>).  A false value would require a manual selection from the dropdown list to set the components value
 237      * unless the value of ({@link #typeAheadDelay}) were true.
 238      */
 239     autoSelect : true,
 240     <div id="cfg-Ext.form.ComboBox-typeAhead"></div>/**
 241      * @cfg {Boolean} typeAhead <tt>true</tt> to populate and autoselect the remainder of the text being
 242      * typed after a configurable delay ({@link #typeAheadDelay}) if it matches a known value (defaults
 243      * to <tt>false</tt>)
 244      */
 245     typeAhead : false,
 246     <div id="cfg-Ext.form.ComboBox-queryDelay"></div>/**
 247      * @cfg {Number} queryDelay The length of time in milliseconds to delay between the start of typing and
 248      * sending the query to filter the dropdown list (defaults to <tt>500</tt> if <tt>{@link #mode} = 'remote'</tt>
 249      * or <tt>10</tt> if <tt>{@link #mode} = 'local'</tt>)
 250      */
 251     queryDelay : 500,
 252     <div id="cfg-Ext.form.ComboBox-pageSize"></div>/**
 253      * @cfg {Number} pageSize If greater than <tt>0</tt>, a {@link Ext.PagingToolbar} is displayed in the
 254      * footer of the dropdown list and the {@link #doQuery filter queries} will execute with page start and
 255      * {@link Ext.PagingToolbar#pageSize limit} parameters. Only applies when <tt>{@link #mode} = 'remote'</tt>
 256      * (defaults to <tt>0</tt>).
 257      */
 258     pageSize : 0,
 259     <div id="cfg-Ext.form.ComboBox-selectOnFocus"></div>/**
 260      * @cfg {Boolean} selectOnFocus <tt>true</tt> to select any existing text in the field immediately on focus.
 261      * Only applies when <tt>{@link Ext.form.TriggerField#editable editable} = true</tt> (defaults to
 262      * <tt>false</tt>).
 263      */
 264     selectOnFocus : false,
 265     <div id="cfg-Ext.form.ComboBox-queryParam"></div>/**
 266      * @cfg {String} queryParam Name of the query ({@link Ext.data.Store#baseParam baseParam} name for the store)
 267      * as it will be passed on the querystring (defaults to <tt>'query'</tt>)
 268      */
 269     queryParam : 'query',
 270     <div id="cfg-Ext.form.ComboBox-loadingText"></div>/**
 271      * @cfg {String} loadingText The text to display in the dropdown list while data is loading.  Only applies
 272      * when <tt>{@link #mode} = 'remote'</tt> (defaults to <tt>'Loading...'</tt>)
 273      */
 274     loadingText : 'Loading...',
 275     <div id="cfg-Ext.form.ComboBox-resizable"></div>/**
 276      * @cfg {Boolean} resizable <tt>true</tt> to add a resize handle to the bottom of the dropdown list
 277      * (creates an {@link Ext.Resizable} with 'se' {@link Ext.Resizable#pinned pinned} handles).
 278      * Defaults to <tt>false</tt>.
 279      */
 280     resizable : false,
 281     <div id="cfg-Ext.form.ComboBox-handleHeight"></div>/**
 282      * @cfg {Number} handleHeight The height in pixels of the dropdown list resize handle if
 283      * <tt>{@link #resizable} = true</tt> (defaults to <tt>8</tt>)
 284      */
 285     handleHeight : 8,
 286     <div id="cfg-Ext.form.ComboBox-allQuery"></div>/**
 287      * @cfg {String} allQuery The text query to send to the server to return all records for the list
 288      * with no filtering (defaults to '')
 289      */
 290     allQuery: '',
 291     <div id="cfg-Ext.form.ComboBox-mode"></div>/**
 292      * @cfg {String} mode Acceptable values are:
 293      * <div class="mdetail-params"><ul>
 294      * <li><b><tt>'remote'</tt></b> : <b>Default</b>
 295      * <p class="sub-desc">Automatically loads the <tt>{@link #store}</tt> the <b>first</b> time the trigger
 296      * is clicked. If you do not want the store to be automatically loaded the first time the trigger is
 297      * clicked, set to <tt>'local'</tt> and manually load the store.  To force a requery of the store
 298      * <b>every</b> time the trigger is clicked see <tt>{@link #lastQuery}</tt>.</p></li>
 299      * <li><b><tt>'local'</tt></b> :
 300      * <p class="sub-desc">ComboBox loads local data</p>
 301      * <pre><code>
 302 var combo = new Ext.form.ComboBox({
 303     renderTo: document.body,
 304     mode: 'local',
 305     store: new Ext.data.ArrayStore({
 306         id: 0,
 307         fields: [
 308             'myId',  // numeric value is the key
 309             'displayText'
 310         ],
 311         data: [[1, 'item1'], [2, 'item2']]  // data is local
 312     }),
 313     valueField: 'myId',
 314     displayField: 'displayText',
 315     triggerAction: 'all'
 316 });
 317      * </code></pre></li>
 318      * </ul></div>
 319      */
 320     mode: 'remote',
 321     <div id="cfg-Ext.form.ComboBox-minListWidth"></div>/**
 322      * @cfg {Number} minListWidth The minimum width of the dropdown list in pixels (defaults to <tt>70</tt>, will
 323      * be ignored if <tt>{@link #listWidth}</tt> has a higher value)
 324      */
 325     minListWidth : 70,
 326     <div id="cfg-Ext.form.ComboBox-forceSelection"></div>/**
 327      * @cfg {Boolean} forceSelection <tt>true</tt> to restrict the selected value to one of the values in the list,
 328      * <tt>false</tt> to allow the user to set arbitrary text into the field (defaults to <tt>false</tt>)
 329      */
 330     forceSelection : false,
 331     <div id="cfg-Ext.form.ComboBox-typeAheadDelay"></div>/**
 332      * @cfg {Number} typeAheadDelay The length of time in milliseconds to wait until the typeahead text is displayed
 333      * if <tt>{@link #typeAhead} = true</tt> (defaults to <tt>250</tt>)
 334      */
 335     typeAheadDelay : 250,
 336     <div id="cfg-Ext.form.ComboBox-valueNotFoundText"></div>/**
 337      * @cfg {String} valueNotFoundText When using a name/value combo, if the value passed to setValue is not found in
 338      * the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined). If this
 339      * default text is used, it means there is no value set and no validation will occur on this field.
 340      */
 341
 342     <div id="cfg-Ext.form.ComboBox-lazyInit"></div>/**
 343      * @cfg {Boolean} lazyInit <tt>true</tt> to not initialize the list for this combo until the field is focused
 344      * (defaults to <tt>true</tt>)
 345      */
 346     lazyInit : true,
 347
 348     <div id="cfg-Ext.form.ComboBox-clearFilterOnReset"></div>/**
 349      * @cfg {Boolean} clearFilterOnReset <tt>true</tt> to clear any filters on the store (when in local mode) when reset is called
 350      * (defaults to <tt>true</tt>)
 351      */
 352     clearFilterOnReset : true,
 353
 354     <div id="cfg-Ext.form.ComboBox-submitValue"></div>/**
 355      * @cfg {Boolean} submitValue False to clear the name attribute on the field so that it is not submitted during a form post.
 356      * If a hiddenName is specified, setting this to true will cause both the hidden field and the element to be submitted.
 357      * Defaults to <tt>undefined</tt>.
 358      */
 359     submitValue: undefined,
 360
 361     <div id="prop-Ext.form.ComboBox-lastQuery"></div>/**
 362      * The value of the match string used to filter the store. Delete this property to force a requery.
 363      * Example use:
 364      * <pre><code>
 365 var combo = new Ext.form.ComboBox({
 366     ...
 367     mode: 'remote',
 368     ...
 369     listeners: {
 370         // delete the previous query in the beforequery event or set
 371         // combo.lastQuery = null (this will reload the store the next time it expands)
 372         beforequery: function(qe){
 373             delete qe.combo.lastQuery;
 374         }
 375     }
 376 });
 377      * </code></pre>
 378      * To make sure the filter in the store is not cleared the first time the ComboBox trigger is used
 379      * configure the combo with <tt>lastQuery=''</tt>. Example use:
 380      * <pre><code>
 381 var combo = new Ext.form.ComboBox({
 382     ...
 383     mode: 'local',
 384     triggerAction: 'all',
 385     lastQuery: ''
 386 });
 387      * </code></pre>
 388      * @property lastQuery
 389      * @type String
 390      */
 391
 392     // private
 393     initComponent : function(){
 394         Ext.form.ComboBox.superclass.initComponent.call(this);
 395         this.addEvents(
 396             <div id="event-Ext.form.ComboBox-expand"></div>/**
 397              * @event expand
 398              * Fires when the dropdown list is expanded
 399              * @param {Ext.form.ComboBox} combo This combo box
 400              */
 401             'expand',
 402             <div id="event-Ext.form.ComboBox-collapse"></div>/**
 403              * @event collapse
 404              * Fires when the dropdown list is collapsed
 405              * @param {Ext.form.ComboBox} combo This combo box
 406              */
 407             'collapse',
 408
 409             <div id="event-Ext.form.ComboBox-beforeselect"></div>/**
 410              * @event beforeselect
 411              * Fires before a list item is selected. Return false to cancel the selection.
 412              * @param {Ext.form.ComboBox} combo This combo box
 413              * @param {Ext.data.Record} record The data record returned from the underlying store
 414              * @param {Number} index The index of the selected item in the dropdown list
 415              */
 416             'beforeselect',
 417             <div id="event-Ext.form.ComboBox-select"></div>/**
 418              * @event select
 419              * Fires when a list item is selected
 420              * @param {Ext.form.ComboBox} combo This combo box
 421              * @param {Ext.data.Record} record The data record returned from the underlying store
 422              * @param {Number} index The index of the selected item in the dropdown list
 423              */
 424             'select',
 425             <div id="event-Ext.form.ComboBox-beforequery"></div>/**
 426              * @event beforequery
 427              * Fires before all queries are processed. Return false to cancel the query or set the queryEvent's
 428              * cancel property to true.
 429              * @param {Object} queryEvent An object that has these properties:<ul>
 430              * <li><code>combo</code> : Ext.form.ComboBox <div class="sub-desc">This combo box</div></li>
 431              * <li><code>query</code> : String <div class="sub-desc">The query</div></li>
 432              * <li><code>forceAll</code> : Boolean <div class="sub-desc">True to force "all" query</div></li>
 433              * <li><code>cancel</code> : Boolean <div class="sub-desc">Set to true to cancel the query</div></li>
 434              * </ul>
 435              */
 436             'beforequery'
 437         );
 438         if(this.transform){
 439             var s = Ext.getDom(this.transform);
 440             if(!this.hiddenName){
 441                 this.hiddenName = s.name;
 442             }
 443             if(!this.store){
 444                 this.mode = 'local';
 445                 var d = [], opts = s.options;
 446                 for(var i = 0, len = opts.length;i < len; i++){
 447                     var o = opts[i],
 448                         value = (o.hasAttribute ? o.hasAttribute('value') : o.getAttributeNode('value').specified) ? o.value : o.text;
 449                     if(o.selected && Ext.isEmpty(this.value, true)) {
 450                         this.value = value;
 451                     }
 452                     d.push([value, o.text]);
 453                 }
 454                 this.store = new Ext.data.ArrayStore({
 455                     'id': 0,
 456                     fields: ['value', 'text'],
 457                     data : d,
 458                     autoDestroy: true
 459                 });
 460                 this.valueField = 'value';
 461                 this.displayField = 'text';
 462             }
 463             s.name = Ext.id(); // wipe out the name in case somewhere else they have a reference
 464             if(!this.lazyRender){
 465                 this.target = true;
 466                 this.el = Ext.DomHelper.insertBefore(s, this.autoCreate || this.defaultAutoCreate);
 467                 this.render(this.el.parentNode, s);
 468             }
 469             Ext.removeNode(s);
 470         }
 471         //auto-configure store from local array data
 472         else if(this.store){
 473             this.store = Ext.StoreMgr.lookup(this.store);
 474             if(this.store.autoCreated){
 475                 this.displayField = this.valueField = 'field1';
 476                 if(!this.store.expandData){
 477                     this.displayField = 'field2';
 478                 }
 479                 this.mode = 'local';
 480             }
 481         }
 482
 483         this.selectedIndex = -1;
 484         if(this.mode == 'local'){
 485             if(!Ext.isDefined(this.initialConfig.queryDelay)){
 486                 this.queryDelay = 10;
 487             }
 488             if(!Ext.isDefined(this.initialConfig.minChars)){
 489                 this.minChars = 0;
 490             }
 491         }
 492     },
 493
 494     // private
 495     onRender : function(ct, position){
 496         if(this.hiddenName && !Ext.isDefined(this.submitValue)){
 497             this.submitValue = false;
 498         }
 499         Ext.form.ComboBox.superclass.onRender.call(this, ct, position);
 500         if(this.hiddenName){
 501             this.hiddenField = this.el.insertSibling({tag:'input', type:'hidden', name: this.hiddenName,
 502                     id: (this.hiddenId||this.hiddenName)}, 'before', true);
 503
 504         }
 505         if(Ext.isGecko){
 506             this.el.dom.setAttribute('autocomplete', 'off');
 507         }
 508
 509         if(!this.lazyInit){
 510             this.initList();
 511         }else{
 512             this.on('focus', this.initList, this, {single: true});
 513         }
 514     },
 515
 516     // private
 517     initValue : function(){
 518         Ext.form.ComboBox.superclass.initValue.call(this);
 519         if(this.hiddenField){
 520             this.hiddenField.value =
 521                 Ext.value(Ext.isDefined(this.hiddenValue) ? this.hiddenValue : this.value, '');
 522         }
 523     },
 524
 525     getParentZIndex : function(){
 526         var zindex;
 527         if (this.ownerCt){
 528             this.findParentBy(function(ct){
 529                 zindex = parseInt(ct.getPositionEl().getStyle('z-index'), 10);
 530                 return !!zindex;
 531             });
 532         }
 533         return zindex;
 534     },
 535
 536     // private
 537     initList : function(){
 538         if(!this.list){
 539             var cls = 'x-combo-list',
 540                 listParent = Ext.getDom(this.getListParent() || Ext.getBody()),
 541                 zindex = parseInt(Ext.fly(listParent).getStyle('z-index'), 10);
 542
 543             if (!zindex) {
 544                 zindex = this.getParentZIndex();
 545             }
 546
 547             this.list = new Ext.Layer({
 548                 parentEl: listParent,
 549                 shadow: this.shadow,
 550                 cls: [cls, this.listClass].join(' '),
 551                 constrain:false,
 552                 zindex: (zindex || 12000) + 5
 553             });
 554
 555             var lw = this.listWidth || Math.max(this.wrap.getWidth(), this.minListWidth);
 556             this.list.setSize(lw, 0);
 557             this.list.swallowEvent('mousewheel');
 558             this.assetHeight = 0;
 559             if(this.syncFont !== false){
 560                 this.list.setStyle('font-size', this.el.getStyle('font-size'));
 561             }
 562             if(this.title){
 563                 this.header = this.list.createChild({cls:cls+'-hd', html: this.title});
 564                 this.assetHeight += this.header.getHeight();
 565             }
 566
 567             this.innerList = this.list.createChild({cls:cls+'-inner'});
 568             this.mon(this.innerList, 'mouseover', this.onViewOver, this);
 569             this.mon(this.innerList, 'mousemove', this.onViewMove, this);
 570             this.innerList.setWidth(lw - this.list.getFrameWidth('lr'));
 571
 572             if(this.pageSize){
 573                 this.footer = this.list.createChild({cls:cls+'-ft'});
 574                 this.pageTb = new Ext.PagingToolbar({
 575                     store: this.store,
 576                     pageSize: this.pageSize,
 577                     renderTo:this.footer
 578                 });
 579                 this.assetHeight += this.footer.getHeight();
 580             }
 581
 582             if(!this.tpl){
 583                 <div id="cfg-Ext.form.ComboBox-tpl"></div>/**
 584                 * @cfg {String/Ext.XTemplate} tpl <p>The template string, or {@link Ext.XTemplate} instance to
 585                 * use to display each item in the dropdown list. The dropdown list is displayed in a
 586                 * DataView. See {@link #view}.</p>
 587                 * <p>The default template string is:</p><pre><code>
 588                   '&lt;tpl for=".">&lt;div class="x-combo-list-item">{' + this.displayField + '}&lt;/div>&lt;/tpl>'
 589                 * </code></pre>
 590                 * <p>Override the default value to create custom UI layouts for items in the list.
 591                 * For example:</p><pre><code>
 592                   '&lt;tpl for=".">&lt;div ext:qtip="{state}. {nick}" class="x-combo-list-item">{state}&lt;/div>&lt;/tpl>'
 593                 * </code></pre>
 594                 * <p>The template <b>must</b> contain one or more substitution parameters using field
 595                 * names from the Combo's</b> {@link #store Store}. In the example above an
 596                 * <pre>ext:qtip</pre> attribute is added to display other fields from the Store.</p>
 597                 * <p>To preserve the default visual look of list items, add the CSS class name
 598                 * <pre>x-combo-list-item</pre> to the template's container element.</p>
 599                 * <p>Also see {@link #itemSelector} for additional details.</p>
 600                 */
 601                 this.tpl = '<tpl for="."><div class="'+cls+'-item">{' + this.displayField + '}</div></tpl>';
 602                 <div id="cfg-Ext.form.ComboBox-itemSelector"></div>/**
 603                  * @cfg {String} itemSelector
 604                  * <p>A simple CSS selector (e.g. div.some-class or span:first-child) that will be
 605                  * used to determine what nodes the {@link #view Ext.DataView} which handles the dropdown
 606                  * display will be working with.</p>
 607                  * <p><b>Note</b>: this setting is <b>required</b> if a custom XTemplate has been
 608                  * specified in {@link #tpl} which assigns a class other than <pre>'x-combo-list-item'</pre>
 609                  * to dropdown list items</b>
 610                  */
 611             }
 612
 613             <div id="prop-Ext.form.ComboBox-view"></div>/**
 614             * The {@link Ext.DataView DataView} used to display the ComboBox's options.
 615             * @type Ext.DataView
 616             */
 617             this.view = new Ext.DataView({
 618                 applyTo: this.innerList,
 619                 tpl: this.tpl,
 620                 singleSelect: true,
 621                 selectedClass: this.selectedClass,
 622                 itemSelector: this.itemSelector || '.' + cls + '-item',
 623                 emptyText: this.listEmptyText,
 624                 deferEmptyText: false
 625             });
 626
 627             this.mon(this.view, {
 628                 containerclick : this.onViewClick,
 629                 click : this.onViewClick,
 630                 scope :this
 631             });
 632
 633             this.bindStore(this.store, true);
 634
 635             if(this.resizable){
 636                 this.resizer = new Ext.Resizable(this.list,  {
 637                    pinned:true, handles:'se'
 638                 });
 639                 this.mon(this.resizer, 'resize', function(r, w, h){
 640                     this.maxHeight = h-this.handleHeight-this.list.getFrameWidth('tb')-this.assetHeight;
 641                     this.listWidth = w;
 642                     this.innerList.setWidth(w - this.list.getFrameWidth('lr'));
 643                     this.restrictHeight();
 644                 }, this);
 645
 646                 this[this.pageSize?'footer':'innerList'].setStyle('margin-bottom', this.handleHeight+'px');
 647             }
 648         }
 649     },
 650
 651     <div id="method-Ext.form.ComboBox-getListParent"></div>/**
 652      * <p>Returns the element used to house this ComboBox's pop-up list. Defaults to the document body.</p>
 653      * A custom implementation may be provided as a configuration option if the floating list needs to be rendered
 654      * to a different Element. An example might be rendering the list inside a Menu so that clicking
 655      * the list does not hide the Menu:<pre><code>
 656 var store = new Ext.data.ArrayStore({
 657     autoDestroy: true,
 658     fields: ['initials', 'fullname'],
 659     data : [
 660         ['FF', 'Fred Flintstone'],
 661         ['BR', 'Barney Rubble']
 662     ]
 663 });
 664
 665 var combo = new Ext.form.ComboBox({
 666     store: store,
 667     displayField: 'fullname',
 668     emptyText: 'Select a name...',
 669     forceSelection: true,
 670     getListParent: function() {
 671         return this.el.up('.x-menu');
 672     },
 673     iconCls: 'no-icon', //use iconCls if placing within menu to shift to right side of menu
 674     mode: 'local',
 675     selectOnFocus: true,
 676     triggerAction: 'all',
 677     typeAhead: true,
 678     width: 135
 679 });
 680
 681 var menu = new Ext.menu.Menu({
 682     id: 'mainMenu',
 683     items: [
 684         combo // A Field in a Menu
 685     ]
 686 });
 687 </code></pre>
 688      */
 689     getListParent : function() {
 690         return document.body;
 691     },
 692
 693     <div id="method-Ext.form.ComboBox-getStore"></div>/**
 694      * Returns the store associated with this combo.
 695      * @return {Ext.data.Store} The store
 696      */
 697     getStore : function(){
 698         return this.store;
 699     },
 700
 701     // private
 702     bindStore : function(store, initial){
 703         if(this.store && !initial){
 704             if(this.store !== store && this.store.autoDestroy){
 705                 this.store.destroy();
 706             }else{
 707                 this.store.un('beforeload', this.onBeforeLoad, this);
 708                 this.store.un('load', this.onLoad, this);
 709                 this.store.un('exception', this.collapse, this);
 710             }
 711             if(!store){
 712                 this.store = null;
 713                 if(this.view){
 714                     this.view.bindStore(null);
 715                 }
 716                 if(this.pageTb){
 717                     this.pageTb.bindStore(null);
 718                 }
 719             }
 720         }
 721         if(store){
 722             if(!initial) {
 723                 this.lastQuery = null;
 724                 if(this.pageTb) {
 725                     this.pageTb.bindStore(store);
 726                 }
 727             }
 728
 729             this.store = Ext.StoreMgr.lookup(store);
 730             this.store.on({
 731                 scope: this,
 732                 beforeload: this.onBeforeLoad,
 733                 load: this.onLoad,
 734                 exception: this.collapse
 735             });
 736
 737             if(this.view){
 738                 this.view.bindStore(store);
 739             }
 740         }
 741     },
 742
 743     reset : function(){
 744         Ext.form.ComboBox.superclass.reset.call(this);
 745         if(this.clearFilterOnReset && this.mode == 'local'){
 746             this.store.clearFilter();
 747         }
 748     },
 749
 750     // private
 751     initEvents : function(){
 752         Ext.form.ComboBox.superclass.initEvents.call(this);
 753
 754         <div id="prop-Ext.form.ComboBox-keyNav"></div>/**
 755          * @property keyNav
 756          * @type Ext.KeyNav
 757          * <p>A {@link Ext.KeyNav KeyNav} object which handles navigation keys for this ComboBox. This performs actions
 758          * based on keystrokes typed when the input field is focused.</p>
 759          * <p><b>After the ComboBox has been rendered</b>, you may override existing navigation key functionality,
 760          * or add your own based upon key names as specified in the {@link Ext.KeyNav KeyNav} class.</p>
 761          * <p>The function is executed in the scope (<code>this</code> reference of the ComboBox. Example:</p><pre><code>
 762 myCombo.keyNav.esc = function(e) {  // Override ESC handling function
 763     this.collapse();                // Standard behaviour of Ext's ComboBox.
 764     this.setValue(this.startValue); // We reset to starting value on ESC
 765 };
 766 myCombo.keyNav.tab = function() {   // Override TAB handling function
 767     this.onViewClick(false);        // Select the currently highlighted row
 768 };
 769 </code></pre>
 770          */
 771         this.keyNav = new Ext.KeyNav(this.el, {
 772             "up" : function(e){
 773                 this.inKeyMode = true;
 774                 this.selectPrev();
 775             },
 776
 777             "down" : function(e){
 778                 if(!this.isExpanded()){
 779                     this.onTriggerClick();
 780                 }else{
 781                     this.inKeyMode = true;
 782                     this.selectNext();
 783                 }
 784             },
 785
 786             "enter" : function(e){
 787                 this.onViewClick();
 788             },
 789
 790             "esc" : function(e){
 791                 this.collapse();
 792             },
 793
 794             "tab" : function(e){
 795                 if (this.forceSelection === true) {
 796                     this.collapse();
 797                 } else {
 798                     this.onViewClick(false);
 799                 }
 800                 return true;
 801             },
 802
 803             scope : this,
 804
 805             doRelay : function(e, h, hname){
 806                 if(hname == 'down' || this.scope.isExpanded()){
 807                     // this MUST be called before ComboBox#fireKey()
 808                     var relay = Ext.KeyNav.prototype.doRelay.apply(this, arguments);
 809                     if(!Ext.isIE && Ext.EventManager.useKeydown){
 810                         // call Combo#fireKey() for browsers which use keydown event (except IE)
 811                         this.scope.fireKey(e);
 812                     }
 813                     return relay;
 814                 }
 815                 return true;
 816             },
 817
 818             forceKeyDown : true,
 819             defaultEventAction: 'stopEvent'
 820         });
 821         this.queryDelay = Math.max(this.queryDelay || 10,
 822                 this.mode == 'local' ? 10 : 250);
 823         this.dqTask = new Ext.util.DelayedTask(this.initQuery, this);
 824         if(this.typeAhead){
 825             this.taTask = new Ext.util.DelayedTask(this.onTypeAhead, this);
 826         }
 827         if(!this.enableKeyEvents){
 828             this.mon(this.el, 'keyup', this.onKeyUp, this);
 829         }
 830     },
 831
 832
 833     // private
 834     onDestroy : function(){
 835         if (this.dqTask){
 836             this.dqTask.cancel();
 837             this.dqTask = null;
 838         }
 839         this.bindStore(null);
 840         Ext.destroy(
 841             this.resizer,
 842             this.view,
 843             this.pageTb,
 844             this.list
 845         );
 846         Ext.destroyMembers(this, 'hiddenField');
 847         Ext.form.ComboBox.superclass.onDestroy.call(this);
 848     },
 849
 850     // private
 851     fireKey : function(e){
 852         if (!this.isExpanded()) {
 853             Ext.form.ComboBox.superclass.fireKey.call(this, e);
 854         }
 855     },
 856
 857     // private
 858     onResize : function(w, h){
 859         Ext.form.ComboBox.superclass.onResize.apply(this, arguments);
 860         if(!isNaN(w) && this.isVisible() && this.list){
 861             this.doResize(w);
 862         }else{
 863             this.bufferSize = w;
 864         }
 865     },
 866
 867     doResize: function(w){
 868         if(!Ext.isDefined(this.listWidth)){
 869             var lw = Math.max(w, this.minListWidth);
 870             this.list.setWidth(lw);
 871             this.innerList.setWidth(lw - this.list.getFrameWidth('lr'));
 872         }
 873     },
 874
 875     // private
 876     onEnable : function(){
 877         Ext.form.ComboBox.superclass.onEnable.apply(this, arguments);
 878         if(this.hiddenField){
 879             this.hiddenField.disabled = false;
 880         }
 881     },
 882
 883     // private
 884     onDisable : function(){
 885         Ext.form.ComboBox.superclass.onDisable.apply(this, arguments);
 886         if(this.hiddenField){
 887             this.hiddenField.disabled = true;
 888         }
 889     },
 890
 891     // private
 892     onBeforeLoad : function(){
 893         if(!this.hasFocus){
 894             return;
 895         }
 896         this.innerList.update(this.loadingText ?
 897                '<div class="loading-indicator">'+this.loadingText+'</div>' : '');
 898         this.restrictHeight();
 899         this.selectedIndex = -1;
 900     },
 901
 902     // private
 903     onLoad : function(){
 904         if(!this.hasFocus){
 905             return;
 906         }
 907         if(this.store.getCount() > 0 || this.listEmptyText){
 908             this.expand();
 909             this.restrictHeight();
 910             if(this.lastQuery == this.allQuery){
 911                 if(this.editable){
 912                     this.el.dom.select();
 913                 }
 914
 915                 if(this.autoSelect !== false && !this.selectByValue(this.value, true)){
 916                     this.select(0, true);
 917                 }
 918             }else{
 919                 if(this.autoSelect !== false){
 920                     this.selectNext();
 921                 }
 922                 if(this.typeAhead && this.lastKey != Ext.EventObject.BACKSPACE && this.lastKey != Ext.EventObject.DELETE){
 923                     this.taTask.delay(this.typeAheadDelay);
 924                 }
 925             }
 926         }else{
 927             this.collapse();
 928         }
 929
 930     },
 931
 932     // private
 933     onTypeAhead : function(){
 934         if(this.store.getCount() > 0){
 935             var r = this.store.getAt(0);
 936             var newValue = r.data[this.displayField];
 937             var len = newValue.length;
 938             var selStart = this.getRawValue().length;
 939             if(selStart != len){
 940                 this.setRawValue(newValue);
 941                 this.selectText(selStart, newValue.length);
 942             }
 943         }
 944     },
 945
 946     // private
 947     assertValue  : function(){
 948         var val = this.getRawValue(),
 949             rec = this.findRecord(this.displayField, val);
 950
 951         if(!rec && this.forceSelection){
 952             if(val.length > 0 && val != this.emptyText){
 953                 this.el.dom.value = Ext.value(this.lastSelectionText, '');
 954                 this.applyEmptyText();
 955             }else{
 956                 this.clearValue();
 957             }
 958         }else{
 959             if(rec){
 960                 // onSelect may have already set the value and by doing so
 961                 // set the display field properly.  Let's not wipe out the
 962                 // valueField here by just sending the displayField.
 963                 if (val == rec.get(this.displayField) && this.value == rec.get(this.valueField)){
 964                     return;
 965                 }
 966                 val = rec.get(this.valueField || this.displayField);
 967             }
 968             this.setValue(val);
 969         }
 970     },
 971
 972     // private
 973     onSelect : function(record, index){
 974         if(this.fireEvent('beforeselect', this, record, index) !== false){
 975             this.setValue(record.data[this.valueField || this.displayField]);
 976             this.collapse();
 977             this.fireEvent('select', this, record, index);
 978         }
 979     },
 980
 981     // inherit docs
 982     getName: function(){
 983         var hf = this.hiddenField;
 984         return hf && hf.name ? hf.name : this.hiddenName || Ext.form.ComboBox.superclass.getName.call(this);
 985     },
 986
 987     <div id="method-Ext.form.ComboBox-getValue"></div>/**
 988      * Returns the currently selected field value or empty string if no value is set.
 989      * @return {String} value The selected value
 990      */
 991     getValue : function(){
 992         if(this.valueField){
 993             return Ext.isDefined(this.value) ? this.value : '';
 994         }else{
 995             return Ext.form.ComboBox.superclass.getValue.call(this);
 996         }
 997     },
 998
 999     <div id="method-Ext.form.ComboBox-clearValue"></div>/**
1000      * Clears any text/value currently set in the field
1001      */
1002     clearValue : function(){
1003         if(this.hiddenField){
1004             this.hiddenField.value = '';
1005         }
1006         this.setRawValue('');
1007         this.lastSelectionText = '';
1008         this.applyEmptyText();
1009         this.value = '';
1010     },
1011
1012     <div id="method-Ext.form.ComboBox-setValue"></div>/**
1013      * Sets the specified value into the field.  If the value finds a match, the corresponding record text
1014      * will be displayed in the field.  If the value does not match the data value of an existing item,
1015      * and the valueNotFoundText config option is defined, it will be displayed as the default field text.
1016      * Otherwise the field will be blank (although the value will still be set).
1017      * @param {String} value The value to match
1018      * @return {Ext.form.Field} this
1019      */
1020     setValue : function(v){
1021         var text = v;
1022         if(this.valueField){
1023             var r = this.findRecord(this.valueField, v);
1024             if(r){
1025                 text = r.data[this.displayField];
1026             }else if(Ext.isDefined(this.valueNotFoundText)){
1027                 text = this.valueNotFoundText;
1028             }
1029         }
1030         this.lastSelectionText = text;
1031         if(this.hiddenField){
1032             this.hiddenField.value = Ext.value(v, '');
1033         }
1034         Ext.form.ComboBox.superclass.setValue.call(this, text);
1035         this.value = v;
1036         return this;
1037     },
1038
1039     // private
1040     findRecord : function(prop, value){
1041         var record;
1042         if(this.store.getCount() > 0){
1043             this.store.each(function(r){
1044                 if(r.data[prop] == value){
1045                     record = r;
1046                     return false;
1047                 }
1048             });
1049         }
1050         return record;
1051     },
1052
1053     // private
1054     onViewMove : function(e, t){
1055         this.inKeyMode = false;
1056     },
1057
1058     // private
1059     onViewOver : function(e, t){
1060         if(this.inKeyMode){ // prevent key nav and mouse over conflicts
1061             return;
1062         }
1063         var item = this.view.findItemFromChild(t);
1064         if(item){
1065             var index = this.view.indexOf(item);
1066             this.select(index, false);
1067         }
1068     },
1069
1070     // private
1071     onViewClick : function(doFocus){
1072         var index = this.view.getSelectedIndexes()[0],
1073             s = this.store,
1074             r = s.getAt(index);
1075         if(r){
1076             this.onSelect(r, index);
1077         }else {
1078             this.collapse();
1079         }
1080         if(doFocus !== false){
1081             this.el.focus();
1082         }
1083     },
1084
1085
1086     // private
1087     restrictHeight : function(){
1088         this.innerList.dom.style.height = '';
1089         var inner = this.innerList.dom,
1090             pad = this.list.getFrameWidth('tb') + (this.resizable ? this.handleHeight : 0) + this.assetHeight,
1091             h = Math.max(inner.clientHeight, inner.offsetHeight, inner.scrollHeight),
1092             ha = this.getPosition()[1]-Ext.getBody().getScroll().top,
1093             hb = Ext.lib.Dom.getViewHeight()-ha-this.getSize().height,
1094             space = Math.max(ha, hb, this.minHeight || 0)-this.list.shadowOffset-pad-5;
1095
1096         h = Math.min(h, space, this.maxHeight);
1097
1098         this.innerList.setHeight(h);
1099         this.list.beginUpdate();
1100         this.list.setHeight(h+pad);
1101         this.list.alignTo.apply(this.list, [this.el].concat(this.listAlign));
1102         this.list.endUpdate();
1103     },
1104
1105     <div id="method-Ext.form.ComboBox-isExpanded"></div>/**
1106      * Returns true if the dropdown list is expanded, else false.
1107      */
1108     isExpanded : function(){
1109         return this.list && this.list.isVisible();
1110     },
1111
1112     <div id="method-Ext.form.ComboBox-selectByValue"></div>/**
1113      * Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.
1114      * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
1115      * @param {String} value The data value of the item to select
1116      * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
1117      * selected item if it is not currently in view (defaults to true)
1118      * @return {Boolean} True if the value matched an item in the list, else false
1119      */
1120     selectByValue : function(v, scrollIntoView){
1121         if(!Ext.isEmpty(v, true)){
1122             var r = this.findRecord(this.valueField || this.displayField, v);
1123             if(r){
1124                 this.select(this.store.indexOf(r), scrollIntoView);
1125                 return true;
1126             }
1127         }
1128         return false;
1129     },
1130
1131     <div id="method-Ext.form.ComboBox-select"></div>/**
1132      * Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.
1133      * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
1134      * @param {Number} index The zero-based index of the list item to select
1135      * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
1136      * selected item if it is not currently in view (defaults to true)
1137      */
1138     select : function(index, scrollIntoView){
1139         this.selectedIndex = index;
1140         this.view.select(index);
1141         if(scrollIntoView !== false){
1142             var el = this.view.getNode(index);
1143             if(el){
1144                 this.innerList.scrollChildIntoView(el, false);
1145             }
1146         }
1147
1148     },
1149
1150     // private
1151     selectNext : function(){
1152         var ct = this.store.getCount();
1153         if(ct > 0){
1154             if(this.selectedIndex == -1){
1155                 this.select(0);
1156             }else if(this.selectedIndex < ct-1){
1157                 this.select(this.selectedIndex+1);
1158             }
1159         }
1160     },
1161
1162     // private
1163     selectPrev : function(){
1164         var ct = this.store.getCount();
1165         if(ct > 0){
1166             if(this.selectedIndex == -1){
1167                 this.select(0);
1168             }else if(this.selectedIndex !== 0){
1169                 this.select(this.selectedIndex-1);
1170             }
1171         }
1172     },
1173
1174     // private
1175     onKeyUp : function(e){
1176         var k = e.getKey();
1177         if(this.editable !== false && this.readOnly !== true && (k == e.BACKSPACE || !e.isSpecialKey())){
1178
1179             this.lastKey = k;
1180             this.dqTask.delay(this.queryDelay);
1181         }
1182         Ext.form.ComboBox.superclass.onKeyUp.call(this, e);
1183     },
1184
1185     // private
1186     validateBlur : function(){
1187         return !this.list || !this.list.isVisible();
1188     },
1189
1190     // private
1191     initQuery : function(){
1192         this.doQuery(this.getRawValue());
1193     },
1194
1195     // private
1196     beforeBlur : function(){
1197         this.assertValue();
1198     },
1199
1200     // private
1201     postBlur  : function(){
1202         Ext.form.ComboBox.superclass.postBlur.call(this);
1203         this.collapse();
1204         this.inKeyMode = false;
1205     },
1206
1207     <div id="method-Ext.form.ComboBox-doQuery"></div>/**
1208      * Execute a query to filter the dropdown list.  Fires the {@link #beforequery} event prior to performing the
1209      * query allowing the query action to be canceled if needed.
1210      * @param {String} query The SQL query to execute
1211      * @param {Boolean} forceAll <tt>true</tt> to force the query to execute even if there are currently fewer
1212      * characters in the field than the minimum specified by the <tt>{@link #minChars}</tt> config option.  It
1213      * also clears any filter previously saved in the current store (defaults to <tt>false</tt>)
1214      */
1215     doQuery : function(q, forceAll){
1216         q = Ext.isEmpty(q) ? '' : q;
1217         var qe = {
1218             query: q,
1219             forceAll: forceAll,
1220             combo: this,
1221             cancel:false
1222         };
1223         if(this.fireEvent('beforequery', qe)===false || qe.cancel){
1224             return false;
1225         }
1226         q = qe.query;
1227         forceAll = qe.forceAll;
1228         if(forceAll === true || (q.length >= this.minChars)){
1229             if(this.lastQuery !== q){
1230                 this.lastQuery = q;
1231                 if(this.mode == 'local'){
1232                     this.selectedIndex = -1;
1233                     if(forceAll){
1234                         this.store.clearFilter();
1235                     }else{
1236                         this.store.filter(this.displayField, q);
1237                     }
1238                     this.onLoad();
1239                 }else{
1240                     this.store.baseParams[this.queryParam] = q;
1241                     this.store.load({
1242                         params: this.getParams(q)
1243                     });
1244                     this.expand();
1245                 }
1246             }else{
1247                 this.selectedIndex = -1;
1248                 this.onLoad();
1249             }
1250         }
1251     },
1252
1253     // private
1254     getParams : function(q){
1255         var p = {};
1256         //p[this.queryParam] = q;
1257         if(this.pageSize){
1258             p.start = 0;
1259             p.limit = this.pageSize;
1260         }
1261         return p;
1262     },
1263
1264     <div id="method-Ext.form.ComboBox-collapse"></div>/**
1265      * Hides the dropdown list if it is currently expanded. Fires the {@link #collapse} event on completion.
1266      */
1267     collapse : function(){
1268         if(!this.isExpanded()){
1269             return;
1270         }
1271         this.list.hide();
1272         Ext.getDoc().un('mousewheel', this.collapseIf, this);
1273         Ext.getDoc().un('mousedown', this.collapseIf, this);
1274         this.fireEvent('collapse', this);
1275     },
1276
1277     // private
1278     collapseIf : function(e){
1279         if(!this.isDestroyed && !e.within(this.wrap) && !e.within(this.list)){
1280             this.collapse();
1281         }
1282     },
1283
1284     <div id="method-Ext.form.ComboBox-expand"></div>/**
1285      * Expands the dropdown list if it is currently hidden. Fires the {@link #expand} event on completion.
1286      */
1287     expand : function(){
1288         if(this.isExpanded() || !this.hasFocus){
1289             return;
1290         }
1291
1292         if(this.title || this.pageSize){
1293             this.assetHeight = 0;
1294             if(this.title){
1295                 this.assetHeight += this.header.getHeight();
1296             }
1297             if(this.pageSize){
1298                 this.assetHeight += this.footer.getHeight();
1299             }
1300         }
1301
1302         if(this.bufferSize){
1303             this.doResize(this.bufferSize);
1304             delete this.bufferSize;
1305         }
1306         this.list.alignTo.apply(this.list, [this.el].concat(this.listAlign));
1307
1308         // zindex can change, re-check it and set it if necessary
1309         var listParent = Ext.getDom(this.getListParent() || Ext.getBody()),
1310             zindex = parseInt(Ext.fly(listParent).getStyle('z-index') ,10);
1311         if (!zindex){
1312             zindex = this.getParentZIndex();
1313         }
1314         if (zindex) {
1315             this.list.setZIndex(zindex + 5);
1316         }
1317         this.list.show();
1318         if(Ext.isGecko2){
1319             this.innerList.setOverflow('auto'); // necessary for FF 2.0/Mac
1320         }
1321         this.mon(Ext.getDoc(), {
1322             scope: this,
1323             mousewheel: this.collapseIf,
1324             mousedown: this.collapseIf
1325         });
1326         this.fireEvent('expand', this);
1327     },
1328
1329     <div id="method-Ext.form.ComboBox-onTriggerClick"></div>/**
1330      * @method onTriggerClick
1331      * @hide
1332      */
1333     // private
1334     // Implements the default empty TriggerField.onTriggerClick function
1335     onTriggerClick : function(){
1336         if(this.readOnly || this.disabled){
1337             return;
1338         }
1339         if(this.isExpanded()){
1340             this.collapse();
1341             this.el.focus();
1342         }else {
1343             this.onFocus({});
1344             if(this.triggerAction == 'all') {
1345                 this.doQuery(this.allQuery, true);
1346             } else {
1347                 this.doQuery(this.getRawValue());
1348             }
1349             this.el.focus();
1350         }
1351     }
1352
1353     <div id="method-Ext.form.ComboBox-autoSize"></div>/**
1354      * @hide
1355      * @method autoSize
1356      */
1357     <div id="cfg-Ext.form.ComboBox-grow"></div>/**
1358      * @cfg {Boolean} grow @hide
1359      */
1360     <div id="cfg-Ext.form.ComboBox-growMin"></div>/**
1361      * @cfg {Number} growMin @hide
1362      */
1363     <div id="cfg-Ext.form.ComboBox-growMax"></div>/**
1364      * @cfg {Number} growMax @hide
1365      */
1366
1367 });
1368 Ext.reg('combo', Ext.form.ComboBox);
1369 </pre>
1370 </body>
1371 </html>