1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.form.ComboBox</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.form.ComboBox-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.form.ComboBox-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.form.ComboBox-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.form.ComboBox-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.form.TriggerField.html#constructor" roo:cls="Roo.form.TriggerField.html#constructor">Roo.form.TriggerField</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.ComboBox
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.form.ComboBox
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_form_ComboBox.js.html">Roo/form/ComboBox.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">ComboBox</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.form.TriggerField.html#constructor" roo:cls="Roo.form.TriggerField.html#constructor">Roo.form.TriggerField</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 A combobox control with support for autocomplete, remote-loading, paging and many other features.
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.ComboBox';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo.form" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.form.ComboBox.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.form.ComboBox-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.form.ComboBox-cfg-allQuery" name=".allQuery"></a>
132 <div class="fixedFont">
133 <b class="itemname">allQuery</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
139 <div class="short">The text query to send to the server to return all records for the list with no filtering (defaults to '')</div>
143 <div class="long">The text query to send to the server to return all records for the list with no filtering (defaults to '')</div>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.form.ComboBox-cfg-autoCreate" name=".autoCreate"></a>
162 <div class="fixedFont">
163 <b class="itemname">autoCreate</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/Object
169 <div class="short">A DomHelper element spec, or true for a default element spec (defaults to:<br/>{tag: "input", type: "text", size: "24", autocomplete: "off"})</div>
173 <div class="long">A DomHelper element spec, or true for a default element spec (defaults to:<br/>{tag: "input", type: "text", size: "24", autocomplete: "off"})</div>
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.form.ComboBox-cfg-blockFocus" name=".blockFocus"></a>
192 <div class="fixedFont">
193 <b class="itemname">blockFocus</b> : bool
199 <div class="short">Prevents all focus calls, so it can work with things like HTML edtor bar</div>
203 <div class="long">Prevents all focus calls, so it can work with things like HTML edtor bar</div>
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.form.ComboBox-cfg-disableClear" name=".disableClear"></a>
222 <div class="fixedFont">
223 <b class="itemname">disableClear</b> : bool
229 <div class="short">Disable showing of clear button.</div>
233 <div class="long">Disable showing of clear button.</div>
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.form.ComboBox-cfg-displayField" name=".displayField"></a>
252 <div class="fixedFont">
253 <b class="itemname">displayField</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
259 <div class="short">The underlying data field name to bind to this CombBox (defaults to undefined if<br/>mode = 'remote' or 'text' if mode = 'local')</div>
263 <div class="long">The underlying data field name to bind to this CombBox (defaults to undefined if<br/>mode = 'remote' or 'text' if mode = 'local')</div>
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.form.ComboBox-cfg-editable" name=".editable"></a>
282 <div class="fixedFont">
283 <b class="itemname">editable</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
289 <div class="short">False to prevent the user from typing text directly into the field, just like a<br/>traditional select (defaults to true)</div>
293 <div class="long">False to prevent the user from typing text directly into the field, just like a<br/>traditional select (defaults to true)</div>
307 <tr class="config-row expandable config-row-alt0 notInherited">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.form.ComboBox-cfg-forceSelection" name=".forceSelection"></a>
312 <div class="fixedFont">
313 <b class="itemname">forceSelection</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
319 <div class="short">True to restrict the selected value to one of the values in the list, false to<br/>allow the user to set arbitrary text into the field (defaults to false)</div>
323 <div class="long">True to restrict the selected value to one of the values in the list, false to<br/>allow the user to set arbitrary text into the field (defaults to false)</div>
337 <tr class="config-row expandable config-row-alt1 notInherited">
338 <td class="micon"><a class="exi" href="#expand"> </a></td>
341 <a id="Roo.form.ComboBox-cfg-grow" name=".grow"></a>
342 <div class="fixedFont">
343 <b class="itemname">grow</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
349 <div class="short"></div>
353 <div class="long"></div>
367 <tr class="config-row expandable config-row-alt0 notInherited">
368 <td class="micon"><a class="exi" href="#expand"> </a></td>
371 <a id="Roo.form.ComboBox-cfg-growMax" name=".growMax"></a>
372 <div class="fixedFont">
373 <b class="itemname">growMax</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
379 <div class="short"></div>
383 <div class="long"></div>
397 <tr class="config-row expandable config-row-alt1 notInherited">
398 <td class="micon"><a class="exi" href="#expand"> </a></td>
401 <a id="Roo.form.ComboBox-cfg-growMin" name=".growMin"></a>
402 <div class="fixedFont">
403 <b class="itemname">growMin</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
409 <div class="short"></div>
413 <div class="long"></div>
427 <tr class="config-row expandable config-row-alt0 notInherited">
428 <td class="micon"><a class="exi" href="#expand"> </a></td>
431 <a id="Roo.form.ComboBox-cfg-handleHeight" name=".handleHeight"></a>
432 <div class="fixedFont">
433 <b class="itemname">handleHeight</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
439 <div class="short">The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)</div>
443 <div class="long">The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)</div>
457 <tr class="config-row expandable config-row-alt1 notInherited">
458 <td class="micon"><a class="exi" href="#expand"> </a></td>
461 <a id="Roo.form.ComboBox-cfg-hiddenName" name=".hiddenName"></a>
462 <div class="fixedFont">
463 <b class="itemname">hiddenName</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
469 <div class="short">If specified, a hidden form field with this name is dynamically generated to store the<br/>field's data value (defaults to the underlying DOM element's name)</div>
473 <div class="long">If specified, a hidden form field with this name is dynamically generated to store the<br/>field's data value (defaults to the underlying DOM element's name)</div>
487 <tr class="config-row expandable config-row-alt0 notInherited">
488 <td class="micon"><a class="exi" href="#expand"> </a></td>
491 <a id="Roo.form.ComboBox-cfg-lazyRender" name=".lazyRender"></a>
492 <div class="fixedFont">
493 <b class="itemname">lazyRender</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
499 <div class="short">True to prevent the ComboBox from rendering until requested (should always be used when<br/>rendering into an Roo.Editor, defaults to false)</div>
503 <div class="long">True to prevent the ComboBox from rendering until requested (should always be used when<br/>rendering into an Roo.Editor, defaults to false)</div>
517 <tr class="config-row expandable config-row-alt1 notInherited">
518 <td class="micon"><a class="exi" href="#expand"> </a></td>
521 <a id="Roo.form.ComboBox-cfg-listAlign" name=".listAlign"></a>
522 <div class="fixedFont">
523 <b class="itemname">listAlign</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
529 <div class="short">A valid anchor position value.</div>
533 <div class="long">A valid anchor position value. See {<b>link</b> Roo.Element<b>alignTo</b>} for details on supported<br/>anchor positions (defaults to 'tl-bl')</div>
547 <tr class="config-row expandable config-row-alt0 notInherited">
548 <td class="micon"><a class="exi" href="#expand"> </a></td>
551 <a id="Roo.form.ComboBox-cfg-listClass" name=".listClass"></a>
552 <div class="fixedFont">
553 <b class="itemname">listClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
559 <div class="short">CSS class to apply to the dropdown list element (defaults to '')</div>
563 <div class="long">CSS class to apply to the dropdown list element (defaults to '')</div>
577 <tr class="config-row expandable config-row-alt1 notInherited">
578 <td class="micon"><a class="exi" href="#expand"> </a></td>
581 <a id="Roo.form.ComboBox-cfg-listWidth" name=".listWidth"></a>
582 <div class="fixedFont">
583 <b class="itemname">listWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
589 <div class="short">The width in pixels of the dropdown list (defaults to the width of the ComboBox field)</div>
593 <div class="long">The width in pixels of the dropdown list (defaults to the width of the ComboBox field)</div>
607 <tr class="config-row expandable config-row-alt0 notInherited">
608 <td class="micon"><a class="exi" href="#expand"> </a></td>
611 <a id="Roo.form.ComboBox-cfg-loadingText" name=".loadingText"></a>
612 <div class="fixedFont">
613 <b class="itemname">loadingText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
619 <div class="short">The text to display in the dropdown list while data is loading.</div>
623 <div class="long">The text to display in the dropdown list while data is loading. Only applies<br/>when mode = 'remote' (defaults to 'Loading...')</div>
637 <tr class="config-row expandable config-row-alt1 notInherited">
638 <td class="micon"><a class="exi" href="#expand"> </a></td>
641 <a id="Roo.form.ComboBox-cfg-maxHeight" name=".maxHeight"></a>
642 <div class="fixedFont">
643 <b class="itemname">maxHeight</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
649 <div class="short">The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)</div>
653 <div class="long">The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)</div>
667 <tr class="config-row expandable config-row-alt0 notInherited">
668 <td class="micon"><a class="exi" href="#expand"> </a></td>
671 <a id="Roo.form.ComboBox-cfg-minChars" name=".minChars"></a>
672 <div class="fixedFont">
673 <b class="itemname">minChars</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
679 <div class="short">The minimum number of characters the user must type before autocomplete and typeahead activate<br/>(defaults to 4, does not apply if editable = false)</div>
683 <div class="long">The minimum number of characters the user must type before autocomplete and typeahead activate<br/>(defaults to 4, does not apply if editable = false)</div>
697 <tr class="config-row expandable config-row-alt1 notInherited">
698 <td class="micon"><a class="exi" href="#expand"> </a></td>
701 <a id="Roo.form.ComboBox-cfg-minListWidth" name=".minListWidth"></a>
702 <div class="fixedFont">
703 <b class="itemname">minListWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
709 <div class="short">The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if<br/>listWidth has a higher value)</div>
713 <div class="long">The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if<br/>listWidth has a higher value)</div>
727 <tr class="config-row expandable config-row-alt0 notInherited">
728 <td class="micon"><a class="exi" href="#expand"> </a></td>
731 <a id="Roo.form.ComboBox-cfg-mode" name=".mode"></a>
732 <div class="fixedFont">
733 <b class="itemname">mode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
739 <div class="short">Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)</div>
743 <div class="long">Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)</div>
757 <tr class="config-row expandable config-row-alt1 notInherited">
758 <td class="micon"><a class="exi" href="#expand"> </a></td>
761 <a id="Roo.form.ComboBox-cfg-pageSize" name=".pageSize"></a>
762 <div class="fixedFont">
763 <b class="itemname">pageSize</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
769 <div class="short">If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the<br/>filter queries will execute with page start and limit parameters.</div>
773 <div class="long">If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the<br/>filter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)</div>
787 <tr class="config-row expandable config-row-alt0 notInherited">
788 <td class="micon"><a class="exi" href="#expand"> </a></td>
791 <a id="Roo.form.ComboBox-cfg-queryDelay" name=".queryDelay"></a>
792 <div class="fixedFont">
793 <b class="itemname">queryDelay</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
799 <div class="short">The length of time in milliseconds to delay between the start of typing and sending the<br/>query to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')</div>
803 <div class="long">The length of time in milliseconds to delay between the start of typing and sending the<br/>query to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')</div>
817 <tr class="config-row expandable config-row-alt1 notInherited">
818 <td class="micon"><a class="exi" href="#expand"> </a></td>
821 <a id="Roo.form.ComboBox-cfg-queryParam" name=".queryParam"></a>
822 <div class="fixedFont">
823 <b class="itemname">queryParam</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
829 <div class="short">Name of the query as it will be passed on the querystring (defaults to 'query')</div>
833 <div class="long">Name of the query as it will be passed on the querystring (defaults to 'query')</div>
847 <tr class="config-row expandable config-row-alt0 notInherited">
848 <td class="micon"><a class="exi" href="#expand"> </a></td>
851 <a id="Roo.form.ComboBox-cfg-resizable" name=".resizable"></a>
852 <div class="fixedFont">
853 <b class="itemname">resizable</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
859 <div class="short">True to add a resize handle to the bottom of the dropdown list (defaults to false)</div>
863 <div class="long">True to add a resize handle to the bottom of the dropdown list (defaults to false)</div>
877 <tr class="config-row expandable config-row-alt1 notInherited">
878 <td class="micon"><a class="exi" href="#expand"> </a></td>
881 <a id="Roo.form.ComboBox-cfg-selectOnFocus" name=".selectOnFocus"></a>
882 <div class="fixedFont">
883 <b class="itemname">selectOnFocus</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
889 <div class="short">True to select any existing text in the field immediately on focus.</div>
893 <div class="long">True to select any existing text in the field immediately on focus. Only applies<br/>when editable = true (defaults to false)</div>
907 <tr class="config-row expandable config-row-alt0 notInherited">
908 <td class="micon"><a class="exi" href="#expand"> </a></td>
911 <a id="Roo.form.ComboBox-cfg-selectedClass" name=".selectedClass"></a>
912 <div class="fixedFont">
913 <b class="itemname">selectedClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
919 <div class="short">CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')</div>
923 <div class="long">CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')</div>
937 <tr class="config-row expandable config-row-alt1 notInherited">
938 <td class="micon"><a class="exi" href="#expand"> </a></td>
941 <a id="Roo.form.ComboBox-cfg-shadow" name=".shadow"></a>
942 <div class="fixedFont">
943 <b class="itemname">shadow</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/String
949 <div class="short">True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right</div>
953 <div class="long">True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right</div>
967 <tr class="config-row expandable config-row-alt0 notInherited">
968 <td class="micon"><a class="exi" href="#expand"> </a></td>
971 <a id="Roo.form.ComboBox-cfg-store" name=".store"></a>
972 <div class="fixedFont">
973 <b class="itemname">store</b> : <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
979 <div class="short">The data store to which this combo is bound (defaults to undefined)</div>
983 <div class="long">The data store to which this combo is bound (defaults to undefined)</div>
997 <tr class="config-row expandable config-row-alt1 notInherited">
998 <td class="micon"><a class="exi" href="#expand"> </a></td>
1001 <a id="Roo.form.ComboBox-cfg-title" name=".title"></a>
1002 <div class="fixedFont">
1003 <b class="itemname">title</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1009 <div class="short">If supplied, a header element is created containing this text and added into the top of<br/>the dropdown list (defaults to undefined, with no header element)</div>
1013 <div class="long">If supplied, a header element is created containing this text and added into the top of<br/>the dropdown list (defaults to undefined, with no header element)</div>
1019 <td class="msource">
1027 <tr class="config-row expandable config-row-alt0 notInherited">
1028 <td class="micon"><a class="exi" href="#expand"> </a></td>
1031 <a id="Roo.form.ComboBox-cfg-tpl" name=".tpl"></a>
1032 <div class="fixedFont">
1033 <b class="itemname">tpl</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Roo.Template
1039 <div class="short">The template to use to render the output</div>
1043 <div class="long">The template to use to render the output</div>
1049 <td class="msource">
1057 <tr class="config-row expandable config-row-alt1 notInherited">
1058 <td class="micon"><a class="exi" href="#expand"> </a></td>
1061 <a id="Roo.form.ComboBox-cfg-transform" name=".transform"></a>
1062 <div class="fixedFont">
1063 <b class="itemname">transform</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element
1069 <div class="short">The id, DOM node or element of an existing select to convert to a ComboBox</div>
1073 <div class="long">The id, DOM node or element of an existing select to convert to a ComboBox</div>
1079 <td class="msource">
1087 <tr class="config-row expandable config-row-alt0 notInherited">
1088 <td class="micon"><a class="exi" href="#expand"> </a></td>
1091 <a id="Roo.form.ComboBox-cfg-triggerAction" name=".triggerAction"></a>
1092 <div class="fixedFont">
1093 <b class="itemname">triggerAction</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1099 <div class="short">The action to execute when the trigger field is activated.</div>
1103 <div class="long">The action to execute when the trigger field is activated. Use 'all' to run the<br/>query specified by the allQuery config option (defaults to 'query')</div>
1109 <td class="msource">
1117 <tr class="config-row expandable config-row-alt1 notInherited">
1118 <td class="micon"><a class="exi" href="#expand"> </a></td>
1121 <a id="Roo.form.ComboBox-cfg-triggerClass" name=".triggerClass"></a>
1122 <div class="fixedFont">
1123 <b class="itemname">triggerClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1129 <div class="short">An additional CSS class used to style the trigger button.</div>
1133 <div class="long">An additional CSS class used to style the trigger button. The trigger will always get the<br/>class 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'<br/>which displays a downward arrow icon).</div>
1139 <td class="msource">
1147 <tr class="config-row expandable config-row-alt0 notInherited">
1148 <td class="micon"><a class="exi" href="#expand"> </a></td>
1151 <a id="Roo.form.ComboBox-cfg-typeAhead" name=".typeAhead"></a>
1152 <div class="fixedFont">
1153 <b class="itemname">typeAhead</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1159 <div class="short">True to populate and autoselect the remainder of the text being typed after a configurable<br/>delay (typeAheadDelay) if it matches a known value (defaults to false)</div>
1163 <div class="long">True to populate and autoselect the remainder of the text being typed after a configurable<br/>delay (typeAheadDelay) if it matches a known value (defaults to false)</div>
1169 <td class="msource">
1177 <tr class="config-row expandable config-row-alt1 notInherited">
1178 <td class="micon"><a class="exi" href="#expand"> </a></td>
1181 <a id="Roo.form.ComboBox-cfg-typeAheadDelay" name=".typeAheadDelay"></a>
1182 <div class="fixedFont">
1183 <b class="itemname">typeAheadDelay</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1189 <div class="short">The length of time in milliseconds to wait until the typeahead text is displayed<br/>if typeAhead = true (defaults to 250)</div>
1193 <div class="long">The length of time in milliseconds to wait until the typeahead text is displayed<br/>if typeAhead = true (defaults to 250)</div>
1199 <td class="msource">
1207 <tr class="config-row expandable config-row-alt0 notInherited">
1208 <td class="micon"><a class="exi" href="#expand"> </a></td>
1211 <a id="Roo.form.ComboBox-cfg-valueField" name=".valueField"></a>
1212 <div class="fixedFont">
1213 <b class="itemname">valueField</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1219 <div class="short">The underlying data value name to bind to this CombBox (defaults to undefined if<br/>mode = 'remote' or 'value' if mode = 'local').</div>
1223 <div class="long">The underlying data value name to bind to this CombBox (defaults to undefined if<br/>mode = 'remote' or 'value' if mode = 'local'). <br/>Note: use of a valueField requires the user make a selection<br/>in order for a value to be mapped.</div>
1229 <td class="msource">
1237 <tr class="config-row expandable config-row-alt1 notInherited">
1238 <td class="micon"><a class="exi" href="#expand"> </a></td>
1241 <a id="Roo.form.ComboBox-cfg-valueNotFoundText" name=".valueNotFoundText"></a>
1242 <div class="fixedFont">
1243 <b class="itemname">valueNotFoundText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1249 <div class="short">When using a name/value combo, if the value passed to setValue is not found in<br/>the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)</div>
1253 <div class="long">When using a name/value combo, if the value passed to setValue is not found in<br/>the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)</div>
1259 <td class="msource">
1277 <!-- ============================== public properties ==================== -->
1281 <a id="Roo.form.ComboBox-props"></a>
1287 <table cellspacing="0" class="member-table">
1288 <caption class="Empty">Public Properties - Has None</caption>
1294 <!-- ============================== methods summary / details ======================== -->
1297 <a id="Roo.form.ComboBox-methods"></a>
1298 <!-- constructor?? -->
1305 <!-- then dynamics first -->
1312 <table cellspacing="0" class="member-table">
1313 <caption>Public Methods</caption>
1315 <th class="sig-header" colspan="2">Method</th>
1316 <th class="msource-header">Defined By</th>
1326 <tr class="method-row config-row-alt0 expandable notInherited">
1327 <td class="micon"><a class="exi" href="#expand"> </a></td>
1331 <a id="Roo.form-method-ComboBox" name=".ComboBox"></a>
1332 <div class="fixedFont">
1333 <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">ComboBox</b>
1335 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
1343 <div class="short">Create a new Roo.form.ComboBox</div>
1350 Create a new Roo.form.ComboBox
1353 <dl class="detailList">
1354 <dt class="heading">Parameters:</dt>
1357 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
1360 <dd>Configuration options</dd>
1378 <td class="msource">
1384 <tr class="method-row config-row-alt1 expandable notInherited">
1385 <td class="micon"><a class="exi" href="#expand"> </a></td>
1389 <a id="Roo.form.ComboBox-method-clearValue" name=".clearValue"></a>
1390 <div class="fixedFont">
1391 <span class="attributes"></span><b class="itemname">clearValue</b>
1400 <div class="short">Clears any text/value currently set in the field</div>
1406 Clears any text/value currently set in the field
1427 <td class="msource">
1435 <tr class="method-row config-row-alt0 expandable notInherited">
1436 <td class="micon"><a class="exi" href="#expand"> </a></td>
1440 <a id="Roo.form.ComboBox-method-collapse" name=".collapse"></a>
1441 <div class="fixedFont">
1442 <span class="attributes"></span><b class="itemname">collapse</b>
1451 <div class="short">Hides the dropdown list if it is currently expanded.</div>
1457 Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.
1478 <td class="msource">
1486 <tr class="method-row config-row-alt1 expandable notInherited">
1487 <td class="micon"><a class="exi" href="#expand"> </a></td>
1491 <a id="Roo.form.ComboBox-method-doQuery" name=".doQuery"></a>
1492 <div class="fixedFont">
1493 <span class="attributes"></span><b class="itemname">doQuery</b>
1495 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>query</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>forceAll</i></B>)
1502 <div class="short">Execute a query to filter the dropdown list.</div>
1508 Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the<br/>query allowing the query action to be canceled if needed.
1515 <dl class="detailList">
1516 <dt class="heading">Parameters:</dt>
1519 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>query</b>
1522 <dd>The SQL query to execute</dd>
1525 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>forceAll</b>
1528 <dd>True to force the query to execute even if there are currently fewer characters<br/>in the field than the minimum specified by the minChars config option. It also clears any filter previously<br/>saved in the current store (defaults to false)</dd>
1546 <td class="msource">
1554 <tr class="method-row config-row-alt0 expandable notInherited">
1555 <td class="micon"><a class="exi" href="#expand"> </a></td>
1559 <a id="Roo.form.ComboBox-method-expand" name=".expand"></a>
1560 <div class="fixedFont">
1561 <span class="attributes"></span><b class="itemname">expand</b>
1570 <div class="short">Expands the dropdown list if it is currently hidden.</div>
1576 Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.
1597 <td class="msource">
1605 <tr class="method-row config-row-alt1 expandable notInherited">
1606 <td class="micon"><a class="exi" href="#expand"> </a></td>
1610 <a id="Roo.form.ComboBox-method-getValue" name=".getValue"></a>
1611 <div class="fixedFont">
1612 <span class="attributes"></span><b class="itemname">getValue</b>
1620 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1629 <div class="short">Returns the currently selected field value or empty string if no value is set.</div>
1635 Returns the currently selected field value or empty string if no value is set.
1646 <dl class="detailList">
1647 <dt class="heading">Returns:</dt>
1649 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> value The selected value</dd>
1663 <td class="msource">
1671 <tr class="method-row config-row-alt0 expandable notInherited">
1672 <td class="micon"><a class="exi" href="#expand"> </a></td>
1676 <a id="Roo.form.ComboBox-method-isExpanded" name=".isExpanded"></a>
1677 <div class="fixedFont">
1678 <span class="attributes"></span><b class="itemname">isExpanded</b>
1687 <div class="short">Returns true if the dropdown list is expanded, else false.</div>
1693 Returns true if the dropdown list is expanded, else false.
1714 <td class="msource">
1722 <tr class="method-row config-row-alt1 expandable notInherited">
1723 <td class="micon"><a class="exi" href="#expand"> </a></td>
1727 <a id="Roo.form.ComboBox-method-select" name=".select"></a>
1728 <div class="fixedFont">
1729 <span class="attributes"></span><b class="itemname">select</b>
1731 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>scrollIntoView</i></B>)
1738 <div class="short">Select an item in the dropdown list by its numeric index in the list.</div>
1744 Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.<br/>The store must be loaded and the list expanded for this function to work, otherwise use setValue.
1751 <dl class="detailList">
1752 <dt class="heading">Parameters:</dt>
1755 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
1758 <dd>The zero-based index of the list item to select</dd>
1761 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>scrollIntoView</b>
1764 <dd>False to prevent the dropdown list from autoscrolling to display the<br/>selected item if it is not currently in view (defaults to true)</dd>
1782 <td class="msource">
1790 <tr class="method-row config-row-alt0 expandable notInherited">
1791 <td class="micon"><a class="exi" href="#expand"> </a></td>
1795 <a id="Roo.form.ComboBox-method-selectByValue" name=".selectByValue"></a>
1796 <div class="fixedFont">
1797 <span class="attributes"></span><b class="itemname">selectByValue</b>
1799 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>scrollIntoView</i></B>)
1805 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1814 <div class="short">Select an item in the dropdown list by its data value.</div>
1820 Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.<br/>The store must be loaded and the list expanded for this function to work, otherwise use setValue.
1827 <dl class="detailList">
1828 <dt class="heading">Parameters:</dt>
1831 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
1834 <dd>The data value of the item to select</dd>
1837 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>scrollIntoView</b>
1840 <dd>False to prevent the dropdown list from autoscrolling to display the<br/>selected item if it is not currently in view (defaults to true)</dd>
1848 <dl class="detailList">
1849 <dt class="heading">Returns:</dt>
1851 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the value matched an item in the list, else false</dd>
1865 <td class="msource">
1873 <tr class="method-row config-row-alt1 expandable notInherited">
1874 <td class="micon"><a class="exi" href="#expand"> </a></td>
1878 <a id="Roo.form.ComboBox-method-setEditable" name=".setEditable"></a>
1879 <div class="fixedFont">
1880 <span class="attributes"></span><b class="itemname">setEditable</b>
1882 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>value</i></B>)
1889 <div class="short">Allow or prevent the user from directly editing the field text.</div>
1895 Allow or prevent the user from directly editing the field text. If false is passed,<br/>the user will only be able to select from the items defined in the dropdown list. This method<br/>is the runtime equivalent of setting the 'editable' config option at config time.
1902 <dl class="detailList">
1903 <dt class="heading">Parameters:</dt>
1906 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>value</b>
1909 <dd>True to allow the user to directly edit the field text</dd>
1927 <td class="msource">
1935 <tr class="method-row config-row-alt0 expandable notInherited">
1936 <td class="micon"><a class="exi" href="#expand"> </a></td>
1940 <a id="Roo.form.ComboBox-method-setFromData" name=".setFromData"></a>
1941 <div class="fixedFont">
1942 <span class="attributes"></span><b class="itemname">setFromData</b>
1944 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>value</i></B>)
1951 <div class="short">Sets the value of the field based on a object which is related to the record format for the store.</div>
1957 Sets the value of the field based on a object which is related to the record format for the store.
1964 <dl class="detailList">
1965 <dt class="heading">Parameters:</dt>
1968 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>value</b>
1971 <dd>the value to set as. or false on reset?</dd>
1989 <td class="msource">
1997 <tr class="method-row config-row-alt1 expandable notInherited">
1998 <td class="micon"><a class="exi" href="#expand"> </a></td>
2002 <a id="Roo.form.ComboBox-method-setValue" name=".setValue"></a>
2003 <div class="fixedFont">
2004 <span class="attributes"></span><b class="itemname">setValue</b>
2006 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
2013 <div class="short">Sets the specified value into the field.</div>
2019 Sets the specified value into the field. If the value finds a match, the corresponding record text<br/>will be displayed in the field. If the value does not match the data value of an existing item,<br/>and the valueNotFoundText config option is defined, it will be displayed as the default field text.<br/>Otherwise the field will be blank (although the value will still be set).
2026 <dl class="detailList">
2027 <dt class="heading">Parameters:</dt>
2030 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
2033 <dd>The value to match</dd>
2051 <td class="msource">
2062 <!-- ============================== events summary / details ======================== -->
2065 <a id="Roo.form.ComboBox-events"></a>
2074 <table cellspacing="0" class="member-table">
2075 <caption>Events</caption>
2078 <th class="sig-header" colspan="2">Event</th>
2079 <th class="msource-header">Defined By</th>
2088 <tr class="method-row expandable config-row-alt0 notInherited">
2089 <td class="micon"><a class="exi" href="#expand"> </a></td>
2092 <a id="Roo.form.ComboBox-event-*beforequery"></a>
2094 <div class="fixedFont">
2095 <b class="itemname">beforequery</b> (<a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a> <B><i>combo</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>query</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>forceAll</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>cancel</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>e</i></B>)
2101 <div class="short">Fires before all queries are processed.
2107 Fires before all queries are processed. Return false to cancel the query or set cancel to true.<br/>The event object passed has these properties:
2113 <dl class="detailList">
2114 <dt class="heading">Parameters:</dt>
2117 <span class="fixedFont"><a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a></span> <b>combo</b>
2120 <dd>This combo box</dd>
2123 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>query</b>
2129 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>forceAll</b>
2132 <dd>true to force "all" query</dd>
2135 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>cancel</b>
2138 <dd>true to cancel the query</dd>
2141 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>e</b>
2144 <dd>The query event object</dd>
2162 <td class="msource">
2167 <tr class="method-row expandable config-row-alt1 notInherited">
2168 <td class="micon"><a class="exi" href="#expand"> </a></td>
2171 <a id="Roo.form.ComboBox-event-*beforeselect"></a>
2173 <div class="fixedFont">
2174 <b class="itemname">beforeselect</b> (<a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a> <B><i>combo</i></B>, <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a> <B><i>record</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
2180 <div class="short">Fires before a list item is selected.
2186 Fires before a list item is selected. Return false to cancel the selection.
2192 <dl class="detailList">
2193 <dt class="heading">Parameters:</dt>
2196 <span class="fixedFont"><a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a></span> <b>combo</b>
2199 <dd>This combo box</dd>
2202 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a></span> <b>record</b>
2205 <dd>The data record returned from the underlying store</dd>
2208 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
2211 <dd>The index of the selected item in the dropdown list</dd>
2229 <td class="msource">
2234 <tr class="method-row expandable config-row-alt0 notInherited">
2235 <td class="micon"><a class="exi" href="#expand"> </a></td>
2238 <a id="Roo.form.ComboBox-event-*collapse"></a>
2240 <div class="fixedFont">
2241 <b class="itemname">collapse</b> (<a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a> <B><i>combo</i></B>)
2247 <div class="short">Fires when the dropdown list is collapsed
2253 Fires when the dropdown list is collapsed
2259 <dl class="detailList">
2260 <dt class="heading">Parameters:</dt>
2263 <span class="fixedFont"><a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a></span> <b>combo</b>
2266 <dd>This combo box</dd>
2284 <td class="msource">
2289 <tr class="method-row expandable config-row-alt1 notInherited">
2290 <td class="micon"><a class="exi" href="#expand"> </a></td>
2293 <a id="Roo.form.ComboBox-event-*expand"></a>
2295 <div class="fixedFont">
2296 <b class="itemname">expand</b> (<a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a> <B><i>combo</i></B>)
2302 <div class="short">Fires when the dropdown list is expanded
2308 Fires when the dropdown list is expanded
2314 <dl class="detailList">
2315 <dt class="heading">Parameters:</dt>
2318 <span class="fixedFont"><a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a></span> <b>combo</b>
2321 <dd>This combo box</dd>
2339 <td class="msource">
2344 <tr class="method-row expandable config-row-alt0 notInherited">
2345 <td class="micon"><a class="exi" href="#expand"> </a></td>
2348 <a id="Roo.form.ComboBox-event-*select"></a>
2350 <div class="fixedFont">
2351 <b class="itemname">select</b> (<a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a> <B><i>combo</i></B>, <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a> <B><i>record</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
2357 <div class="short">Fires when a list item is selected
2363 Fires when a list item is selected
2369 <dl class="detailList">
2370 <dt class="heading">Parameters:</dt>
2373 <span class="fixedFont"><a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a></span> <b>combo</b>
2376 <dd>This combo box</dd>
2379 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a></span> <b>record</b>
2382 <dd>The data record returned from the underlying store (or false on clear)</dd>
2385 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
2388 <dd>The index of the selected item in the dropdown list</dd>
2406 <td class="msource">
2418 <!-- ============================== footer ================================= -->
2419 <div class="fineprint" style="clear:both">
2421 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 19:32:53 GMT+0800 (HKT)
2423 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>