Roo/form/ComboBox.js
[roojs1] / Roo / form / ComboBox.js
1 /*
2  * Based on:
3  * Ext JS Library 1.1.1
4  * Copyright(c) 2006-2007, Ext JS, LLC.
5  *
6  * Originally Released Under LGPL - original licence link has changed is not relivant.
7  *
8  * Fork - LGPL
9  * <script type="text/javascript">
10  */
11  
12
13 /**
14  * @class Roo.form.ComboBox
15  * @extends Roo.form.TriggerField
16  * A combobox control with support for autocomplete, remote-loading, paging and many other features.
17  * @constructor
18  * Create a new ComboBox.
19  * @param {Object} config Configuration options
20  */
21 Roo.form.ComboBox = function(config){
22     Roo.form.ComboBox.superclass.constructor.call(this, config);
23     this.addEvents({
24         /**
25          * @event expand
26          * Fires when the dropdown list is expanded
27              * @param {Roo.form.ComboBox} combo This combo box
28              */
29         'expand' : true,
30         /**
31          * @event collapse
32          * Fires when the dropdown list is collapsed
33              * @param {Roo.form.ComboBox} combo This combo box
34              */
35         'collapse' : true,
36         /**
37          * @event beforeselect
38          * Fires before a list item is selected. Return false to cancel the selection.
39              * @param {Roo.form.ComboBox} combo This combo box
40              * @param {Roo.data.Record} record The data record returned from the underlying store
41              * @param {Number} index The index of the selected item in the dropdown list
42              */
43         'beforeselect' : true,
44         /**
45          * @event select
46          * Fires when a list item is selected
47              * @param {Roo.form.ComboBox} combo This combo box
48              * @param {Roo.data.Record} record The data record returned from the underlying store (or false on clear)
49              * @param {Number} index The index of the selected item in the dropdown list
50              */
51         'select' : true,
52         /**
53          * @event beforequery
54          * Fires before all queries are processed. Return false to cancel the query or set cancel to true.
55          * The event object passed has these properties:
56              * @param {Roo.form.ComboBox} combo This combo box
57              * @param {String} query The query
58              * @param {Boolean} forceAll true to force "all" query
59              * @param {Boolean} cancel true to cancel the query
60              * @param {Object} e The query event object
61              */
62         'beforequery': true,
63          /**
64          * @event add
65          * Fires when the 'add' icon is pressed (add a listener to enable add button)
66              * @param {Roo.form.ComboBox} combo This combo box
67              */
68         'add' : true,
69         /**
70          * @event add
71          * Fires when the 'edit' icon is pressed (add a listener to enable add button)
72              * @param {Roo.form.ComboBox} combo This combo box
73              * @param {Roo.data.Record} record The data record returned from the underlying store (or false on clear)
74              */
75         'edit' : true
76         
77         
78     });
79     if(this.transform){
80         this.allowDomMove = false;
81         var s = Roo.getDom(this.transform);
82         if(!this.hiddenName){
83             this.hiddenName = s.name;
84         }
85         if(!this.store){
86             this.mode = 'local';
87             var d = [], opts = s.options;
88             for(var i = 0, len = opts.length;i < len; i++){
89                 var o = opts[i];
90                 var value = (Roo.isIE ? o.getAttributeNode('value').specified : o.hasAttribute('value')) ? o.value : o.text;
91                 if(o.selected) {
92                     this.value = value;
93                 }
94                 d.push([value, o.text]);
95             }
96             this.store = new Roo.data.SimpleStore({
97                 'id': 0,
98                 fields: ['value', 'text'],
99                 data : d
100             });
101             this.valueField = 'value';
102             this.displayField = 'text';
103         }
104         s.name = Roo.id(); // wipe out the name in case somewhere else they have a reference
105         if(!this.lazyRender){
106             this.target = true;
107             this.el = Roo.DomHelper.insertBefore(s, this.autoCreate || this.defaultAutoCreate);
108             s.parentNode.removeChild(s); // remove it
109             this.render(this.el.parentNode);
110         }else{
111             s.parentNode.removeChild(s); // remove it
112         }
113
114     }
115     if (this.store) {
116         this.store = Roo.factory(this.store, Roo.data);
117     }
118     
119     this.selectedIndex = -1;
120     if(this.mode == 'local'){
121         if(config.queryDelay === undefined){
122             this.queryDelay = 10;
123         }
124         if(config.minChars === undefined){
125             this.minChars = 0;
126         }
127     }
128 };
129
130 Roo.extend(Roo.form.ComboBox, Roo.form.TriggerField, {
131     /**
132      * @cfg {String/HTMLElement/Element} transform The id, DOM node or element of an existing select to convert to a ComboBox
133      */
134     /**
135      * @cfg {Boolean} lazyRender True to prevent the ComboBox from rendering until requested (should always be used when
136      * rendering into an Roo.Editor, defaults to false)
137      */
138     /**
139      * @cfg {Boolean/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to:
140      * {tag: "input", type: "text", size: "24", autocomplete: "off"})
141      */
142     /**
143      * @cfg {Roo.data.Store} store The data store to which this combo is bound (defaults to undefined)
144      */
145     /**
146      * @cfg {String} title If supplied, a header element is created containing this text and added into the top of
147      * the dropdown list (defaults to undefined, with no header element)
148      */
149
150      /**
151      * @cfg {String/Roo.Template} tpl The template to use to render the output
152      */
153      
154     // private
155     defaultAutoCreate : {tag: "input", type: "text", size: "24", autocomplete: "off"},
156     /**
157      * @cfg {Number} listWidth The width in pixels of the dropdown list (defaults to the width of the ComboBox field)
158      */
159     listWidth: undefined,
160     /**
161      * @cfg {String} displayField The underlying data field name to bind to this CombBox (defaults to undefined if
162      * mode = 'remote' or 'text' if mode = 'local')
163      */
164     displayField: undefined,
165     /**
166      * @cfg {String} valueField The underlying data value name to bind to this CombBox (defaults to undefined if
167      * mode = 'remote' or 'value' if mode = 'local'). 
168      * Note: use of a valueField requires the user make a selection
169      * in order for a value to be mapped.
170      */
171     valueField: undefined,
172     /**
173      * @cfg {String} hiddenName If specified, a hidden form field with this name is dynamically generated to store the
174      * field's data value (defaults to the underlying DOM element's name)
175      */
176     hiddenName: undefined,
177     /**
178      * @cfg {String} listClass CSS class to apply to the dropdown list element (defaults to '')
179      */
180     listClass: '',
181     /**
182      * @cfg {String} selectedClass CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')
183      */
184     selectedClass: 'x-combo-selected',
185     /**
186      * @cfg {String} triggerClass An additional CSS class used to style the trigger button.  The trigger will always get the
187      * class 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'
188      * which displays a downward arrow icon).
189      */
190     triggerClass : 'x-form-arrow-trigger',
191     /**
192      * @cfg {Boolean/String} shadow True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right
193      */
194     shadow:'sides',
195     /**
196      * @cfg {String} listAlign A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported
197      * anchor positions (defaults to 'tl-bl')
198      */
199     listAlign: 'tl-bl?',
200     /**
201      * @cfg {Number} maxHeight The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)
202      */
203     maxHeight: 300,
204     /**
205      * @cfg {String} triggerAction The action to execute when the trigger field is activated.  Use 'all' to run the
206      * query specified by the allQuery config option (defaults to 'query')
207      */
208     triggerAction: 'query',
209     /**
210      * @cfg {Number} minChars The minimum number of characters the user must type before autocomplete and typeahead activate
211      * (defaults to 4, does not apply if editable = false)
212      */
213     minChars : 4,
214     /**
215      * @cfg {Boolean} typeAhead True to populate and autoselect the remainder of the text being typed after a configurable
216      * delay (typeAheadDelay) if it matches a known value (defaults to false)
217      */
218     typeAhead: false,
219     /**
220      * @cfg {Number} queryDelay The length of time in milliseconds to delay between the start of typing and sending the
221      * query to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')
222      */
223     queryDelay: 500,
224     /**
225      * @cfg {Number} pageSize If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the
226      * filter queries will execute with page start and limit parameters.  Only applies when mode = 'remote' (defaults to 0)
227      */
228     pageSize: 0,
229     /**
230      * @cfg {Boolean} selectOnFocus True to select any existing text in the field immediately on focus.  Only applies
231      * when editable = true (defaults to false)
232      */
233     selectOnFocus:false,
234     /**
235      * @cfg {String} queryParam Name of the query as it will be passed on the querystring (defaults to 'query')
236      */
237     queryParam: 'query',
238     /**
239      * @cfg {String} loadingText The text to display in the dropdown list while data is loading.  Only applies
240      * when mode = 'remote' (defaults to 'Loading...')
241      */
242     loadingText: 'Loading...',
243     /**
244      * @cfg {Boolean} resizable True to add a resize handle to the bottom of the dropdown list (defaults to false)
245      */
246     resizable: false,
247     /**
248      * @cfg {Number} handleHeight The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)
249      */
250     handleHeight : 8,
251     /**
252      * @cfg {Boolean} editable False to prevent the user from typing text directly into the field, just like a
253      * traditional select (defaults to true)
254      */
255     editable: true,
256     /**
257      * @cfg {String} allQuery The text query to send to the server to return all records for the list with no filtering (defaults to '')
258      */
259     allQuery: '',
260     /**
261      * @cfg {String} mode Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)
262      */
263     mode: 'remote',
264     /**
265      * @cfg {Number} minListWidth The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if
266      * listWidth has a higher value)
267      */
268     minListWidth : 70,
269     /**
270      * @cfg {Boolean} forceSelection True to restrict the selected value to one of the values in the list, false to
271      * allow the user to set arbitrary text into the field (defaults to false)
272      */
273     forceSelection:false,
274     /**
275      * @cfg {Number} typeAheadDelay The length of time in milliseconds to wait until the typeahead text is displayed
276      * if typeAhead = true (defaults to 250)
277      */
278     typeAheadDelay : 250,
279     /**
280      * @cfg {String} valueNotFoundText When using a name/value combo, if the value passed to setValue is not found in
281      * the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)
282      */
283     valueNotFoundText : undefined,
284     /**
285      * @cfg {bool} blockFocus Prevents all focus calls, so it can work with things like HTML edtor bar
286      */
287     blockFocus : false,
288     
289     /**
290      * @cfg {bool} disableClear Disable showing of clear button.
291      */
292     disableClear : false,
293     
294     // private
295     onRender : function(ct, position){
296         Roo.form.ComboBox.superclass.onRender.call(this, ct, position);
297         if(this.hiddenName){
298             this.hiddenField = this.el.insertSibling({tag:'input', type:'hidden', name: this.hiddenName, id:  (this.hiddenId||this.hiddenName)},
299                     'before', true);
300             this.hiddenField.value =
301                 this.hiddenValue !== undefined ? this.hiddenValue :
302                 this.value !== undefined ? this.value : '';
303
304             // prevent input submission
305             this.el.dom.removeAttribute('name');
306         }
307         if(Roo.isGecko){
308             this.el.dom.setAttribute('autocomplete', 'off');
309         }
310
311         var cls = 'x-combo-list';
312
313         this.list = new Roo.Layer({
314             shadow: this.shadow, cls: [cls, this.listClass].join(' '), constrain:false
315         });
316
317         var lw = this.listWidth || Math.max(this.wrap.getWidth(), this.minListWidth);
318         this.list.setWidth(lw);
319         this.list.swallowEvent('mousewheel');
320         this.assetHeight = 0;
321
322         if(this.title){
323             this.header = this.list.createChild({cls:cls+'-hd', html: this.title});
324             this.assetHeight += this.header.getHeight();
325         }
326
327         this.innerList = this.list.createChild({cls:cls+'-inner'});
328         this.innerList.on('mouseover', this.onViewOver, this);
329         this.innerList.on('mousemove', this.onViewMove, this);
330         this.innerList.setWidth(lw - this.list.getFrameWidth('lr'));
331         
332         if(this.allowBlank && !this.pageSize && !this.disableClear){
333             this.footer = this.list.createChild({cls:cls+'-ft'});
334             this.pageTb = new Roo.Toolbar(this.footer);
335            
336         }
337         if(this.pageSize){
338             this.footer = this.list.createChild({cls:cls+'-ft'});
339             this.pageTb = new Roo.PagingToolbar(this.footer, this.store,
340                     {pageSize: this.pageSize});
341             
342         }
343         
344         if (this.pageTb && this.allowBlank && !this.disableClear) {
345             var _this = this;
346             this.pageTb.add(new Roo.Toolbar.Fill(), {
347                 cls: 'x-btn-icon x-btn-clear',
348                 text: '&#160;',
349                 handler: function()
350                 {
351                     _this.collapse();
352                     _this.clearValue();
353                     _this.onSelect(false, -1);
354                 }
355             });
356         }
357         if (this.footer) {
358             this.assetHeight += this.footer.getHeight();
359         }
360         
361
362         if(!this.tpl){
363             this.tpl = '<div class="'+cls+'-item">{' + this.displayField + '}</div>';
364         }
365
366         this.view = new Roo.View(this.innerList, this.tpl, {
367             singleSelect:true, store: this.store, selectedClass: this.selectedClass
368         });
369
370         this.view.on('click', this.onViewClick, this);
371
372         this.store.on('beforeload', this.onBeforeLoad, this);
373         this.store.on('load', this.onLoad, this);
374         this.store.on('loadexception', this.collapse, this);
375
376         if(this.resizable){
377             this.resizer = new Roo.Resizable(this.list,  {
378                pinned:true, handles:'se'
379             });
380             this.resizer.on('resize', function(r, w, h){
381                 this.maxHeight = h-this.handleHeight-this.list.getFrameWidth('tb')-this.assetHeight;
382                 this.listWidth = w;
383                 this.innerList.setWidth(w - this.list.getFrameWidth('lr'));
384                 this.restrictHeight();
385             }, this);
386             this[this.pageSize?'footer':'innerList'].setStyle('margin-bottom', this.handleHeight+'px');
387         }
388         if(!this.editable){
389             this.editable = true;
390             this.setEditable(false);
391         }
392         
393         
394         
395         this.addicon = this.wrap.createChild(
396             {tag: 'img', src: Ext.BLANK_IMAGE_URL, cls: 'x-form-combo-add' });  
397         var _t = this;
398         this.adder.on('click', function(e) {
399             this.fireEvent('adderclick', this, e);
400         }, this);
401         
402         
403         
404         
405         
406     },
407
408     // private
409     initEvents : function(){
410         Roo.form.ComboBox.superclass.initEvents.call(this);
411
412         this.keyNav = new Roo.KeyNav(this.el, {
413             "up" : function(e){
414                 this.inKeyMode = true;
415                 this.selectPrev();
416             },
417
418             "down" : function(e){
419                 if(!this.isExpanded()){
420                     this.onTriggerClick();
421                 }else{
422                     this.inKeyMode = true;
423                     this.selectNext();
424                 }
425             },
426
427             "enter" : function(e){
428                 this.onViewClick();
429                 //return true;
430             },
431
432             "esc" : function(e){
433                 this.collapse();
434             },
435
436             "tab" : function(e){
437                 this.onViewClick(false);
438                 return true;
439             },
440
441             scope : this,
442
443             doRelay : function(foo, bar, hname){
444                 if(hname == 'down' || this.scope.isExpanded()){
445                    return Roo.KeyNav.prototype.doRelay.apply(this, arguments);
446                 }
447                 return true;
448             },
449
450             forceKeyDown: true
451         });
452         this.queryDelay = Math.max(this.queryDelay || 10,
453                 this.mode == 'local' ? 10 : 250);
454         this.dqTask = new Roo.util.DelayedTask(this.initQuery, this);
455         if(this.typeAhead){
456             this.taTask = new Roo.util.DelayedTask(this.onTypeAhead, this);
457         }
458         if(this.editable !== false){
459             this.el.on("keyup", this.onKeyUp, this);
460         }
461         if(this.forceSelection){
462             this.on('blur', this.doForce, this);
463         }
464     },
465
466     onDestroy : function(){
467         if(this.view){
468             this.view.setStore(null);
469             this.view.el.removeAllListeners();
470             this.view.el.remove();
471             this.view.purgeListeners();
472         }
473         if(this.list){
474             this.list.destroy();
475         }
476         if(this.store){
477             this.store.un('beforeload', this.onBeforeLoad, this);
478             this.store.un('load', this.onLoad, this);
479             this.store.un('loadexception', this.collapse, this);
480         }
481         Roo.form.ComboBox.superclass.onDestroy.call(this);
482     },
483
484     // private
485     fireKey : function(e){
486         if(e.isNavKeyPress() && !this.list.isVisible()){
487             this.fireEvent("specialkey", this, e);
488         }
489     },
490
491     // private
492     onResize: function(w, h){
493         Roo.form.ComboBox.superclass.onResize.apply(this, arguments);
494         if(this.list && this.listWidth === undefined){
495             var lw = Math.max(w, this.minListWidth);
496             this.list.setWidth(lw);
497             this.innerList.setWidth(lw - this.list.getFrameWidth('lr'));
498         }
499     },
500
501     /**
502      * Allow or prevent the user from directly editing the field text.  If false is passed,
503      * the user will only be able to select from the items defined in the dropdown list.  This method
504      * is the runtime equivalent of setting the 'editable' config option at config time.
505      * @param {Boolean} value True to allow the user to directly edit the field text
506      */
507     setEditable : function(value){
508         if(value == this.editable){
509             return;
510         }
511         this.editable = value;
512         if(!value){
513             this.el.dom.setAttribute('readOnly', true);
514             this.el.on('mousedown', this.onTriggerClick,  this);
515             this.el.addClass('x-combo-noedit');
516         }else{
517             this.el.dom.setAttribute('readOnly', false);
518             this.el.un('mousedown', this.onTriggerClick,  this);
519             this.el.removeClass('x-combo-noedit');
520         }
521     },
522
523     // private
524     onBeforeLoad : function(){
525         if(!this.hasFocus){
526             return;
527         }
528         this.innerList.update(this.loadingText ?
529                '<div class="loading-indicator">'+this.loadingText+'</div>' : '');
530         this.restrictHeight();
531         this.selectedIndex = -1;
532     },
533
534     // private
535     onLoad : function(){
536         if(!this.hasFocus){
537             return;
538         }
539         if(this.store.getCount() > 0){
540             this.expand();
541             this.restrictHeight();
542             if(this.lastQuery == this.allQuery){
543                 if(this.editable){
544                     this.el.dom.select();
545                 }
546                 if(!this.selectByValue(this.value, true)){
547                     this.select(0, true);
548                 }
549             }else{
550                 this.selectNext();
551                 if(this.typeAhead && this.lastKey != Roo.EventObject.BACKSPACE && this.lastKey != Roo.EventObject.DELETE){
552                     this.taTask.delay(this.typeAheadDelay);
553                 }
554             }
555         }else{
556             this.onEmptyResults();
557         }
558         //this.el.focus();
559     },
560
561     // private
562     onTypeAhead : function(){
563         if(this.store.getCount() > 0){
564             var r = this.store.getAt(0);
565             var newValue = r.data[this.displayField];
566             var len = newValue.length;
567             var selStart = this.getRawValue().length;
568             if(selStart != len){
569                 this.setRawValue(newValue);
570                 this.selectText(selStart, newValue.length);
571             }
572         }
573     },
574
575     // private
576     onSelect : function(record, index){
577         if(this.fireEvent('beforeselect', this, record, index) !== false){
578             this.setFromData(index > -1 ? record.data : false);
579             this.collapse();
580             this.fireEvent('select', this, record, index);
581         }
582     },
583
584     /**
585      * Returns the currently selected field value or empty string if no value is set.
586      * @return {String} value The selected value
587      */
588     getValue : function(){
589         if(this.valueField){
590             return typeof this.value != 'undefined' ? this.value : '';
591         }else{
592             return Roo.form.ComboBox.superclass.getValue.call(this);
593         }
594     },
595
596     /**
597      * Clears any text/value currently set in the field
598      */
599     clearValue : function(){
600         if(this.hiddenField){
601             this.hiddenField.value = '';
602         }
603         this.value = '';
604         this.setRawValue('');
605         this.lastSelectionText = '';
606         this.applyEmptyText();
607     },
608
609     /**
610      * Sets the specified value into the field.  If the value finds a match, the corresponding record text
611      * will be displayed in the field.  If the value does not match the data value of an existing item,
612      * and the valueNotFoundText config option is defined, it will be displayed as the default field text.
613      * Otherwise the field will be blank (although the value will still be set).
614      * @param {String} value The value to match
615      */
616     setValue : function(v){
617         var text = v;
618         if(this.valueField){
619             var r = this.findRecord(this.valueField, v);
620             if(r){
621                 text = r.data[this.displayField];
622             }else if(this.valueNotFoundText !== undefined){
623                 text = this.valueNotFoundText;
624             }
625         }
626         this.lastSelectionText = text;
627         if(this.hiddenField){
628             this.hiddenField.value = v;
629         }
630         Roo.form.ComboBox.superclass.setValue.call(this, text);
631         this.value = v;
632     },
633     /**
634      * @property {Object} the last set data for the element
635      */
636     
637     lastData : false,
638     /**
639      * Sets the value of the field based on a object which is related to the record format for the store.
640      * @param {Object} value the value to set as. or false on reset?
641      */
642     setFromData : function(o){
643         var dv = ''; // display value
644         var vv = ''; // value value..
645         this.lastData = o;
646         if (this.displayField) {
647             dv = !o || typeof(o[this.displayField]) == 'undefined' ? '' : o[this.displayField];
648         } else {
649             // this is an error condition!!!
650             console.log('no value field set for '+ this.name);
651         }
652         
653         if(this.valueField){
654             vv = !o || typeof(o[this.valueField]) == 'undefined' ? dv : o[this.valueField];
655         }
656         if(this.hiddenField){
657             this.hiddenField.value = vv;
658             
659             this.lastSelectionText = dv;
660             Roo.form.ComboBox.superclass.setValue.call(this, dv);
661             this.value = vv;
662             return;
663         }
664         // no hidden field.. - we store the value in 'value', but still display
665         // display field!!!!
666         this.lastSelectionText = dv;
667         Roo.form.ComboBox.superclass.setValue.call(this, dv);
668         this.value = vv;
669         
670         
671     },
672     // private
673     reset : function(){
674         // overridden so that last data is reset..
675         this.setValue(this.originalValue);
676         this.clearInvalid();
677         this.lastData = false;
678     },
679     // private
680     findRecord : function(prop, value){
681         var record;
682         if(this.store.getCount() > 0){
683             this.store.each(function(r){
684                 if(r.data[prop] == value){
685                     record = r;
686                     return false;
687                 }
688             });
689         }
690         return record;
691     },
692
693     // private
694     onViewMove : function(e, t){
695         this.inKeyMode = false;
696     },
697
698     // private
699     onViewOver : function(e, t){
700         if(this.inKeyMode){ // prevent key nav and mouse over conflicts
701             return;
702         }
703         var item = this.view.findItemFromChild(t);
704         if(item){
705             var index = this.view.indexOf(item);
706             this.select(index, false);
707         }
708     },
709
710     // private
711     onViewClick : function(doFocus){
712         var index = this.view.getSelectedIndexes()[0];
713         var r = this.store.getAt(index);
714         if(r){
715             this.onSelect(r, index);
716         }
717         if(doFocus !== false && !this.blockFocus){
718             this.el.focus();
719         }
720     },
721
722     // private
723     restrictHeight : function(){
724         this.innerList.dom.style.height = '';
725         var inner = this.innerList.dom;
726         var h = Math.max(inner.clientHeight, inner.offsetHeight, inner.scrollHeight);
727         this.innerList.setHeight(h < this.maxHeight ? 'auto' : this.maxHeight);
728         this.list.beginUpdate();
729         this.list.setHeight(this.innerList.getHeight()+this.list.getFrameWidth('tb')+(this.resizable?this.handleHeight:0)+this.assetHeight);
730         this.list.alignTo(this.el, this.listAlign);
731         this.list.endUpdate();
732     },
733
734     // private
735     onEmptyResults : function(){
736         this.collapse();
737     },
738
739     /**
740      * Returns true if the dropdown list is expanded, else false.
741      */
742     isExpanded : function(){
743         return this.list.isVisible();
744     },
745
746     /**
747      * Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.
748      * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
749      * @param {String} value The data value of the item to select
750      * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
751      * selected item if it is not currently in view (defaults to true)
752      * @return {Boolean} True if the value matched an item in the list, else false
753      */
754     selectByValue : function(v, scrollIntoView){
755         if(v !== undefined && v !== null){
756             var r = this.findRecord(this.valueField || this.displayField, v);
757             if(r){
758                 this.select(this.store.indexOf(r), scrollIntoView);
759                 return true;
760             }
761         }
762         return false;
763     },
764
765     /**
766      * Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.
767      * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
768      * @param {Number} index The zero-based index of the list item to select
769      * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
770      * selected item if it is not currently in view (defaults to true)
771      */
772     select : function(index, scrollIntoView){
773         this.selectedIndex = index;
774         this.view.select(index);
775         if(scrollIntoView !== false){
776             var el = this.view.getNode(index);
777             if(el){
778                 this.innerList.scrollChildIntoView(el, false);
779             }
780         }
781     },
782
783     // private
784     selectNext : function(){
785         var ct = this.store.getCount();
786         if(ct > 0){
787             if(this.selectedIndex == -1){
788                 this.select(0);
789             }else if(this.selectedIndex < ct-1){
790                 this.select(this.selectedIndex+1);
791             }
792         }
793     },
794
795     // private
796     selectPrev : function(){
797         var ct = this.store.getCount();
798         if(ct > 0){
799             if(this.selectedIndex == -1){
800                 this.select(0);
801             }else if(this.selectedIndex != 0){
802                 this.select(this.selectedIndex-1);
803             }
804         }
805     },
806
807     // private
808     onKeyUp : function(e){
809         if(this.editable !== false && !e.isSpecialKey()){
810             this.lastKey = e.getKey();
811             this.dqTask.delay(this.queryDelay);
812         }
813     },
814
815     // private
816     validateBlur : function(){
817         return !this.list || !this.list.isVisible();   
818     },
819
820     // private
821     initQuery : function(){
822         this.doQuery(this.getRawValue());
823     },
824
825     // private
826     doForce : function(){
827         if(this.el.dom.value.length > 0){
828             this.el.dom.value =
829                 this.lastSelectionText === undefined ? '' : this.lastSelectionText;
830             this.applyEmptyText();
831         }
832     },
833
834     /**
835      * Execute a query to filter the dropdown list.  Fires the beforequery event prior to performing the
836      * query allowing the query action to be canceled if needed.
837      * @param {String} query The SQL query to execute
838      * @param {Boolean} forceAll True to force the query to execute even if there are currently fewer characters
839      * in the field than the minimum specified by the minChars config option.  It also clears any filter previously
840      * saved in the current store (defaults to false)
841      */
842     doQuery : function(q, forceAll){
843         if(q === undefined || q === null){
844             q = '';
845         }
846         var qe = {
847             query: q,
848             forceAll: forceAll,
849             combo: this,
850             cancel:false
851         };
852         if(this.fireEvent('beforequery', qe)===false || qe.cancel){
853             return false;
854         }
855         q = qe.query;
856         forceAll = qe.forceAll;
857         if(forceAll === true || (q.length >= this.minChars)){
858             if(this.lastQuery != q){
859                 this.lastQuery = q;
860                 if(this.mode == 'local'){
861                     this.selectedIndex = -1;
862                     if(forceAll){
863                         this.store.clearFilter();
864                     }else{
865                         this.store.filter(this.displayField, q);
866                     }
867                     this.onLoad();
868                 }else{
869                     this.store.baseParams[this.queryParam] = q;
870                     this.store.load({
871                         params: this.getParams(q)
872                     });
873                     this.expand();
874                 }
875             }else{
876                 this.selectedIndex = -1;
877                 this.onLoad();   
878             }
879         }
880     },
881
882     // private
883     getParams : function(q){
884         var p = {};
885         //p[this.queryParam] = q;
886         if(this.pageSize){
887             p.start = 0;
888             p.limit = this.pageSize;
889         }
890         return p;
891     },
892
893     /**
894      * Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.
895      */
896     collapse : function(){
897         if(!this.isExpanded()){
898             return;
899         }
900         this.list.hide();
901         Roo.get(document).un('mousedown', this.collapseIf, this);
902         Roo.get(document).un('mousewheel', this.collapseIf, this);
903         this.fireEvent('collapse', this);
904     },
905
906     // private
907     collapseIf : function(e){
908         if(!e.within(this.wrap) && !e.within(this.list)){
909             this.collapse();
910         }
911     },
912
913     /**
914      * Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.
915      */
916     expand : function(){
917         if(this.isExpanded() || !this.hasFocus){
918             return;
919         }
920         this.list.alignTo(this.el, this.listAlign);
921         this.list.show();
922         Roo.get(document).on('mousedown', this.collapseIf, this);
923         Roo.get(document).on('mousewheel', this.collapseIf, this);
924         this.fireEvent('expand', this);
925     },
926
927     // private
928     // Implements the default empty TriggerField.onTriggerClick function
929     onTriggerClick : function(){
930         if(this.disabled){
931             return;
932         }
933         if(this.isExpanded()){
934             this.collapse();
935             if (!this.blockFocus) {
936                 this.el.focus();
937             }
938             
939         }else {
940             this.hasFocus = true;
941             if(this.triggerAction == 'all') {
942                 this.doQuery(this.allQuery, true);
943             } else {
944                 this.doQuery(this.getRawValue());
945             }
946             if (!this.blockFocus) {
947                 this.el.focus();
948             }
949         }
950     }
951
952     /** 
953     * @cfg {Boolean} grow 
954     * @hide 
955     */
956     /** 
957     * @cfg {Number} growMin 
958     * @hide 
959     */
960     /** 
961     * @cfg {Number} growMax 
962     * @hide 
963     */
964     /**
965      * @hide
966      * @method autoSize
967      */
968 });