4 * Copyright(c) 2006-2007, Ext JS, LLC.
6 * Originally Released Under LGPL - original licence link has changed is not relivant.
9 * <script type="text/javascript">
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.
18 * Create a new ComboBox.
19 * @param {Object} config Configuration options
21 Roo.form.ComboBox = function(config){
22 Roo.form.ComboBox.superclass.constructor.call(this, config);
26 * Fires when the dropdown list is expanded
27 * @param {Roo.form.ComboBox} combo This combo box
32 * Fires when the dropdown list is collapsed
33 * @param {Roo.form.ComboBox} combo This combo box
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
43 'beforeselect' : true,
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
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
65 * Fires when the 'add' icon is pressed (add a listener to enable add button)
66 * @param {Roo.form.ComboBox} combo This combo box
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|false} record The data record returned from the underlying store (or false on nothing selected)
80 this.allowDomMove = false;
81 var s = Roo.getDom(this.transform);
83 this.hiddenName = s.name;
87 var d = [], opts = s.options;
88 for(var i = 0, len = opts.length;i < len; i++){
90 var value = (Roo.isIE ? o.getAttributeNode('value').specified : o.hasAttribute('value')) ? o.value : o.text;
94 d.push([value, o.text]);
96 this.store = new Roo.data.SimpleStore({
98 fields: ['value', 'text'],
101 this.valueField = 'value';
102 this.displayField = 'text';
104 s.name = Roo.id(); // wipe out the name in case somewhere else they have a reference
105 if(!this.lazyRender){
107 this.el = Roo.DomHelper.insertBefore(s, this.autoCreate || this.defaultAutoCreate);
108 s.parentNode.removeChild(s); // remove it
109 this.render(this.el.parentNode);
111 s.parentNode.removeChild(s); // remove it
116 this.store = Roo.factory(this.store, Roo.data);
119 this.selectedIndex = -1;
120 if(this.mode == 'local'){
121 if(config.queryDelay === undefined){
122 this.queryDelay = 10;
124 if(config.minChars === undefined){
130 Roo.extend(Roo.form.ComboBox, Roo.form.TriggerField, {
132 * @cfg {String/HTMLElement/Element} transform The id, DOM node or element of an existing select to convert to a ComboBox
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)
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"})
143 * @cfg {Roo.data.Store} store The data store to which this combo is bound (defaults to undefined)
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)
151 * @cfg {String/Roo.Template} tpl The template to use to render the output
155 defaultAutoCreate : {tag: "input", type: "text", size: "24", autocomplete: "off"},
157 * @cfg {Number} listWidth The width in pixels of the dropdown list (defaults to the width of the ComboBox field)
159 listWidth: undefined,
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')
164 displayField: undefined,
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.
171 valueField: undefined,
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)
176 hiddenName: undefined,
178 * @cfg {String} listClass CSS class to apply to the dropdown list element (defaults to '')
182 * @cfg {String} selectedClass CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')
184 selectedClass: 'x-combo-selected',
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).
190 triggerClass : 'x-form-arrow-trigger',
192 * @cfg {Boolean/String} shadow True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right
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')
201 * @cfg {Number} maxHeight The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)
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')
208 triggerAction: 'query',
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)
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)
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')
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)
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)
235 * @cfg {String} queryParam Name of the query as it will be passed on the querystring (defaults to 'query')
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...')
242 loadingText: 'Loading...',
244 * @cfg {Boolean} resizable True to add a resize handle to the bottom of the dropdown list (defaults to false)
248 * @cfg {Number} handleHeight The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)
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)
257 * @cfg {String} allQuery The text query to send to the server to return all records for the list with no filtering (defaults to '')
261 * @cfg {String} mode Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)
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)
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)
273 forceSelection:false,
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)
278 typeAheadDelay : 250,
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)
283 valueNotFoundText : undefined,
285 * @cfg {bool} blockFocus Prevents all focus calls, so it can work with things like HTML edtor bar
290 * @cfg {bool} disableClear Disable showing of clear button.
292 disableClear : false,
300 onRender : function(ct, position){
301 Roo.form.ComboBox.superclass.onRender.call(this, ct, position);
303 this.hiddenField = this.el.insertSibling({tag:'input', type:'hidden', name: this.hiddenName, id: (this.hiddenId||this.hiddenName)},
305 this.hiddenField.value =
306 this.hiddenValue !== undefined ? this.hiddenValue :
307 this.value !== undefined ? this.value : '';
309 // prevent input submission
310 this.el.dom.removeAttribute('name');
313 this.el.dom.setAttribute('autocomplete', 'off');
316 var cls = 'x-combo-list';
318 this.list = new Roo.Layer({
319 shadow: this.shadow, cls: [cls, this.listClass].join(' '), constrain:false
322 var lw = this.listWidth || Math.max(this.wrap.getWidth(), this.minListWidth);
323 this.list.setWidth(lw);
324 this.list.swallowEvent('mousewheel');
325 this.assetHeight = 0;
328 this.header = this.list.createChild({cls:cls+'-hd', html: this.title});
329 this.assetHeight += this.header.getHeight();
332 this.innerList = this.list.createChild({cls:cls+'-inner'});
333 this.innerList.on('mouseover', this.onViewOver, this);
334 this.innerList.on('mousemove', this.onViewMove, this);
335 this.innerList.setWidth(lw - this.list.getFrameWidth('lr'));
337 if(this.allowBlank && !this.pageSize && !this.disableClear){
338 this.footer = this.list.createChild({cls:cls+'-ft'});
339 this.pageTb = new Roo.Toolbar(this.footer);
343 this.footer = this.list.createChild({cls:cls+'-ft'});
344 this.pageTb = new Roo.PagingToolbar(this.footer, this.store,
345 {pageSize: this.pageSize});
349 if (this.pageTb && this.allowBlank && !this.disableClear) {
351 this.pageTb.add(new Roo.Toolbar.Fill(), {
352 cls: 'x-btn-icon x-btn-clear',
358 _this.onSelect(false, -1);
363 this.assetHeight += this.footer.getHeight();
368 this.tpl = '<div class="'+cls+'-item">{' + this.displayField + '}</div>';
371 this.view = new Roo.View(this.innerList, this.tpl, {
372 singleSelect:true, store: this.store, selectedClass: this.selectedClass
375 this.view.on('click', this.onViewClick, this);
377 this.store.on('beforeload', this.onBeforeLoad, this);
378 this.store.on('load', this.onLoad, this);
379 this.store.on('loadexception', this.collapse, this);
382 this.resizer = new Roo.Resizable(this.list, {
383 pinned:true, handles:'se'
385 this.resizer.on('resize', function(r, w, h){
386 this.maxHeight = h-this.handleHeight-this.list.getFrameWidth('tb')-this.assetHeight;
388 this.innerList.setWidth(w - this.list.getFrameWidth('lr'));
389 this.restrictHeight();
391 this[this.pageSize?'footer':'innerList'].setStyle('margin-bottom', this.handleHeight+'px');
394 this.editable = true;
395 this.setEditable(false);
399 if (typeof(this.events.add.listeners) != 'undefined') {
401 this.addicon = this.wrap.createChild(
402 {tag: 'img', src: Roo.BLANK_IMAGE_URL, cls: 'x-form-combo-add' });
404 this.addicon.on('click', function(e) {
405 this.fireEvent('add', this);
408 if (typeof(this.events.edit.listeners) != 'undefined') {
410 this.editicon = this.wrap.createChild(
411 {tag: 'img', src: Roo.BLANK_IMAGE_URL, cls: 'x-form-combo-edit' });
413 this.editicon.setStyle('margin-left', '40px');
415 this.editicon.on('click', function(e) {
417 // we fire even if inothing is selected..
418 this.fireEvent('edit', this, this.lastData );
428 initEvents : function(){
429 Roo.form.ComboBox.superclass.initEvents.call(this);
431 this.keyNav = new Roo.KeyNav(this.el, {
433 this.inKeyMode = true;
437 "down" : function(e){
438 if(!this.isExpanded()){
439 this.onTriggerClick();
441 this.inKeyMode = true;
446 "enter" : function(e){
456 this.onViewClick(false);
462 doRelay : function(foo, bar, hname){
463 if(hname == 'down' || this.scope.isExpanded()){
464 return Roo.KeyNav.prototype.doRelay.apply(this, arguments);
471 this.queryDelay = Math.max(this.queryDelay || 10,
472 this.mode == 'local' ? 10 : 250);
473 this.dqTask = new Roo.util.DelayedTask(this.initQuery, this);
475 this.taTask = new Roo.util.DelayedTask(this.onTypeAhead, this);
477 if(this.editable !== false){
478 this.el.on("keyup", this.onKeyUp, this);
480 if(this.forceSelection){
481 this.on('blur', this.doForce, this);
485 onDestroy : function(){
487 this.view.setStore(null);
488 this.view.el.removeAllListeners();
489 this.view.el.remove();
490 this.view.purgeListeners();
496 this.store.un('beforeload', this.onBeforeLoad, this);
497 this.store.un('load', this.onLoad, this);
498 this.store.un('loadexception', this.collapse, this);
500 Roo.form.ComboBox.superclass.onDestroy.call(this);
504 fireKey : function(e){
505 if(e.isNavKeyPress() && !this.list.isVisible()){
506 this.fireEvent("specialkey", this, e);
511 onResize: function(w, h){
512 Roo.form.ComboBox.superclass.onResize.apply(this, arguments);
513 if(this.list && this.listWidth === undefined){
514 var lw = Math.max(w, this.minListWidth);
515 this.list.setWidth(lw);
516 this.innerList.setWidth(lw - this.list.getFrameWidth('lr'));
519 if(typeof w == 'number'){
520 var tw = this.trigger.getWidth();
521 tw += this.addicon ? this.addicon.getWidth() : 0;
522 tw += this.editicon ? this.editicon.getWidth() : 0;
524 this.el.setWidth( this.adjustWidth('input', x));
526 this.trigger.setStyle('left', x+'px');
533 * Allow or prevent the user from directly editing the field text. If false is passed,
534 * the user will only be able to select from the items defined in the dropdown list. This method
535 * is the runtime equivalent of setting the 'editable' config option at config time.
536 * @param {Boolean} value True to allow the user to directly edit the field text
538 setEditable : function(value){
539 if(value == this.editable){
542 this.editable = value;
544 this.el.dom.setAttribute('readOnly', true);
545 this.el.on('mousedown', this.onTriggerClick, this);
546 this.el.addClass('x-combo-noedit');
548 this.el.dom.setAttribute('readOnly', false);
549 this.el.un('mousedown', this.onTriggerClick, this);
550 this.el.removeClass('x-combo-noedit');
555 onBeforeLoad : function(){
559 this.innerList.update(this.loadingText ?
560 '<div class="loading-indicator">'+this.loadingText+'</div>' : '');
561 this.restrictHeight();
562 this.selectedIndex = -1;
570 if(this.store.getCount() > 0){
572 this.restrictHeight();
573 if(this.lastQuery == this.allQuery){
575 this.el.dom.select();
577 if(!this.selectByValue(this.value, true)){
578 this.select(0, true);
582 if(this.typeAhead && this.lastKey != Roo.EventObject.BACKSPACE && this.lastKey != Roo.EventObject.DELETE){
583 this.taTask.delay(this.typeAheadDelay);
587 this.onEmptyResults();
593 onTypeAhead : function(){
594 if(this.store.getCount() > 0){
595 var r = this.store.getAt(0);
596 var newValue = r.data[this.displayField];
597 var len = newValue.length;
598 var selStart = this.getRawValue().length;
600 this.setRawValue(newValue);
601 this.selectText(selStart, newValue.length);
607 onSelect : function(record, index){
608 if(this.fireEvent('beforeselect', this, record, index) !== false){
609 this.setFromData(index > -1 ? record.data : false);
611 this.fireEvent('select', this, record, index);
616 * Returns the currently selected field value or empty string if no value is set.
617 * @return {String} value The selected value
619 getValue : function(){
621 return typeof this.value != 'undefined' ? this.value : '';
623 return Roo.form.ComboBox.superclass.getValue.call(this);
628 * Clears any text/value currently set in the field
630 clearValue : function(){
631 if(this.hiddenField){
632 this.hiddenField.value = '';
635 this.setRawValue('');
636 this.lastSelectionText = '';
637 this.applyEmptyText();
641 * Sets the specified value into the field. If the value finds a match, the corresponding record text
642 * will be displayed in the field. If the value does not match the data value of an existing item,
643 * and the valueNotFoundText config option is defined, it will be displayed as the default field text.
644 * Otherwise the field will be blank (although the value will still be set).
645 * @param {String} value The value to match
647 setValue : function(v){
650 var r = this.findRecord(this.valueField, v);
652 text = r.data[this.displayField];
653 }else if(this.valueNotFoundText !== undefined){
654 text = this.valueNotFoundText;
657 this.lastSelectionText = text;
658 if(this.hiddenField){
659 this.hiddenField.value = v;
661 Roo.form.ComboBox.superclass.setValue.call(this, text);
665 * @property {Object} the last set data for the element
670 * Sets the value of the field based on a object which is related to the record format for the store.
671 * @param {Object} value the value to set as. or false on reset?
673 setFromData : function(o){
674 var dv = ''; // display value
675 var vv = ''; // value value..
677 if (this.displayField) {
678 dv = !o || typeof(o[this.displayField]) == 'undefined' ? '' : o[this.displayField];
680 // this is an error condition!!!
681 console.log('no value field set for '+ this.name);
685 vv = !o || typeof(o[this.valueField]) == 'undefined' ? dv : o[this.valueField];
687 if(this.hiddenField){
688 this.hiddenField.value = vv;
690 this.lastSelectionText = dv;
691 Roo.form.ComboBox.superclass.setValue.call(this, dv);
695 // no hidden field.. - we store the value in 'value', but still display
697 this.lastSelectionText = dv;
698 Roo.form.ComboBox.superclass.setValue.call(this, dv);
705 // overridden so that last data is reset..
706 this.setValue(this.originalValue);
708 this.lastData = false;
711 findRecord : function(prop, value){
713 if(this.store.getCount() > 0){
714 this.store.each(function(r){
715 if(r.data[prop] == value){
725 onViewMove : function(e, t){
726 this.inKeyMode = false;
730 onViewOver : function(e, t){
731 if(this.inKeyMode){ // prevent key nav and mouse over conflicts
734 var item = this.view.findItemFromChild(t);
736 var index = this.view.indexOf(item);
737 this.select(index, false);
742 onViewClick : function(doFocus){
743 var index = this.view.getSelectedIndexes()[0];
744 var r = this.store.getAt(index);
746 this.onSelect(r, index);
748 if(doFocus !== false && !this.blockFocus){
754 restrictHeight : function(){
755 this.innerList.dom.style.height = '';
756 var inner = this.innerList.dom;
757 var h = Math.max(inner.clientHeight, inner.offsetHeight, inner.scrollHeight);
758 this.innerList.setHeight(h < this.maxHeight ? 'auto' : this.maxHeight);
759 this.list.beginUpdate();
760 this.list.setHeight(this.innerList.getHeight()+this.list.getFrameWidth('tb')+(this.resizable?this.handleHeight:0)+this.assetHeight);
761 this.list.alignTo(this.el, this.listAlign);
762 this.list.endUpdate();
766 onEmptyResults : function(){
771 * Returns true if the dropdown list is expanded, else false.
773 isExpanded : function(){
774 return this.list.isVisible();
778 * Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.
779 * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
780 * @param {String} value The data value of the item to select
781 * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
782 * selected item if it is not currently in view (defaults to true)
783 * @return {Boolean} True if the value matched an item in the list, else false
785 selectByValue : function(v, scrollIntoView){
786 if(v !== undefined && v !== null){
787 var r = this.findRecord(this.valueField || this.displayField, v);
789 this.select(this.store.indexOf(r), scrollIntoView);
797 * Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.
798 * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
799 * @param {Number} index The zero-based index of the list item to select
800 * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
801 * selected item if it is not currently in view (defaults to true)
803 select : function(index, scrollIntoView){
804 this.selectedIndex = index;
805 this.view.select(index);
806 if(scrollIntoView !== false){
807 var el = this.view.getNode(index);
809 this.innerList.scrollChildIntoView(el, false);
815 selectNext : function(){
816 var ct = this.store.getCount();
818 if(this.selectedIndex == -1){
820 }else if(this.selectedIndex < ct-1){
821 this.select(this.selectedIndex+1);
827 selectPrev : function(){
828 var ct = this.store.getCount();
830 if(this.selectedIndex == -1){
832 }else if(this.selectedIndex != 0){
833 this.select(this.selectedIndex-1);
839 onKeyUp : function(e){
840 if(this.editable !== false && !e.isSpecialKey()){
841 this.lastKey = e.getKey();
842 this.dqTask.delay(this.queryDelay);
847 validateBlur : function(){
848 return !this.list || !this.list.isVisible();
852 initQuery : function(){
853 this.doQuery(this.getRawValue());
857 doForce : function(){
858 if(this.el.dom.value.length > 0){
860 this.lastSelectionText === undefined ? '' : this.lastSelectionText;
861 this.applyEmptyText();
866 * Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the
867 * query allowing the query action to be canceled if needed.
868 * @param {String} query The SQL query to execute
869 * @param {Boolean} forceAll True to force the query to execute even if there are currently fewer characters
870 * in the field than the minimum specified by the minChars config option. It also clears any filter previously
871 * saved in the current store (defaults to false)
873 doQuery : function(q, forceAll){
874 if(q === undefined || q === null){
883 if(this.fireEvent('beforequery', qe)===false || qe.cancel){
887 forceAll = qe.forceAll;
888 if(forceAll === true || (q.length >= this.minChars)){
889 if(this.lastQuery != q){
891 if(this.mode == 'local'){
892 this.selectedIndex = -1;
894 this.store.clearFilter();
896 this.store.filter(this.displayField, q);
900 this.store.baseParams[this.queryParam] = q;
902 params: this.getParams(q)
907 this.selectedIndex = -1;
914 getParams : function(q){
916 //p[this.queryParam] = q;
919 p.limit = this.pageSize;
925 * Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.
927 collapse : function(){
928 if(!this.isExpanded()){
932 Roo.get(document).un('mousedown', this.collapseIf, this);
933 Roo.get(document).un('mousewheel', this.collapseIf, this);
934 this.fireEvent('collapse', this);
938 collapseIf : function(e){
939 if(!e.within(this.wrap) && !e.within(this.list)){
945 * Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.
948 if(this.isExpanded() || !this.hasFocus){
951 this.list.alignTo(this.el, this.listAlign);
953 Roo.get(document).on('mousedown', this.collapseIf, this);
954 Roo.get(document).on('mousewheel', this.collapseIf, this);
955 this.fireEvent('expand', this);
959 // Implements the default empty TriggerField.onTriggerClick function
960 onTriggerClick : function(){
964 if(this.isExpanded()){
966 if (!this.blockFocus) {
971 this.hasFocus = true;
972 if(this.triggerAction == 'all') {
973 this.doQuery(this.allQuery, true);
975 this.doQuery(this.getRawValue());
977 if (!this.blockFocus) {
984 * @cfg {Boolean} grow
988 * @cfg {Number} growMin
992 * @cfg {Number} growMax