3 * Copyright(c) 2006-2009 Ext JS, LLC
5 * http://www.extjs.com/license
8 * @class Ext.form.ComboBox
9 * @extends Ext.form.TriggerField
10 * <p>A combobox control with support for autocomplete, remote-loading, paging and many other features.</p>
11 * <p>A ComboBox works in a similar manner to a traditional HTML <select> field. The difference is
12 * that to submit the {@link #valueField}, you must specify a {@link #hiddenName} to create a hidden input
13 * field to hold the value of the valueField. The <i>{@link #displayField}</i> is shown in the text field
14 * which is named according to the {@link #name}.</p>
15 * <p><b><u>Events</u></b></p>
16 * <p>To do something when something in ComboBox is selected, configure the select event:<pre><code>
17 var cb = new Ext.form.ComboBox({
18 // all of your config options
21 'select': yourFunction
25 // Alternatively, you can assign events after the object is created:
26 var cb = new Ext.form.ComboBox(yourOptions);
27 cb.on('select', yourFunction, yourScope);
30 * <p><b><u>ComboBox in Grid</u></b></p>
31 * <p>If using a ComboBox in an {@link Ext.grid.EditorGridPanel Editor Grid} a {@link Ext.grid.Column#renderer renderer}
32 * will be needed to show the displayField when the editor is not active. Set up the renderer manually, or implement
33 * a reusable render, for example:<pre><code>
34 // create reusable renderer
35 Ext.util.Format.comboRenderer = function(combo){
36 return function(value){
37 var record = combo.findRecord(combo.{@link #valueField}, value);
38 return record ? record.get(combo.{@link #displayField}) : combo.{@link #valueNotFoundText};
42 // create the combo instance
43 var combo = new Ext.form.ComboBox({
44 {@link #typeAhead}: true,
45 {@link #triggerAction}: 'all',
46 {@link #lazyRender}:true,
47 {@link #mode}: 'local',
48 {@link #store}: new Ext.data.ArrayStore({
54 data: [[1, 'item1'], [2, 'item2']]
56 {@link #valueField}: 'myId',
57 {@link #displayField}: 'displayText'
60 // snippet of column model used within grid
61 var cm = new Ext.grid.ColumnModel([{
64 header: "Some Header",
65 dataIndex: 'whatever',
67 editor: combo, // specify reference to combo instance
68 renderer: Ext.util.Format.comboRenderer(combo) // pass combo instance to reusable renderer
74 * <p><b><u>Filtering</u></b></p>
75 * <p>A ComboBox {@link #doQuery uses filtering itself}, for information about filtering the ComboBox
76 * store manually see <tt>{@link #lastQuery}</tt>.</p>
78 * Create a new ComboBox.
79 * @param {Object} config Configuration options
82 Ext.form.ComboBox = Ext.extend(Ext.form.TriggerField, {
84 * @cfg {Mixed} transform The id, DOM node or element of an existing HTML SELECT to convert to a ComboBox.
85 * Note that if you specify this and the combo is going to be in an {@link Ext.form.BasicForm} or
86 * {@link Ext.form.FormPanel}, you must also set <tt>{@link #lazyRender} = true</tt>.
89 * @cfg {Boolean} lazyRender <tt>true</tt> to prevent the ComboBox from rendering until requested
90 * (should always be used when rendering into an {@link Ext.Editor} (e.g. {@link Ext.grid.EditorGridPanel Grids}),
91 * defaults to <tt>false</tt>).
94 * @cfg {String/Object} autoCreate <p>A {@link Ext.DomHelper DomHelper} element spec, or <tt>true</tt> for a default
95 * element spec. Used to create the {@link Ext.Component#getEl Element} which will encapsulate this Component.
96 * See <tt>{@link Ext.Component#autoEl autoEl}</tt> for details. Defaults to:</p>
97 * <pre><code>{tag: "input", type: "text", size: "24", autocomplete: "off"}</code></pre>
100 * @cfg {Ext.data.Store/Array} store The data source to which this combo is bound (defaults to <tt>undefined</tt>).
101 * Acceptable values for this property are:
102 * <div class="mdetail-params"><ul>
103 * <li><b>any {@link Ext.data.Store Store} subclass</b></li>
104 * <li><b>an Array</b> : Arrays will be converted to a {@link Ext.data.ArrayStore} internally,
105 * automatically generating {@link Ext.data.Field#name field names} to work with all data components.
106 * <div class="mdetail-params"><ul>
107 * <li><b>1-dimensional array</b> : (e.g., <tt>['Foo','Bar']</tt>)<div class="sub-desc">
108 * A 1-dimensional array will automatically be expanded (each array item will be used for both the combo
109 * {@link #valueField} and {@link #displayField})</div></li>
110 * <li><b>2-dimensional array</b> : (e.g., <tt>[['f','Foo'],['b','Bar']]</tt>)<div class="sub-desc">
111 * For a multi-dimensional array, the value in index 0 of each item will be assumed to be the combo
112 * {@link #valueField}, while the value at index 1 is assumed to be the combo {@link #displayField}.
113 * </div></li></ul></div></li></ul></div>
114 * <p>See also <tt>{@link #mode}</tt>.</p>
117 * @cfg {String} title If supplied, a header element is created containing this text and added into the top of
118 * the dropdown list (defaults to undefined, with no header element)
122 defaultAutoCreate : {tag: "input", type: "text", size: "24", autocomplete: "off"},
124 * @cfg {Number} listWidth The width (used as a parameter to {@link Ext.Element#setWidth}) of the dropdown
125 * list (defaults to the width of the ComboBox field). See also <tt>{@link #minListWidth}
128 * @cfg {String} displayField The underlying {@link Ext.data.Field#name data field name} to bind to this
129 * ComboBox (defaults to undefined if <tt>{@link #mode} = 'remote'</tt> or <tt>'field1'</tt> if
130 * {@link #transform transforming a select} or if the {@link #store field name is autogenerated based on
131 * the store configuration}).
132 * <p>See also <tt>{@link #valueField}</tt>.</p>
133 * <p><b>Note</b>: if using a ComboBox in an {@link Ext.grid.EditorGridPanel Editor Grid} a
134 * {@link Ext.grid.Column#renderer renderer} will be needed to show the displayField when the editor is not
138 * @cfg {String} valueField The underlying {@link Ext.data.Field#name data value name} to bind to this
139 * ComboBox (defaults to undefined if <tt>{@link #mode} = 'remote'</tt> or <tt>'field2'</tt> if
140 * {@link #transform transforming a select} or if the {@link #store field name is autogenerated based on
141 * the store configuration}).
142 * <p><b>Note</b>: use of a <tt>valueField</tt> requires the user to make a selection in order for a value to be
143 * mapped. See also <tt>{@link #hiddenName}</tt>, <tt>{@link #hiddenValue}</tt>, and <tt>{@link #displayField}</tt>.</p>
146 * @cfg {String} hiddenName If specified, a hidden form field with this name is dynamically generated to store the
147 * field's data value (defaults to the underlying DOM element's name). Required for the combo's value to automatically
148 * post during a form submission. See also {@link #valueField}.
149 * <p><b>Note</b>: the hidden field's id will also default to this name if {@link #hiddenId} is not specified.
150 * The ComboBox {@link Ext.Component#id id} and the <tt>{@link #hiddenId}</tt> <b>should be different</b>, since
151 * no two DOM nodes should share the same id. So, if the ComboBox <tt>{@link Ext.form.Field#name name}</tt> and
152 * <tt>hiddenName</tt> are the same, you should specify a unique <tt>{@link #hiddenId}</tt>.</p>
155 * @cfg {String} hiddenId If <tt>{@link #hiddenName}</tt> is specified, <tt>hiddenId</tt> can also be provided
156 * to give the hidden field a unique id (defaults to the <tt>{@link #hiddenName}</tt>). The <tt>hiddenId</tt>
157 * and combo {@link Ext.Component#id id} should be different, since no two DOM
158 * nodes should share the same id.
161 * @cfg {String} hiddenValue Sets the initial value of the hidden field if {@link #hiddenName} is
162 * specified to contain the selected {@link #valueField}, from the Store. Defaults to the configured
163 * <tt>{@link Ext.form.Field#value value}</tt>.
166 * @cfg {String} listClass The CSS class to add to the predefined <tt>'x-combo-list'</tt> class
167 * applied the dropdown list element (defaults to '').
171 * @cfg {String} selectedClass CSS class to apply to the selected item in the dropdown list
172 * (defaults to <tt>'x-combo-selected'</tt>)
174 selectedClass : 'x-combo-selected',
176 * @cfg {String} listEmptyText The empty text to display in the data view if no items are found.
181 * @cfg {String} triggerClass An additional CSS class used to style the trigger button. The trigger will always
182 * get the class <tt>'x-form-trigger'</tt> and <tt>triggerClass</tt> will be <b>appended</b> if specified
183 * (defaults to <tt>'x-form-arrow-trigger'</tt> which displays a downward arrow icon).
185 triggerClass : 'x-form-arrow-trigger',
187 * @cfg {Boolean/String} shadow <tt>true</tt> or <tt>"sides"</tt> for the default effect, <tt>"frame"</tt> for
188 * 4-way shadow, and <tt>"drop"</tt> for bottom-right
192 * @cfg {String} listAlign A valid anchor position value. See <tt>{@link Ext.Element#alignTo}</tt> for details
193 * on supported anchor positions (defaults to <tt>'tl-bl?'</tt>)
195 listAlign : 'tl-bl?',
197 * @cfg {Number} maxHeight The maximum height in pixels of the dropdown list before scrollbars are shown
198 * (defaults to <tt>300</tt>)
202 * @cfg {Number} minHeight The minimum height in pixels of the dropdown list when the list is constrained by its
203 * distance to the viewport edges (defaults to <tt>90</tt>)
207 * @cfg {String} triggerAction The action to execute when the trigger is clicked.
208 * <div class="mdetail-params"><ul>
209 * <li><b><tt>'query'</tt></b> : <b>Default</b>
210 * <p class="sub-desc">{@link #doQuery run the query} using the {@link Ext.form.Field#getRawValue raw value}.</p></li>
211 * <li><b><tt>'all'</tt></b> :
212 * <p class="sub-desc">{@link #doQuery run the query} specified by the <tt>{@link #allQuery}</tt> config option</p></li>
214 * <p>See also <code>{@link #queryParam}</code>.</p>
216 triggerAction : 'query',
218 * @cfg {Number} minChars The minimum number of characters the user must type before autocomplete and
219 * {@link #typeAhead} activate (defaults to <tt>4</tt> if <tt>{@link #mode} = 'remote'</tt> or <tt>0</tt> if
220 * <tt>{@link #mode} = 'local'</tt>, does not apply if
221 * <tt>{@link Ext.form.TriggerField#editable editable} = false</tt>).
225 * @cfg {Boolean} typeAhead <tt>true</tt> to populate and autoselect the remainder of the text being
226 * typed after a configurable delay ({@link #typeAheadDelay}) if it matches a known value (defaults
231 * @cfg {Number} queryDelay The length of time in milliseconds to delay between the start of typing and
232 * sending the query to filter the dropdown list (defaults to <tt>500</tt> if <tt>{@link #mode} = 'remote'</tt>
233 * or <tt>10</tt> if <tt>{@link #mode} = 'local'</tt>)
237 * @cfg {Number} pageSize If greater than <tt>0</tt>, a {@link Ext.PagingToolbar} is displayed in the
238 * footer of the dropdown list and the {@link #doQuery filter queries} will execute with page start and
239 * {@link Ext.PagingToolbar#pageSize limit} parameters. Only applies when <tt>{@link #mode} = 'remote'</tt>
240 * (defaults to <tt>0</tt>).
244 * @cfg {Boolean} selectOnFocus <tt>true</tt> to select any existing text in the field immediately on focus.
245 * Only applies when <tt>{@link Ext.form.TriggerField#editable editable} = true</tt> (defaults to
248 selectOnFocus : false,
250 * @cfg {String} queryParam Name of the query ({@link Ext.data.Store#baseParam baseParam} name for the store)
251 * as it will be passed on the querystring (defaults to <tt>'query'</tt>)
253 queryParam : 'query',
255 * @cfg {String} loadingText The text to display in the dropdown list while data is loading. Only applies
256 * when <tt>{@link #mode} = 'remote'</tt> (defaults to <tt>'Loading...'</tt>)
258 loadingText : 'Loading...',
260 * @cfg {Boolean} resizable <tt>true</tt> to add a resize handle to the bottom of the dropdown list
261 * (creates an {@link Ext.Resizable} with 'se' {@link Ext.Resizable#pinned pinned} handles).
262 * Defaults to <tt>false</tt>.
266 * @cfg {Number} handleHeight The height in pixels of the dropdown list resize handle if
267 * <tt>{@link #resizable} = true</tt> (defaults to <tt>8</tt>)
271 * @cfg {String} allQuery The text query to send to the server to return all records for the list
272 * with no filtering (defaults to '')
276 * @cfg {String} mode Acceptable values are:
277 * <div class="mdetail-params"><ul>
278 * <li><b><tt>'remote'</tt></b> : <b>Default</b>
279 * <p class="sub-desc">Automatically loads the <tt>{@link #store}</tt> the <b>first</b> time the trigger
280 * is clicked. If you do not want the store to be automatically loaded the first time the trigger is
281 * clicked, set to <tt>'local'</tt> and manually load the store. To force a requery of the store
282 * <b>every</b> time the trigger is clicked see <tt>{@link #lastQuery}</tt>.</p></li>
283 * <li><b><tt>'local'</tt></b> :
284 * <p class="sub-desc">ComboBox loads local data</p>
286 var combo = new Ext.form.ComboBox({
287 renderTo: document.body,
289 store: new Ext.data.ArrayStore({
292 'myId', // numeric value is the key
295 data: [[1, 'item1'], [2, 'item2']] // data is local
298 displayField: 'displayText',
306 * @cfg {Number} minListWidth The minimum width of the dropdown list in pixels (defaults to <tt>70</tt>, will
307 * be ignored if <tt>{@link #listWidth}</tt> has a higher value)
311 * @cfg {Boolean} forceSelection <tt>true</tt> to restrict the selected value to one of the values in the list,
312 * <tt>false</tt> to allow the user to set arbitrary text into the field (defaults to <tt>false</tt>)
314 forceSelection : false,
316 * @cfg {Number} typeAheadDelay The length of time in milliseconds to wait until the typeahead text is displayed
317 * if <tt>{@link #typeAhead} = true</tt> (defaults to <tt>250</tt>)
319 typeAheadDelay : 250,
321 * @cfg {String} valueNotFoundText When using a name/value combo, if the value passed to setValue is not found in
322 * the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined). If this
323 * default text is used, it means there is no value set and no validation will occur on this field.
327 * @cfg {Boolean} lazyInit <tt>true</tt> to not initialize the list for this combo until the field is focused
328 * (defaults to <tt>true</tt>)
333 * @cfg {Boolean} clearFilterOnReset <tt>true</tt> to clear any filters on the store (when in local mode) when reset is called
334 * (defaults to <tt>true</tt>)
336 clearFilterOnReset : true,
339 * @cfg {Boolean} submitValue False to clear the name attribute on the field so that it is not submitted during a form post.
340 * If a hiddenName is specified, setting this to true will cause both the hidden field and the element to be submitted.
341 * Defaults to <tt>undefined</tt>.
343 submitValue: undefined,
346 * The value of the match string used to filter the store. Delete this property to force a requery.
349 var combo = new Ext.form.ComboBox({
354 // delete the previous query in the beforequery event or set
355 // combo.lastQuery = null (this will reload the store the next time it expands)
356 beforequery: function(qe){
357 delete qe.combo.lastQuery;
362 * To make sure the filter in the store is not cleared the first time the ComboBox trigger is used
363 * configure the combo with <tt>lastQuery=''</tt>. Example use:
365 var combo = new Ext.form.ComboBox({
368 triggerAction: 'all',
372 * @property lastQuery
377 initComponent : function(){
378 Ext.form.ComboBox.superclass.initComponent.call(this);
382 * Fires when the dropdown list is expanded
383 * @param {Ext.form.ComboBox} combo This combo box
388 * Fires when the dropdown list is collapsed
389 * @param {Ext.form.ComboBox} combo This combo box
393 * @event beforeselect
394 * Fires before a list item is selected. Return false to cancel the selection.
395 * @param {Ext.form.ComboBox} combo This combo box
396 * @param {Ext.data.Record} record The data record returned from the underlying store
397 * @param {Number} index The index of the selected item in the dropdown list
402 * Fires when a list item is selected
403 * @param {Ext.form.ComboBox} combo This combo box
404 * @param {Ext.data.Record} record The data record returned from the underlying store
405 * @param {Number} index The index of the selected item in the dropdown list
410 * Fires before all queries are processed. Return false to cancel the query or set the queryEvent's
411 * cancel property to true.
412 * @param {Object} queryEvent An object that has these properties:<ul>
413 * <li><code>combo</code> : Ext.form.ComboBox <div class="sub-desc">This combo box</div></li>
414 * <li><code>query</code> : String <div class="sub-desc">The query</div></li>
415 * <li><code>forceAll</code> : Boolean <div class="sub-desc">True to force "all" query</div></li>
416 * <li><code>cancel</code> : Boolean <div class="sub-desc">Set to true to cancel the query</div></li>
422 var s = Ext.getDom(this.transform);
423 if(!this.hiddenName){
424 this.hiddenName = s.name;
428 var d = [], opts = s.options;
429 for(var i = 0, len = opts.length;i < len; i++){
431 value = (o.hasAttribute ? o.hasAttribute('value') : o.getAttributeNode('value').specified) ? o.value : o.text;
432 if(o.selected && Ext.isEmpty(this.value, true)) {
435 d.push([value, o.text]);
437 this.store = new Ext.data.ArrayStore({
439 fields: ['value', 'text'],
443 this.valueField = 'value';
444 this.displayField = 'text';
446 s.name = Ext.id(); // wipe out the name in case somewhere else they have a reference
447 if(!this.lazyRender){
449 this.el = Ext.DomHelper.insertBefore(s, this.autoCreate || this.defaultAutoCreate);
450 this.render(this.el.parentNode, s);
454 //auto-configure store from local array data
456 this.store = Ext.StoreMgr.lookup(this.store);
457 if(this.store.autoCreated){
458 this.displayField = this.valueField = 'field1';
459 if(!this.store.expandData){
460 this.displayField = 'field2';
466 this.selectedIndex = -1;
467 if(this.mode == 'local'){
468 if(!Ext.isDefined(this.initialConfig.queryDelay)){
469 this.queryDelay = 10;
471 if(!Ext.isDefined(this.initialConfig.minChars)){
478 onRender : function(ct, position){
479 if(this.hiddenName && !Ext.isDefined(this.submitValue)){
480 this.submitValue = false;
482 Ext.form.ComboBox.superclass.onRender.call(this, ct, position);
484 this.hiddenField = this.el.insertSibling({tag:'input', type:'hidden', name: this.hiddenName,
485 id: (this.hiddenId||this.hiddenName)}, 'before', true);
489 this.el.dom.setAttribute('autocomplete', 'off');
495 this.on('focus', this.initList, this, {single: true});
500 initValue : function(){
501 Ext.form.ComboBox.superclass.initValue.call(this);
502 if(this.hiddenField){
503 this.hiddenField.value =
504 Ext.isDefined(this.hiddenValue) ? this.hiddenValue :
505 Ext.isDefined(this.value) ? this.value : '';
510 initList : function(){
512 var cls = 'x-combo-list';
514 this.list = new Ext.Layer({
515 parentEl: this.getListParent(),
517 cls: [cls, this.listClass].join(' '),
522 var lw = this.listWidth || Math.max(this.wrap.getWidth(), this.minListWidth);
523 this.list.setSize(lw, 0);
524 this.list.swallowEvent('mousewheel');
525 this.assetHeight = 0;
526 if(this.syncFont !== false){
527 this.list.setStyle('font-size', this.el.getStyle('font-size'));
530 this.header = this.list.createChild({cls:cls+'-hd', html: this.title});
531 this.assetHeight += this.header.getHeight();
534 this.innerList = this.list.createChild({cls:cls+'-inner'});
535 this.mon(this.innerList, 'mouseover', this.onViewOver, this);
536 this.mon(this.innerList, 'mousemove', this.onViewMove, this);
537 this.innerList.setWidth(lw - this.list.getFrameWidth('lr'));
540 this.footer = this.list.createChild({cls:cls+'-ft'});
541 this.pageTb = new Ext.PagingToolbar({
543 pageSize: this.pageSize,
546 this.assetHeight += this.footer.getHeight();
551 * @cfg {String/Ext.XTemplate} tpl <p>The template string, or {@link Ext.XTemplate} instance to
552 * use to display each item in the dropdown list. The dropdown list is displayed in a
553 * DataView. See {@link #view}.</p>
554 * <p>The default template string is:</p><pre><code>
555 '<tpl for="."><div class="x-combo-list-item">{' + this.displayField + '}</div></tpl>'
557 * <p>Override the default value to create custom UI layouts for items in the list.
558 * For example:</p><pre><code>
559 '<tpl for="."><div ext:qtip="{state}. {nick}" class="x-combo-list-item">{state}</div></tpl>'
561 * <p>The template <b>must</b> contain one or more substitution parameters using field
562 * names from the Combo's</b> {@link #store Store}. In the example above an
563 * <pre>ext:qtip</pre> attribute is added to display other fields from the Store.</p>
564 * <p>To preserve the default visual look of list items, add the CSS class name
565 * <pre>x-combo-list-item</pre> to the template's container element.</p>
566 * <p>Also see {@link #itemSelector} for additional details.</p>
568 this.tpl = '<tpl for="."><div class="'+cls+'-item">{' + this.displayField + '}</div></tpl>';
570 * @cfg {String} itemSelector
571 * <p>A simple CSS selector (e.g. div.some-class or span:first-child) that will be
572 * used to determine what nodes the {@link #view Ext.DataView} which handles the dropdown
573 * display will be working with.</p>
574 * <p><b>Note</b>: this setting is <b>required</b> if a custom XTemplate has been
575 * specified in {@link #tpl} which assigns a class other than <pre>'x-combo-list-item'</pre>
576 * to dropdown list items</b>
581 * The {@link Ext.DataView DataView} used to display the ComboBox's options.
584 this.view = new Ext.DataView({
585 applyTo: this.innerList,
588 selectedClass: this.selectedClass,
589 itemSelector: this.itemSelector || '.' + cls + '-item',
590 emptyText: this.listEmptyText
593 this.mon(this.view, 'click', this.onViewClick, this);
595 this.bindStore(this.store, true);
598 this.resizer = new Ext.Resizable(this.list, {
599 pinned:true, handles:'se'
601 this.mon(this.resizer, 'resize', function(r, w, h){
602 this.maxHeight = h-this.handleHeight-this.list.getFrameWidth('tb')-this.assetHeight;
604 this.innerList.setWidth(w - this.list.getFrameWidth('lr'));
605 this.restrictHeight();
608 this[this.pageSize?'footer':'innerList'].setStyle('margin-bottom', this.handleHeight+'px');
614 * <p>Returns the element used to house this ComboBox's pop-up list. Defaults to the document body.</p>
615 * A custom implementation may be provided as a configuration option if the floating list needs to be rendered
616 * to a different Element. An example might be rendering the list inside a Menu so that clicking
617 * the list does not hide the Menu:<pre><code>
618 var store = new Ext.data.ArrayStore({
620 fields: ['initials', 'fullname'],
622 ['FF', 'Fred Flintstone'],
623 ['BR', 'Barney Rubble']
627 var combo = new Ext.form.ComboBox({
629 displayField: 'fullname',
630 emptyText: 'Select a name...',
631 forceSelection: true,
632 getListParent: function() {
633 return this.el.up('.x-menu');
635 iconCls: 'no-icon', //use iconCls if placing within menu to shift to right side of menu
638 triggerAction: 'all',
643 var menu = new Ext.menu.Menu({
646 combo // A Field in a Menu
651 getListParent : function() {
652 return document.body;
656 * Returns the store associated with this combo.
657 * @return {Ext.data.Store} The store
659 getStore : function(){
664 bindStore : function(store, initial){
665 if(this.store && !initial){
666 if(this.store !== store && this.store.autoDestroy){
667 this.store.destroy();
669 this.store.un('beforeload', this.onBeforeLoad, this);
670 this.store.un('load', this.onLoad, this);
671 this.store.un('exception', this.collapse, this);
676 this.view.bindStore(null);
679 this.pageTb.bindStore(null);
685 this.lastQuery = null;
687 this.pageTb.bindStore(store);
691 this.store = Ext.StoreMgr.lookup(store);
694 beforeload: this.onBeforeLoad,
696 exception: this.collapse
700 this.view.bindStore(store);
706 Ext.form.ComboBox.superclass.reset.call(this);
707 if(this.clearFilterOnReset && this.mode == 'local'){
708 this.store.clearFilter();
713 initEvents : function(){
714 Ext.form.ComboBox.superclass.initEvents.call(this);
716 this.keyNav = new Ext.KeyNav(this.el, {
718 this.inKeyMode = true;
722 "down" : function(e){
723 if(!this.isExpanded()){
724 this.onTriggerClick();
726 this.inKeyMode = true;
731 "enter" : function(e){
740 this.onViewClick(false);
746 doRelay : function(e, h, hname){
747 if(hname == 'down' || this.scope.isExpanded()){
748 // this MUST be called before ComboBox#fireKey()
749 var relay = Ext.KeyNav.prototype.doRelay.apply(this, arguments);
750 if(!Ext.isIE && Ext.EventManager.useKeydown){
751 // call Combo#fireKey() for browsers which use keydown event (except IE)
752 this.scope.fireKey(e);
760 defaultEventAction: 'stopEvent'
762 this.queryDelay = Math.max(this.queryDelay || 10,
763 this.mode == 'local' ? 10 : 250);
764 this.dqTask = new Ext.util.DelayedTask(this.initQuery, this);
766 this.taTask = new Ext.util.DelayedTask(this.onTypeAhead, this);
768 if(!this.enableKeyEvents){
769 this.mon(this.el, 'keyup', this.onKeyUp, this);
774 onDestroy : function(){
776 this.dqTask.cancel();
779 this.bindStore(null);
786 Ext.destroyMembers(this, 'hiddenField');
787 Ext.form.ComboBox.superclass.onDestroy.call(this);
791 fireKey : function(e){
792 if (!this.isExpanded()) {
793 Ext.form.ComboBox.superclass.fireKey.call(this, e);
798 onResize : function(w, h){
799 Ext.form.ComboBox.superclass.onResize.apply(this, arguments);
800 if(this.isVisible() && this.list){
807 doResize: function(w){
808 if(!Ext.isDefined(this.listWidth)){
809 var lw = Math.max(w, this.minListWidth);
810 this.list.setWidth(lw);
811 this.innerList.setWidth(lw - this.list.getFrameWidth('lr'));
816 onEnable : function(){
817 Ext.form.ComboBox.superclass.onEnable.apply(this, arguments);
818 if(this.hiddenField){
819 this.hiddenField.disabled = false;
824 onDisable : function(){
825 Ext.form.ComboBox.superclass.onDisable.apply(this, arguments);
826 if(this.hiddenField){
827 this.hiddenField.disabled = true;
832 onBeforeLoad : function(){
836 this.innerList.update(this.loadingText ?
837 '<div class="loading-indicator">'+this.loadingText+'</div>' : '');
838 this.restrictHeight();
839 this.selectedIndex = -1;
847 if(this.store.getCount() > 0 || this.listEmptyText){
849 this.restrictHeight();
850 if(this.lastQuery == this.allQuery){
852 this.el.dom.select();
854 if(!this.selectByValue(this.value, true)){
855 this.select(0, true);
859 if(this.typeAhead && this.lastKey != Ext.EventObject.BACKSPACE && this.lastKey != Ext.EventObject.DELETE){
860 this.taTask.delay(this.typeAheadDelay);
864 this.onEmptyResults();
870 onTypeAhead : function(){
871 if(this.store.getCount() > 0){
872 var r = this.store.getAt(0);
873 var newValue = r.data[this.displayField];
874 var len = newValue.length;
875 var selStart = this.getRawValue().length;
877 this.setRawValue(newValue);
878 this.selectText(selStart, newValue.length);
884 onSelect : function(record, index){
885 if(this.fireEvent('beforeselect', this, record, index) !== false){
886 this.setValue(record.data[this.valueField || this.displayField]);
888 this.fireEvent('select', this, record, index);
894 var hf = this.hiddenField;
895 return hf && hf.name ? hf.name : this.hiddenName || Ext.form.ComboBox.superclass.getName.call(this);
899 * Returns the currently selected field value or empty string if no value is set.
900 * @return {String} value The selected value
902 getValue : function(){
904 return Ext.isDefined(this.value) ? this.value : '';
906 return Ext.form.ComboBox.superclass.getValue.call(this);
911 * Clears any text/value currently set in the field
913 clearValue : function(){
914 if(this.hiddenField){
915 this.hiddenField.value = '';
917 this.setRawValue('');
918 this.lastSelectionText = '';
919 this.applyEmptyText();
924 * Sets the specified value into the field. If the value finds a match, the corresponding record text
925 * will be displayed in the field. If the value does not match the data value of an existing item,
926 * and the valueNotFoundText config option is defined, it will be displayed as the default field text.
927 * Otherwise the field will be blank (although the value will still be set).
928 * @param {String} value The value to match
929 * @return {Ext.form.Field} this
931 setValue : function(v){
934 var r = this.findRecord(this.valueField, v);
936 text = r.data[this.displayField];
937 }else if(Ext.isDefined(this.valueNotFoundText)){
938 text = this.valueNotFoundText;
941 this.lastSelectionText = text;
942 if(this.hiddenField){
943 this.hiddenField.value = v;
945 Ext.form.ComboBox.superclass.setValue.call(this, text);
951 findRecord : function(prop, value){
953 if(this.store.getCount() > 0){
954 this.store.each(function(r){
955 if(r.data[prop] == value){
965 onViewMove : function(e, t){
966 this.inKeyMode = false;
970 onViewOver : function(e, t){
971 if(this.inKeyMode){ // prevent key nav and mouse over conflicts
974 var item = this.view.findItemFromChild(t);
976 var index = this.view.indexOf(item);
977 this.select(index, false);
982 onViewClick : function(doFocus){
983 var index = this.view.getSelectedIndexes()[0],
987 this.onSelect(r, index);
988 }else if(s.getCount() === 0){
989 this.onEmptyResults();
991 if(doFocus !== false){
997 restrictHeight : function(){
998 this.innerList.dom.style.height = '';
999 var inner = this.innerList.dom,
1000 pad = this.list.getFrameWidth('tb') + (this.resizable ? this.handleHeight : 0) + this.assetHeight,
1001 h = Math.max(inner.clientHeight, inner.offsetHeight, inner.scrollHeight),
1002 ha = this.getPosition()[1]-Ext.getBody().getScroll().top,
1003 hb = Ext.lib.Dom.getViewHeight()-ha-this.getSize().height,
1004 space = Math.max(ha, hb, this.minHeight || 0)-this.list.shadowOffset-pad-5;
1006 h = Math.min(h, space, this.maxHeight);
1008 this.innerList.setHeight(h);
1009 this.list.beginUpdate();
1010 this.list.setHeight(h+pad);
1011 this.list.alignTo(this.wrap, this.listAlign);
1012 this.list.endUpdate();
1016 onEmptyResults : function(){
1021 * Returns true if the dropdown list is expanded, else false.
1023 isExpanded : function(){
1024 return this.list && this.list.isVisible();
1028 * Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.
1029 * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
1030 * @param {String} value The data value of the item to select
1031 * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
1032 * selected item if it is not currently in view (defaults to true)
1033 * @return {Boolean} True if the value matched an item in the list, else false
1035 selectByValue : function(v, scrollIntoView){
1036 if(!Ext.isEmpty(v, true)){
1037 var r = this.findRecord(this.valueField || this.displayField, v);
1039 this.select(this.store.indexOf(r), scrollIntoView);
1047 * Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.
1048 * The store must be loaded and the list expanded for this function to work, otherwise use setValue.
1049 * @param {Number} index The zero-based index of the list item to select
1050 * @param {Boolean} scrollIntoView False to prevent the dropdown list from autoscrolling to display the
1051 * selected item if it is not currently in view (defaults to true)
1053 select : function(index, scrollIntoView){
1054 this.selectedIndex = index;
1055 this.view.select(index);
1056 if(scrollIntoView !== false){
1057 var el = this.view.getNode(index);
1059 this.innerList.scrollChildIntoView(el, false);
1065 selectNext : function(){
1066 var ct = this.store.getCount();
1068 if(this.selectedIndex == -1){
1070 }else if(this.selectedIndex < ct-1){
1071 this.select(this.selectedIndex+1);
1077 selectPrev : function(){
1078 var ct = this.store.getCount();
1080 if(this.selectedIndex == -1){
1082 }else if(this.selectedIndex !== 0){
1083 this.select(this.selectedIndex-1);
1089 onKeyUp : function(e){
1091 if(this.editable !== false && this.readOnly !== true && (k == e.BACKSPACE || !e.isSpecialKey())){
1093 this.dqTask.delay(this.queryDelay);
1095 Ext.form.ComboBox.superclass.onKeyUp.call(this, e);
1099 validateBlur : function(){
1100 return !this.list || !this.list.isVisible();
1104 initQuery : function(){
1105 this.doQuery(this.getRawValue());
1109 beforeBlur : function(){
1110 var val = this.getRawValue(),
1111 rec = this.findRecord(this.displayField, val);
1112 if(!rec && this.forceSelection){
1113 if(val.length > 0 && val != this.emptyText){
1114 this.el.dom.value = Ext.isEmpty(this.lastSelectionText) ? '' : this.lastSelectionText;
1115 this.applyEmptyText();
1121 val = rec.get(this.valueField || this.displayField);
1128 * Execute a query to filter the dropdown list. Fires the {@link #beforequery} event prior to performing the
1129 * query allowing the query action to be canceled if needed.
1130 * @param {String} query The SQL query to execute
1131 * @param {Boolean} forceAll <tt>true</tt> to force the query to execute even if there are currently fewer
1132 * characters in the field than the minimum specified by the <tt>{@link #minChars}</tt> config option. It
1133 * also clears any filter previously saved in the current store (defaults to <tt>false</tt>)
1135 doQuery : function(q, forceAll){
1136 q = Ext.isEmpty(q) ? '' : q;
1143 if(this.fireEvent('beforequery', qe)===false || qe.cancel){
1147 forceAll = qe.forceAll;
1148 if(forceAll === true || (q.length >= this.minChars)){
1149 if(this.lastQuery !== q){
1151 if(this.mode == 'local'){
1152 this.selectedIndex = -1;
1154 this.store.clearFilter();
1156 this.store.filter(this.displayField, q);
1160 this.store.baseParams[this.queryParam] = q;
1162 params: this.getParams(q)
1167 this.selectedIndex = -1;
1174 getParams : function(q){
1176 //p[this.queryParam] = q;
1179 p.limit = this.pageSize;
1185 * Hides the dropdown list if it is currently expanded. Fires the {@link #collapse} event on completion.
1187 collapse : function(){
1188 if(!this.isExpanded()){
1192 Ext.getDoc().un('mousewheel', this.collapseIf, this);
1193 Ext.getDoc().un('mousedown', this.collapseIf, this);
1194 this.fireEvent('collapse', this);
1198 collapseIf : function(e){
1199 if(!e.within(this.wrap) && !e.within(this.list)){
1205 * Expands the dropdown list if it is currently hidden. Fires the {@link #expand} event on completion.
1207 expand : function(){
1208 if(this.isExpanded() || !this.hasFocus){
1211 if(this.bufferSize){
1212 this.doResize(this.bufferSize);
1213 delete this.bufferSize;
1215 this.list.alignTo(this.wrap, this.listAlign);
1218 this.innerList.setOverflow('auto'); // necessary for FF 2.0/Mac
1220 this.mon(Ext.getDoc(), {
1222 mousewheel: this.collapseIf,
1223 mousedown: this.collapseIf
1225 this.fireEvent('expand', this);
1229 * @method onTriggerClick
1233 // Implements the default empty TriggerField.onTriggerClick function
1234 onTriggerClick : function(){
1235 if(this.readOnly || this.disabled){
1238 if(this.isExpanded()){
1243 if(this.triggerAction == 'all') {
1244 this.doQuery(this.allQuery, true);
1246 this.doQuery(this.getRawValue());
1257 * @cfg {Boolean} grow @hide
1260 * @cfg {Number} growMin @hide
1263 * @cfg {Number} growMax @hide
1267 Ext.reg('combo', Ext.form.ComboBox);