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.Select = function(config){
22 Roo.form.Select.superclass.constructor.call(this, config);
26 Roo.extend(Roo.form.Select , Roo.form.ComboBox, {
28 * @cfg {String/HTMLElement/Element} transform The id, DOM node or element of an existing select to convert to a ComboBox
31 * @cfg {Boolean} lazyRender True to prevent the ComboBox from rendering until requested (should always be used when
32 * rendering into an Roo.Editor, defaults to false)
35 * @cfg {Boolean/Object} autoCreate A DomHelper element spec, or true for a default element spec (defaults to:
36 * {tag: "input", type: "text", size: "24", autocomplete: "off"})
39 * @cfg {Roo.data.Store} store The data store to which this combo is bound (defaults to undefined)
42 * @cfg {String} title If supplied, a header element is created containing this text and added into the top of
43 * the dropdown list (defaults to undefined, with no header element)
47 * @cfg {String/Roo.Template} tpl The template to use to render the output
51 defaultAutoCreate : {tag: "select" },
53 * @cfg {Number} listWidth The width in pixels of the dropdown list (defaults to the width of the ComboBox field)
57 * @cfg {String} displayField The underlying data field name to bind to this CombBox (defaults to undefined if
58 * mode = 'remote' or 'text' if mode = 'local')
60 displayField: undefined,
62 * @cfg {String} valueField The underlying data value name to bind to this CombBox (defaults to undefined if
63 * mode = 'remote' or 'value' if mode = 'local').
64 * Note: use of a valueField requires the user make a selection
65 * in order for a value to be mapped.
67 valueField: undefined,
71 * @cfg {String} hiddenName If specified, a hidden form field with this name is dynamically generated to store the
72 * field's data value (defaults to the underlying DOM element's name)
74 hiddenName: undefined,
76 * @cfg {String} listClass CSS class to apply to the dropdown list element (defaults to '')
80 * @cfg {String} selectedClass CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')
82 selectedClass: 'x-combo-selected',
84 * @cfg {String} triggerClass An additional CSS class used to style the trigger button. The trigger will always get the
85 * class 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'
86 * which displays a downward arrow icon).
88 triggerClass : 'x-form-arrow-trigger',
90 * @cfg {Boolean/String} shadow True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right
94 * @cfg {String} listAlign A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported
95 * anchor positions (defaults to 'tl-bl')
99 * @cfg {Number} maxHeight The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)
103 * @cfg {String} triggerAction The action to execute when the trigger field is activated. Use 'all' to run the
104 * query specified by the allQuery config option (defaults to 'query')
106 triggerAction: 'query',
108 * @cfg {Number} minChars The minimum number of characters the user must type before autocomplete and typeahead activate
109 * (defaults to 4, does not apply if editable = false)
113 * @cfg {Boolean} typeAhead True to populate and autoselect the remainder of the text being typed after a configurable
114 * delay (typeAheadDelay) if it matches a known value (defaults to false)
118 * @cfg {Number} queryDelay The length of time in milliseconds to delay between the start of typing and sending the
119 * query to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')
123 * @cfg {Number} pageSize If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the
124 * filter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)
128 * @cfg {Boolean} selectOnFocus True to select any existing text in the field immediately on focus. Only applies
129 * when editable = true (defaults to false)
133 * @cfg {String} queryParam Name of the query as it will be passed on the querystring (defaults to 'query')
137 * @cfg {String} loadingText The text to display in the dropdown list while data is loading. Only applies
138 * when mode = 'remote' (defaults to 'Loading...')
140 loadingText: 'Loading...',
142 * @cfg {Boolean} resizable True to add a resize handle to the bottom of the dropdown list (defaults to false)
146 * @cfg {Number} handleHeight The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)
150 * @cfg {Boolean} editable False to prevent the user from typing text directly into the field, just like a
151 * traditional select (defaults to true)
155 * @cfg {String} allQuery The text query to send to the server to return all records for the list with no filtering (defaults to '')
159 * @cfg {String} mode Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)
163 * @cfg {Number} minListWidth The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if
164 * listWidth has a higher value)
168 * @cfg {Boolean} forceSelection True to restrict the selected value to one of the values in the list, false to
169 * allow the user to set arbitrary text into the field (defaults to false)
171 forceSelection:false,
173 * @cfg {Number} typeAheadDelay The length of time in milliseconds to wait until the typeahead text is displayed
174 * if typeAhead = true (defaults to 250)
176 typeAheadDelay : 250,
178 * @cfg {String} valueNotFoundText When using a name/value combo, if the value passed to setValue is not found in
179 * the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)
181 valueNotFoundText : undefined,
184 * @cfg {String} defaultValue The value displayed after loading the store.
189 * @cfg {Boolean} blockFocus Prevents all focus calls, so it can work with things like HTML edtor bar
194 * @cfg {Boolean} disableClear Disable showing of clear button.
196 disableClear : false,
198 * @cfg {Boolean} alwaysQuery Disable caching of results, and always send query
206 // element that contains real text value.. (when hidden is used..)
209 onRender : function(ct, position){
210 Roo.form.Field.prototype.onRender.call(this, ct, position);
213 this.store.on('beforeload', this.onBeforeLoad, this);
214 this.store.on('load', this.onLoad, this);
215 this.store.on('loadexception', this.onLoadException, this);
224 initEvents : function(){
225 //Roo.form.ComboBox.superclass.initEvents.call(this);
229 onDestroy : function(){
232 this.store.un('beforeload', this.onBeforeLoad, this);
233 this.store.un('load', this.onLoad, this);
234 this.store.un('loadexception', this.onLoadException, this);
236 //Roo.form.ComboBox.superclass.onDestroy.call(this);
240 fireKey : function(e){
241 if(e.isNavKeyPress() && !this.list.isVisible()){
242 this.fireEvent("specialkey", this, e);
247 onResize: function(w, h){
255 * Allow or prevent the user from directly editing the field text. If false is passed,
256 * the user will only be able to select from the items defined in the dropdown list. This method
257 * is the runtime equivalent of setting the 'editable' config option at config time.
258 * @param {Boolean} value True to allow the user to directly edit the field text
260 setEditable : function(value){
265 onBeforeLoad : function(){
267 Roo.log("Select before load");
270 this.innerList.update(this.loadingText ?
271 '<div class="loading-indicator">'+this.loadingText+'</div>' : '');
272 //this.restrictHeight();
273 this.selectedIndex = -1;
280 var dom = this.el.dom;
282 var od = dom.ownerDocument;
284 if (this.emptyText) {
285 var op = od.createElement('option');
286 op.setAttribute('value', '');
287 op.innerHTML = String.format('{0}', this.emptyText);
290 if(this.store.getCount() > 0){
292 var vf = this.valueField;
293 var df = this.displayField;
294 this.store.data.each(function(r) {
295 // which colmsn to use... testing - cdoe / title..
296 var op = od.createElement('option');
297 op.setAttribute('value', r.data[vf]);
298 op.innerHTML = String.format('{0}', r.data[df]);
301 if (typeof(this.defaultValue != 'undefined')) {
302 this.setValue(this.defaultValue);
307 //this.onEmptyResults();
312 onLoadException : function()
316 Roo.log("Select on load exception");
320 Roo.log(this.store.reader.jsonData);
321 if (this.store && typeof(this.store.reader.jsonData.errorMsg) != 'undefined') {
322 Roo.MessageBox.alert("Error loading",this.store.reader.jsonData.errorMsg);
328 onTypeAhead : function(){
333 onSelect : function(record, index){
334 Roo.log('on select?');
336 if(this.fireEvent('beforeselect', this, record, index) !== false){
337 this.setFromData(index > -1 ? record.data : false);
339 this.fireEvent('select', this, record, index);
344 * Returns the currently selected field value or empty string if no value is set.
345 * @return {String} value The selected value
347 getValue : function(){
348 var dom = this.el.dom;
349 this.value = dom.options[dom.selectedIndex].value;
355 * Clears any text/value currently set in the field
357 clearValue : function(){
359 this.el.dom.selectedIndex = this.emptyText ? 0 : -1;
364 * Sets the specified value into the field. If the value finds a match, the corresponding record text
365 * will be displayed in the field. If the value does not match the data value of an existing item,
366 * and the valueNotFoundText config option is defined, it will be displayed as the default field text.
367 * Otherwise the field will be blank (although the value will still be set).
368 * @param {String} value The value to match
370 setValue : function(v){
372 for (var i =0; i < d.options.length;i++) {
373 if (v == d.options[i].value) {
382 * @property {Object} the last set data for the element
387 * Sets the value of the field based on a object which is related to the record format for the store.
388 * @param {Object} value the value to set as. or false on reset?
390 setFromData : function(o){
391 Roo.log('setfrom data?');
401 findRecord : function(prop, value){
406 if(this.store.getCount() > 0){
407 this.store.each(function(r){
408 if(r.data[prop] == value){
420 // returns hidden if it's set..
421 if (!this.rendered) {return ''};
422 return !this.hiddenName && this.el.dom.name ? this.el.dom.name : (this.hiddenName || '');
430 onEmptyResults : function(){
431 Roo.log('empty results');
436 * Returns true if the dropdown list is expanded, else false.
438 isExpanded : function(){
443 * Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.
444 * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
445 * @param {String} value The data value of the item to select
446 * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
447 * selected item if it is not currently in view (defaults to true)
448 * @return {Boolean} True if the value matched an item in the list, else false
450 selectByValue : function(v, scrollIntoView){
451 Roo.log('select By Value');
454 if(v !== undefined && v !== null){
455 var r = this.findRecord(this.valueField || this.displayField, v);
457 this.select(this.store.indexOf(r), scrollIntoView);
465 * Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.
466 * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
467 * @param {Number} index The zero-based index of the list item to select
468 * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
469 * selected item if it is not currently in view (defaults to true)
471 select : function(index, scrollIntoView){
475 this.selectedIndex = index;
476 this.view.select(index);
477 if(scrollIntoView !== false){
478 var el = this.view.getNode(index);
480 this.innerList.scrollChildIntoView(el, false);
488 validateBlur : function(){
495 initQuery : function(){
496 this.doQuery(this.getRawValue());
500 doForce : function(){
501 if(this.el.dom.value.length > 0){
503 this.lastSelectionText === undefined ? '' : this.lastSelectionText;
509 * Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the
510 * query allowing the query action to be canceled if needed.
511 * @param {String} query The SQL query to execute
512 * @param {Boolean} forceAll True to force the query to execute even if there are currently fewer characters
513 * in the field than the minimum specified by the minChars config option. It also clears any filter previously
514 * saved in the current store (defaults to false)
516 doQuery : function(q, forceAll){
519 if(q === undefined || q === null){
528 if(this.fireEvent('beforequery', qe)===false || qe.cancel){
532 forceAll = qe.forceAll;
533 if(forceAll === true || (q.length >= this.minChars)){
534 if(this.lastQuery != q || this.alwaysQuery){
536 if(this.mode == 'local'){
537 this.selectedIndex = -1;
539 this.store.clearFilter();
541 this.store.filter(this.displayField, q);
545 this.store.baseParams[this.queryParam] = q;
547 params: this.getParams(q)
552 this.selectedIndex = -1;
559 getParams : function(q){
561 //p[this.queryParam] = q;
564 p.limit = this.pageSize;
570 * Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.
572 collapse : function(){
577 collapseIf : function(e){
582 * Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.
592 * @cfg {Boolean} grow
596 * @cfg {Number} growMin
600 * @cfg {Number} growMax
608 setWidth : function()
612 getResizeEl : function(){