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} record The data record returned from the underlying store (or false on clear)
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,
295 onRender : function(ct, position){
296 Roo.form.ComboBox.superclass.onRender.call(this, ct, position);
298 this.hiddenField = this.el.insertSibling({tag:'input', type:'hidden', name: this.hiddenName, id: (this.hiddenId||this.hiddenName)},
300 this.hiddenField.value =
301 this.hiddenValue !== undefined ? this.hiddenValue :
302 this.value !== undefined ? this.value : '';
304 // prevent input submission
305 this.el.dom.removeAttribute('name');
308 this.el.dom.setAttribute('autocomplete', 'off');
311 var cls = 'x-combo-list';
313 this.list = new Roo.Layer({
314 shadow: this.shadow, cls: [cls, this.listClass].join(' '), constrain:false
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;
323 this.header = this.list.createChild({cls:cls+'-hd', html: this.title});
324 this.assetHeight += this.header.getHeight();
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'));
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);
338 this.footer = this.list.createChild({cls:cls+'-ft'});
339 this.pageTb = new Roo.PagingToolbar(this.footer, this.store,
340 {pageSize: this.pageSize});
344 if (this.pageTb && this.allowBlank && !this.disableClear) {
346 this.pageTb.add(new Roo.Toolbar.Fill(), {
347 cls: 'x-btn-icon x-btn-clear',
353 _this.onSelect(false, -1);
358 this.assetHeight += this.footer.getHeight();
363 this.tpl = '<div class="'+cls+'-item">{' + this.displayField + '}</div>';
366 this.view = new Roo.View(this.innerList, this.tpl, {
367 singleSelect:true, store: this.store, selectedClass: this.selectedClass
370 this.view.on('click', this.onViewClick, this);
372 this.store.on('beforeload', this.onBeforeLoad, this);
373 this.store.on('load', this.onLoad, this);
374 this.store.on('loadexception', this.collapse, this);
377 this.resizer = new Roo.Resizable(this.list, {
378 pinned:true, handles:'se'
380 this.resizer.on('resize', function(r, w, h){
381 this.maxHeight = h-this.handleHeight-this.list.getFrameWidth('tb')-this.assetHeight;
383 this.innerList.setWidth(w - this.list.getFrameWidth('lr'));
384 this.restrictHeight();
386 this[this.pageSize?'footer':'innerList'].setStyle('margin-bottom', this.handleHeight+'px');
389 this.editable = true;
390 this.setEditable(false);
394 if (typeof(this.events.add.listeners) != 'undefined') {
396 this.addicon = this.wrap.createChild(
397 {tag: 'img', src: Roo.BLANK_IMAGE_URL, cls: 'x-form-combo-add' });
399 this.addicon.on('click', function(e) {
400 this.fireEvent('add', this);
403 if (typeof(this.events.edit.listeners) != 'undefined') {
405 this.addicon = this.wrap.createChild(
406 {tag: 'img', src: Roo.BLANK_IMAGE_URL, cls: 'x-form-combo-edit' });
408 this.addicon.on('click', function(e) {
410 this.fireEvent('edit', this, this.lastData );
421 initEvents : function(){
422 Roo.form.ComboBox.superclass.initEvents.call(this);
424 this.keyNav = new Roo.KeyNav(this.el, {
426 this.inKeyMode = true;
430 "down" : function(e){
431 if(!this.isExpanded()){
432 this.onTriggerClick();
434 this.inKeyMode = true;
439 "enter" : function(e){
449 this.onViewClick(false);
455 doRelay : function(foo, bar, hname){
456 if(hname == 'down' || this.scope.isExpanded()){
457 return Roo.KeyNav.prototype.doRelay.apply(this, arguments);
464 this.queryDelay = Math.max(this.queryDelay || 10,
465 this.mode == 'local' ? 10 : 250);
466 this.dqTask = new Roo.util.DelayedTask(this.initQuery, this);
468 this.taTask = new Roo.util.DelayedTask(this.onTypeAhead, this);
470 if(this.editable !== false){
471 this.el.on("keyup", this.onKeyUp, this);
473 if(this.forceSelection){
474 this.on('blur', this.doForce, this);
478 onDestroy : function(){
480 this.view.setStore(null);
481 this.view.el.removeAllListeners();
482 this.view.el.remove();
483 this.view.purgeListeners();
489 this.store.un('beforeload', this.onBeforeLoad, this);
490 this.store.un('load', this.onLoad, this);
491 this.store.un('loadexception', this.collapse, this);
493 Roo.form.ComboBox.superclass.onDestroy.call(this);
497 fireKey : function(e){
498 if(e.isNavKeyPress() && !this.list.isVisible()){
499 this.fireEvent("specialkey", this, e);
504 onResize: function(w, h){
505 Roo.form.ComboBox.superclass.onResize.apply(this, arguments);
506 if(this.list && this.listWidth === undefined){
507 var lw = Math.max(w, this.minListWidth);
508 this.list.setWidth(lw);
509 this.innerList.setWidth(lw - this.list.getFrameWidth('lr'));
514 * Allow or prevent the user from directly editing the field text. If false is passed,
515 * the user will only be able to select from the items defined in the dropdown list. This method
516 * is the runtime equivalent of setting the 'editable' config option at config time.
517 * @param {Boolean} value True to allow the user to directly edit the field text
519 setEditable : function(value){
520 if(value == this.editable){
523 this.editable = value;
525 this.el.dom.setAttribute('readOnly', true);
526 this.el.on('mousedown', this.onTriggerClick, this);
527 this.el.addClass('x-combo-noedit');
529 this.el.dom.setAttribute('readOnly', false);
530 this.el.un('mousedown', this.onTriggerClick, this);
531 this.el.removeClass('x-combo-noedit');
536 onBeforeLoad : function(){
540 this.innerList.update(this.loadingText ?
541 '<div class="loading-indicator">'+this.loadingText+'</div>' : '');
542 this.restrictHeight();
543 this.selectedIndex = -1;
551 if(this.store.getCount() > 0){
553 this.restrictHeight();
554 if(this.lastQuery == this.allQuery){
556 this.el.dom.select();
558 if(!this.selectByValue(this.value, true)){
559 this.select(0, true);
563 if(this.typeAhead && this.lastKey != Roo.EventObject.BACKSPACE && this.lastKey != Roo.EventObject.DELETE){
564 this.taTask.delay(this.typeAheadDelay);
568 this.onEmptyResults();
574 onTypeAhead : function(){
575 if(this.store.getCount() > 0){
576 var r = this.store.getAt(0);
577 var newValue = r.data[this.displayField];
578 var len = newValue.length;
579 var selStart = this.getRawValue().length;
581 this.setRawValue(newValue);
582 this.selectText(selStart, newValue.length);
588 onSelect : function(record, index){
589 if(this.fireEvent('beforeselect', this, record, index) !== false){
590 this.setFromData(index > -1 ? record.data : false);
592 this.fireEvent('select', this, record, index);
597 * Returns the currently selected field value or empty string if no value is set.
598 * @return {String} value The selected value
600 getValue : function(){
602 return typeof this.value != 'undefined' ? this.value : '';
604 return Roo.form.ComboBox.superclass.getValue.call(this);
609 * Clears any text/value currently set in the field
611 clearValue : function(){
612 if(this.hiddenField){
613 this.hiddenField.value = '';
616 this.setRawValue('');
617 this.lastSelectionText = '';
618 this.applyEmptyText();
622 * Sets the specified value into the field. If the value finds a match, the corresponding record text
623 * will be displayed in the field. If the value does not match the data value of an existing item,
624 * and the valueNotFoundText config option is defined, it will be displayed as the default field text.
625 * Otherwise the field will be blank (although the value will still be set).
626 * @param {String} value The value to match
628 setValue : function(v){
631 var r = this.findRecord(this.valueField, v);
633 text = r.data[this.displayField];
634 }else if(this.valueNotFoundText !== undefined){
635 text = this.valueNotFoundText;
638 this.lastSelectionText = text;
639 if(this.hiddenField){
640 this.hiddenField.value = v;
642 Roo.form.ComboBox.superclass.setValue.call(this, text);
646 * @property {Object} the last set data for the element
651 * Sets the value of the field based on a object which is related to the record format for the store.
652 * @param {Object} value the value to set as. or false on reset?
654 setFromData : function(o){
655 var dv = ''; // display value
656 var vv = ''; // value value..
658 if (this.displayField) {
659 dv = !o || typeof(o[this.displayField]) == 'undefined' ? '' : o[this.displayField];
661 // this is an error condition!!!
662 console.log('no value field set for '+ this.name);
666 vv = !o || typeof(o[this.valueField]) == 'undefined' ? dv : o[this.valueField];
668 if(this.hiddenField){
669 this.hiddenField.value = vv;
671 this.lastSelectionText = dv;
672 Roo.form.ComboBox.superclass.setValue.call(this, dv);
676 // no hidden field.. - we store the value in 'value', but still display
678 this.lastSelectionText = dv;
679 Roo.form.ComboBox.superclass.setValue.call(this, dv);
686 // overridden so that last data is reset..
687 this.setValue(this.originalValue);
689 this.lastData = false;
692 findRecord : function(prop, value){
694 if(this.store.getCount() > 0){
695 this.store.each(function(r){
696 if(r.data[prop] == value){
706 onViewMove : function(e, t){
707 this.inKeyMode = false;
711 onViewOver : function(e, t){
712 if(this.inKeyMode){ // prevent key nav and mouse over conflicts
715 var item = this.view.findItemFromChild(t);
717 var index = this.view.indexOf(item);
718 this.select(index, false);
723 onViewClick : function(doFocus){
724 var index = this.view.getSelectedIndexes()[0];
725 var r = this.store.getAt(index);
727 this.onSelect(r, index);
729 if(doFocus !== false && !this.blockFocus){
735 restrictHeight : function(){
736 this.innerList.dom.style.height = '';
737 var inner = this.innerList.dom;
738 var h = Math.max(inner.clientHeight, inner.offsetHeight, inner.scrollHeight);
739 this.innerList.setHeight(h < this.maxHeight ? 'auto' : this.maxHeight);
740 this.list.beginUpdate();
741 this.list.setHeight(this.innerList.getHeight()+this.list.getFrameWidth('tb')+(this.resizable?this.handleHeight:0)+this.assetHeight);
742 this.list.alignTo(this.el, this.listAlign);
743 this.list.endUpdate();
747 onEmptyResults : function(){
752 * Returns true if the dropdown list is expanded, else false.
754 isExpanded : function(){
755 return this.list.isVisible();
759 * Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.
760 * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
761 * @param {String} value The data value of the item to select
762 * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
763 * selected item if it is not currently in view (defaults to true)
764 * @return {Boolean} True if the value matched an item in the list, else false
766 selectByValue : function(v, scrollIntoView){
767 if(v !== undefined && v !== null){
768 var r = this.findRecord(this.valueField || this.displayField, v);
770 this.select(this.store.indexOf(r), scrollIntoView);
778 * Select an item in the dropdown list by its numeric index in the list. 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 {Number} index The zero-based index of the list 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)
784 select : function(index, scrollIntoView){
785 this.selectedIndex = index;
786 this.view.select(index);
787 if(scrollIntoView !== false){
788 var el = this.view.getNode(index);
790 this.innerList.scrollChildIntoView(el, false);
796 selectNext : function(){
797 var ct = this.store.getCount();
799 if(this.selectedIndex == -1){
801 }else if(this.selectedIndex < ct-1){
802 this.select(this.selectedIndex+1);
808 selectPrev : function(){
809 var ct = this.store.getCount();
811 if(this.selectedIndex == -1){
813 }else if(this.selectedIndex != 0){
814 this.select(this.selectedIndex-1);
820 onKeyUp : function(e){
821 if(this.editable !== false && !e.isSpecialKey()){
822 this.lastKey = e.getKey();
823 this.dqTask.delay(this.queryDelay);
828 validateBlur : function(){
829 return !this.list || !this.list.isVisible();
833 initQuery : function(){
834 this.doQuery(this.getRawValue());
838 doForce : function(){
839 if(this.el.dom.value.length > 0){
841 this.lastSelectionText === undefined ? '' : this.lastSelectionText;
842 this.applyEmptyText();
847 * Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the
848 * query allowing the query action to be canceled if needed.
849 * @param {String} query The SQL query to execute
850 * @param {Boolean} forceAll True to force the query to execute even if there are currently fewer characters
851 * in the field than the minimum specified by the minChars config option. It also clears any filter previously
852 * saved in the current store (defaults to false)
854 doQuery : function(q, forceAll){
855 if(q === undefined || q === null){
864 if(this.fireEvent('beforequery', qe)===false || qe.cancel){
868 forceAll = qe.forceAll;
869 if(forceAll === true || (q.length >= this.minChars)){
870 if(this.lastQuery != q){
872 if(this.mode == 'local'){
873 this.selectedIndex = -1;
875 this.store.clearFilter();
877 this.store.filter(this.displayField, q);
881 this.store.baseParams[this.queryParam] = q;
883 params: this.getParams(q)
888 this.selectedIndex = -1;
895 getParams : function(q){
897 //p[this.queryParam] = q;
900 p.limit = this.pageSize;
906 * Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.
908 collapse : function(){
909 if(!this.isExpanded()){
913 Roo.get(document).un('mousedown', this.collapseIf, this);
914 Roo.get(document).un('mousewheel', this.collapseIf, this);
915 this.fireEvent('collapse', this);
919 collapseIf : function(e){
920 if(!e.within(this.wrap) && !e.within(this.list)){
926 * Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.
929 if(this.isExpanded() || !this.hasFocus){
932 this.list.alignTo(this.el, this.listAlign);
934 Roo.get(document).on('mousedown', this.collapseIf, this);
935 Roo.get(document).on('mousewheel', this.collapseIf, this);
936 this.fireEvent('expand', this);
940 // Implements the default empty TriggerField.onTriggerClick function
941 onTriggerClick : function(){
945 if(this.isExpanded()){
947 if (!this.blockFocus) {
952 this.hasFocus = true;
953 if(this.triggerAction == 'all') {
954 this.doQuery(this.allQuery, true);
956 this.doQuery(this.getRawValue());
958 if (!this.blockFocus) {
965 * @cfg {Boolean} grow
969 * @cfg {Number} growMin
973 * @cfg {Number} growMax