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 this.allowDomMove = false;
66 var s = Roo.getDom(this.transform);
68 this.hiddenName = s.name;
72 var d = [], opts = s.options;
73 for(var i = 0, len = opts.length;i < len; i++){
75 var value = (Roo.isIE ? o.getAttributeNode('value').specified : o.hasAttribute('value')) ? o.value : o.text;
79 d.push([value, o.text]);
81 this.store = new Roo.data.SimpleStore({
83 fields: ['value', 'text'],
86 this.valueField = 'value';
87 this.displayField = 'text';
89 s.name = Roo.id(); // wipe out the name in case somewhere else they have a reference
92 this.el = Roo.DomHelper.insertBefore(s, this.autoCreate || this.defaultAutoCreate);
93 s.parentNode.removeChild(s); // remove it
94 this.render(this.el.parentNode);
96 s.parentNode.removeChild(s); // remove it
101 this.store = Roo.factory(this.store, Roo.data);
104 this.selectedIndex = -1;
105 if(this.mode == 'local'){
106 if(config.queryDelay === undefined){
107 this.queryDelay = 10;
109 if(config.minChars === undefined){
115 Roo.extend(Roo.form.ComboBox, Roo.form.TriggerField, {
117 * @cfg {String/HTMLElement/Element} transform The id, DOM node or element of an existing select to convert to a ComboBox
120 * @cfg {Boolean} lazyRender True to prevent the ComboBox from rendering until requested (should always be used when
121 * rendering into an Roo.Editor, defaults to false)
124 * @cfg {Boolean/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to:
125 * {tag: "input", type: "text", size: "24", autocomplete: "off"})
128 * @cfg {Roo.data.Store} store The data store to which this combo is bound (defaults to undefined)
131 * @cfg {String} title If supplied, a header element is created containing this text and added into the top of
132 * the dropdown list (defaults to undefined, with no header element)
136 * @cfg {String/Roo.Template} tpl The template to use to render the output
140 defaultAutoCreate : {tag: "input", type: "text", size: "24", autocomplete: "off"},
142 * @cfg {Number} listWidth The width in pixels of the dropdown list (defaults to the width of the ComboBox field)
144 listWidth: undefined,
146 * @cfg {String} displayField The underlying data field name to bind to this CombBox (defaults to undefined if
147 * mode = 'remote' or 'text' if mode = 'local')
149 displayField: undefined,
151 * @cfg {String} valueField The underlying data value name to bind to this CombBox (defaults to undefined if
152 * mode = 'remote' or 'value' if mode = 'local').
153 * Note: use of a valueField requires the user make a selection
154 * in order for a value to be mapped.
156 valueField: undefined,
158 * @cfg {String} hiddenName If specified, a hidden form field with this name is dynamically generated to store the
159 * field's data value (defaults to the underlying DOM element's name)
161 hiddenName: undefined,
163 * @cfg {String} listClass CSS class to apply to the dropdown list element (defaults to '')
167 * @cfg {String} selectedClass CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')
169 selectedClass: 'x-combo-selected',
171 * @cfg {String} triggerClass An additional CSS class used to style the trigger button. The trigger will always get the
172 * class 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'
173 * which displays a downward arrow icon).
175 triggerClass : 'x-form-arrow-trigger',
177 * @cfg {Boolean/String} shadow True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right
181 * @cfg {String} listAlign A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported
182 * anchor positions (defaults to 'tl-bl')
186 * @cfg {Number} maxHeight The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)
190 * @cfg {String} triggerAction The action to execute when the trigger field is activated. Use 'all' to run the
191 * query specified by the allQuery config option (defaults to 'query')
193 triggerAction: 'query',
195 * @cfg {Number} minChars The minimum number of characters the user must type before autocomplete and typeahead activate
196 * (defaults to 4, does not apply if editable = false)
200 * @cfg {Boolean} typeAhead True to populate and autoselect the remainder of the text being typed after a configurable
201 * delay (typeAheadDelay) if it matches a known value (defaults to false)
205 * @cfg {Number} queryDelay The length of time in milliseconds to delay between the start of typing and sending the
206 * query to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')
210 * @cfg {Number} pageSize If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the
211 * filter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)
215 * @cfg {Boolean} selectOnFocus True to select any existing text in the field immediately on focus. Only applies
216 * when editable = true (defaults to false)
220 * @cfg {String} queryParam Name of the query as it will be passed on the querystring (defaults to 'query')
224 * @cfg {String} loadingText The text to display in the dropdown list while data is loading. Only applies
225 * when mode = 'remote' (defaults to 'Loading...')
227 loadingText: 'Loading...',
229 * @cfg {Boolean} resizable True to add a resize handle to the bottom of the dropdown list (defaults to false)
233 * @cfg {Number} handleHeight The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)
237 * @cfg {Boolean} editable False to prevent the user from typing text directly into the field, just like a
238 * traditional select (defaults to true)
242 * @cfg {String} allQuery The text query to send to the server to return all records for the list with no filtering (defaults to '')
246 * @cfg {String} mode Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)
250 * @cfg {Number} minListWidth The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if
251 * listWidth has a higher value)
255 * @cfg {Boolean} forceSelection True to restrict the selected value to one of the values in the list, false to
256 * allow the user to set arbitrary text into the field (defaults to false)
258 forceSelection:false,
260 * @cfg {Number} typeAheadDelay The length of time in milliseconds to wait until the typeahead text is displayed
261 * if typeAhead = true (defaults to 250)
263 typeAheadDelay : 250,
265 * @cfg {String} valueNotFoundText When using a name/value combo, if the value passed to setValue is not found in
266 * the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)
268 valueNotFoundText : undefined,
270 * @cfg {bool} blockFocus Prevents all focus calls, so it can work with things like HTML edtor bar
275 * @cfg {bool} disableClear Disable showing of clear button.
277 disableClear : false,
280 onRender : function(ct, position){
281 Roo.form.ComboBox.superclass.onRender.call(this, ct, position);
283 this.hiddenField = this.el.insertSibling({tag:'input', type:'hidden', name: this.hiddenName, id: (this.hiddenId||this.hiddenName)},
285 this.hiddenField.value =
286 this.hiddenValue !== undefined ? this.hiddenValue :
287 this.value !== undefined ? this.value : '';
289 // prevent input submission
290 this.el.dom.removeAttribute('name');
293 this.el.dom.setAttribute('autocomplete', 'off');
296 var cls = 'x-combo-list';
298 this.list = new Roo.Layer({
299 shadow: this.shadow, cls: [cls, this.listClass].join(' '), constrain:false
302 var lw = this.listWidth || Math.max(this.wrap.getWidth(), this.minListWidth);
303 this.list.setWidth(lw);
304 this.list.swallowEvent('mousewheel');
305 this.assetHeight = 0;
308 this.header = this.list.createChild({cls:cls+'-hd', html: this.title});
309 this.assetHeight += this.header.getHeight();
312 this.innerList = this.list.createChild({cls:cls+'-inner'});
313 this.innerList.on('mouseover', this.onViewOver, this);
314 this.innerList.on('mousemove', this.onViewMove, this);
315 this.innerList.setWidth(lw - this.list.getFrameWidth('lr'));
317 if(this.allowBlank && !this.pageSize && !this.disableClear){
318 this.footer = this.list.createChild({cls:cls+'-ft'});
319 this.pageTb = new Roo.Toolbar(this.footer);
323 this.footer = this.list.createChild({cls:cls+'-ft'});
324 this.pageTb = new Roo.PagingToolbar(this.footer, this.store,
325 {pageSize: this.pageSize});
329 if (this.pageTb && this.allowBlank && !this.disableClear) {
331 this.pageTb.add(new Roo.Toolbar.Fill(), {
332 cls: 'x-btn-icon x-btn-clear',
338 _this.onSelect(false, -1);
343 this.assetHeight += this.footer.getHeight();
348 this.tpl = '<div class="'+cls+'-item">{' + this.displayField + '}</div>';
351 this.view = new Roo.View(this.innerList, this.tpl, {
352 singleSelect:true, store: this.store, selectedClass: this.selectedClass
355 this.view.on('click', this.onViewClick, this);
357 this.store.on('beforeload', this.onBeforeLoad, this);
358 this.store.on('load', this.onLoad, this);
359 this.store.on('loadexception', this.collapse, this);
362 this.resizer = new Roo.Resizable(this.list, {
363 pinned:true, handles:'se'
365 this.resizer.on('resize', function(r, w, h){
366 this.maxHeight = h-this.handleHeight-this.list.getFrameWidth('tb')-this.assetHeight;
368 this.innerList.setWidth(w - this.list.getFrameWidth('lr'));
369 this.restrictHeight();
371 this[this.pageSize?'footer':'innerList'].setStyle('margin-bottom', this.handleHeight+'px');
374 this.editable = true;
375 this.setEditable(false);
380 initEvents : function(){
381 Roo.form.ComboBox.superclass.initEvents.call(this);
383 this.keyNav = new Roo.KeyNav(this.el, {
385 this.inKeyMode = true;
389 "down" : function(e){
390 if(!this.isExpanded()){
391 this.onTriggerClick();
393 this.inKeyMode = true;
398 "enter" : function(e){
408 this.onViewClick(false);
414 doRelay : function(foo, bar, hname){
415 if(hname == 'down' || this.scope.isExpanded()){
416 return Roo.KeyNav.prototype.doRelay.apply(this, arguments);
423 this.queryDelay = Math.max(this.queryDelay || 10,
424 this.mode == 'local' ? 10 : 250);
425 this.dqTask = new Roo.util.DelayedTask(this.initQuery, this);
427 this.taTask = new Roo.util.DelayedTask(this.onTypeAhead, this);
429 if(this.editable !== false){
430 this.el.on("keyup", this.onKeyUp, this);
432 if(this.forceSelection){
433 this.on('blur', this.doForce, this);
437 onDestroy : function(){
439 this.view.setStore(null);
440 this.view.el.removeAllListeners();
441 this.view.el.remove();
442 this.view.purgeListeners();
448 this.store.un('beforeload', this.onBeforeLoad, this);
449 this.store.un('load', this.onLoad, this);
450 this.store.un('loadexception', this.collapse, this);
452 Roo.form.ComboBox.superclass.onDestroy.call(this);
456 fireKey : function(e){
457 if(e.isNavKeyPress() && !this.list.isVisible()){
458 this.fireEvent("specialkey", this, e);
463 onResize: function(w, h){
464 Roo.form.ComboBox.superclass.onResize.apply(this, arguments);
465 if(this.list && this.listWidth === undefined){
466 var lw = Math.max(w, this.minListWidth);
467 this.list.setWidth(lw);
468 this.innerList.setWidth(lw - this.list.getFrameWidth('lr'));
473 * Allow or prevent the user from directly editing the field text. If false is passed,
474 * the user will only be able to select from the items defined in the dropdown list. This method
475 * is the runtime equivalent of setting the 'editable' config option at config time.
476 * @param {Boolean} value True to allow the user to directly edit the field text
478 setEditable : function(value){
479 if(value == this.editable){
482 this.editable = value;
484 this.el.dom.setAttribute('readOnly', true);
485 this.el.on('mousedown', this.onTriggerClick, this);
486 this.el.addClass('x-combo-noedit');
488 this.el.dom.setAttribute('readOnly', false);
489 this.el.un('mousedown', this.onTriggerClick, this);
490 this.el.removeClass('x-combo-noedit');
495 onBeforeLoad : function(){
499 this.innerList.update(this.loadingText ?
500 '<div class="loading-indicator">'+this.loadingText+'</div>' : '');
501 this.restrictHeight();
502 this.selectedIndex = -1;
510 if(this.store.getCount() > 0){
512 this.restrictHeight();
513 if(this.lastQuery == this.allQuery){
515 this.el.dom.select();
517 if(!this.selectByValue(this.value, true)){
518 this.select(0, true);
522 if(this.typeAhead && this.lastKey != Roo.EventObject.BACKSPACE && this.lastKey != Roo.EventObject.DELETE){
523 this.taTask.delay(this.typeAheadDelay);
527 this.onEmptyResults();
533 onTypeAhead : function(){
534 if(this.store.getCount() > 0){
535 var r = this.store.getAt(0);
536 var newValue = r.data[this.displayField];
537 var len = newValue.length;
538 var selStart = this.getRawValue().length;
540 this.setRawValue(newValue);
541 this.selectText(selStart, newValue.length);
547 onSelect : function(record, index){
548 if(this.fireEvent('beforeselect', this, record, index) !== false){
549 this.setFromData(index > -1 ? record.data : false);
551 this.fireEvent('select', this, record, index);
556 * Returns the currently selected field value or empty string if no value is set.
557 * @return {String} value The selected value
559 getValue : function(){
561 return typeof this.value != 'undefined' ? this.value : '';
563 return Roo.form.ComboBox.superclass.getValue.call(this);
568 * Clears any text/value currently set in the field
570 clearValue : function(){
571 if(this.hiddenField){
572 this.hiddenField.value = '';
575 this.setRawValue('');
576 this.lastSelectionText = '';
577 this.applyEmptyText();
581 * Sets the specified value into the field. If the value finds a match, the corresponding record text
582 * will be displayed in the field. If the value does not match the data value of an existing item,
583 * and the valueNotFoundText config option is defined, it will be displayed as the default field text.
584 * Otherwise the field will be blank (although the value will still be set).
585 * @param {String} value The value to match
587 setValue : function(v){
590 var r = this.findRecord(this.valueField, v);
592 text = r.data[this.displayField];
593 }else if(this.valueNotFoundText !== undefined){
594 text = this.valueNotFoundText;
597 this.lastSelectionText = text;
598 if(this.hiddenField){
599 this.hiddenField.value = v;
601 Roo.form.ComboBox.superclass.setValue.call(this, text);
605 * @property {Object} the last set data for the element
610 * Sets the value of the field based on a object which is related to the record format for the store.
611 * @param {Object} value the value to set as. or false on reset?
613 setFromData : function(o){
614 var dv = ''; // display value
615 var vv = ''; // value value..
617 if (this.displayField) {
618 dv = !o || typeof(o[this.displayField]) == 'undefined' ? '' : o[this.displayField];
620 // this is an error condition!!!
621 console.log('no value field set for '+ this.name);
625 vv = !o || typeof(o[this.valueField]) == 'undefined' ? dv : o[this.valueField];
627 if(this.hiddenField){
628 this.hiddenField.value = vv;
630 this.lastSelectionText = dv;
631 Roo.form.ComboBox.superclass.setValue.call(this, dv);
635 // no hidden field.. - we store the value in 'value', but still display
637 this.lastSelectionText = dv;
638 Roo.form.ComboBox.superclass.setValue.call(this, dv);
644 findRecord : function(prop, value){
646 if(this.store.getCount() > 0){
647 this.store.each(function(r){
648 if(r.data[prop] == value){
658 onViewMove : function(e, t){
659 this.inKeyMode = false;
663 onViewOver : function(e, t){
664 if(this.inKeyMode){ // prevent key nav and mouse over conflicts
667 var item = this.view.findItemFromChild(t);
669 var index = this.view.indexOf(item);
670 this.select(index, false);
675 onViewClick : function(doFocus){
676 var index = this.view.getSelectedIndexes()[0];
677 var r = this.store.getAt(index);
679 this.onSelect(r, index);
681 if(doFocus !== false && !this.blockFocus){
687 restrictHeight : function(){
688 this.innerList.dom.style.height = '';
689 var inner = this.innerList.dom;
690 var h = Math.max(inner.clientHeight, inner.offsetHeight, inner.scrollHeight);
691 this.innerList.setHeight(h < this.maxHeight ? 'auto' : this.maxHeight);
692 this.list.beginUpdate();
693 this.list.setHeight(this.innerList.getHeight()+this.list.getFrameWidth('tb')+(this.resizable?this.handleHeight:0)+this.assetHeight);
694 this.list.alignTo(this.el, this.listAlign);
695 this.list.endUpdate();
699 onEmptyResults : function(){
704 * Returns true if the dropdown list is expanded, else false.
706 isExpanded : function(){
707 return this.list.isVisible();
711 * Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.
712 * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
713 * @param {String} value The data value of the item to select
714 * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
715 * selected item if it is not currently in view (defaults to true)
716 * @return {Boolean} True if the value matched an item in the list, else false
718 selectByValue : function(v, scrollIntoView){
719 if(v !== undefined && v !== null){
720 var r = this.findRecord(this.valueField || this.displayField, v);
722 this.select(this.store.indexOf(r), scrollIntoView);
730 * Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.
731 * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
732 * @param {Number} index The zero-based index of the list item to select
733 * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
734 * selected item if it is not currently in view (defaults to true)
736 select : function(index, scrollIntoView){
737 this.selectedIndex = index;
738 this.view.select(index);
739 if(scrollIntoView !== false){
740 var el = this.view.getNode(index);
742 this.innerList.scrollChildIntoView(el, false);
748 selectNext : function(){
749 var ct = this.store.getCount();
751 if(this.selectedIndex == -1){
753 }else if(this.selectedIndex < ct-1){
754 this.select(this.selectedIndex+1);
760 selectPrev : function(){
761 var ct = this.store.getCount();
763 if(this.selectedIndex == -1){
765 }else if(this.selectedIndex != 0){
766 this.select(this.selectedIndex-1);
772 onKeyUp : function(e){
773 if(this.editable !== false && !e.isSpecialKey()){
774 this.lastKey = e.getKey();
775 this.dqTask.delay(this.queryDelay);
780 validateBlur : function(){
781 return !this.list || !this.list.isVisible();
785 initQuery : function(){
786 this.doQuery(this.getRawValue());
790 doForce : function(){
791 if(this.el.dom.value.length > 0){
793 this.lastSelectionText === undefined ? '' : this.lastSelectionText;
794 this.applyEmptyText();
799 * Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the
800 * query allowing the query action to be canceled if needed.
801 * @param {String} query The SQL query to execute
802 * @param {Boolean} forceAll True to force the query to execute even if there are currently fewer characters
803 * in the field than the minimum specified by the minChars config option. It also clears any filter previously
804 * saved in the current store (defaults to false)
806 doQuery : function(q, forceAll){
807 if(q === undefined || q === null){
816 if(this.fireEvent('beforequery', qe)===false || qe.cancel){
820 forceAll = qe.forceAll;
821 if(forceAll === true || (q.length >= this.minChars)){
822 if(this.lastQuery != q){
824 if(this.mode == 'local'){
825 this.selectedIndex = -1;
827 this.store.clearFilter();
829 this.store.filter(this.displayField, q);
833 this.store.baseParams[this.queryParam] = q;
835 params: this.getParams(q)
840 this.selectedIndex = -1;
847 getParams : function(q){
849 //p[this.queryParam] = q;
852 p.limit = this.pageSize;
858 * Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.
860 collapse : function(){
861 if(!this.isExpanded()){
865 Roo.get(document).un('mousedown', this.collapseIf, this);
866 Roo.get(document).un('mousewheel', this.collapseIf, this);
867 this.fireEvent('collapse', this);
871 collapseIf : function(e){
872 if(!e.within(this.wrap) && !e.within(this.list)){
878 * Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.
881 if(this.isExpanded() || !this.hasFocus){
884 this.list.alignTo(this.el, this.listAlign);
886 Roo.get(document).on('mousedown', this.collapseIf, this);
887 Roo.get(document).on('mousewheel', this.collapseIf, this);
888 this.fireEvent('expand', this);
892 // Implements the default empty TriggerField.onTriggerClick function
893 onTriggerClick : function(){
897 if(this.isExpanded()){
899 if (!this.blockFocus) {
904 this.hasFocus = true;
905 if(this.triggerAction == 'all') {
906 this.doQuery(this.allQuery, true);
908 this.doQuery(this.getRawValue());
910 if (!this.blockFocus) {
916 /** @cfg {Boolean} grow @hide */
917 /** @cfg {Number} growMin @hide */
918 /** @cfg {Number} growMax @hide */