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