git.roojs.org Git - roojs1/blob - docs/symbols/Roo.form.TriggerField.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5
   6         <head>
   7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
   8                 <meta name="generator" content="JsDoc Toolkit" />
   9
  10
  11                 <title>JsDoc Reference - Roo.form.TriggerField</title>
  12
  13
  14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
  15         <link rel="stylesheet" type="text/css" href="../default.css" />
  16
  17
  18         <script type="text/javascript" src="../page.js">
  19
  20         </script>
  21
  22
  23         </head>
  24
  25         <body onload="RooDocsPage.onload();">
  26
  27
  28 <div class="body-wrap">
  29
  30     <!-- ============================== links to methods. ================================= -->
  31
  32     <div class="top-tools">
  33     <!--
  34         <a class="inner-link" href="#Roo.form.TriggerField-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.form.TriggerField-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.form.TriggerField-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.form.TriggerField-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>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45                 <div class="inheritance res-block">
  46                    <pre class="res-block-inner"><a href="./Roo.form.TextField.html#constructor" roo:cls="Roo.form.TextField.html#constructor">Roo.form.TextField</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.TriggerField
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.form.TriggerField
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_form_TriggerField.js.html">Roo/form/TriggerField.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">TriggerField</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.form.TextField.html#constructor" roo:cls="Roo.form.TextField.html#constructor">Roo.form.TextField</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default).<br/>The trigger has no default action, so you must assign a function to implement the trigger click handler by<br/>overriding {<b>link</b> <b>onTriggerClick</b>}. You can create a TriggerField directly, as it renders exactly like a combobox<br/>for which you can provide a custom implementation.  For example:<br/><pre><code><br/>var trigger = new Roo.form.TriggerField();<br/>trigger.onTriggerClick = myTriggerFn;<br/>trigger.applyTo('my-field');<br/></code></pre><br/><br/>However, in general you will most likely want to use TriggerField as the base class for a reusable component.<br/>{<b>link</b> Roo.form.DateField} and {<b>link</b> Roo.form.ComboBox} are perfect examples of this.
  86     </div>
  87
  88
  89 <!-- ============================== Class comment block... ========================== -->
  90
  91 <div class="comments">
  92         <b>Class Comments / Notes</B> =>
  93         <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.TriggerField';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo.form" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.form.TriggerField.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.form.TriggerField-configs"></a>
 108
 109
 110
 111
 112
 113       <table cellspacing="0" class="member-table">
 114       <caption>Config Options (Usually are also Properties)</caption>
 115
 116
 117         <tr>
 118             <th class="sig-header" colspan="2">Options</th>
 119
 120             <th class="msource-header">Defined By</th>
 121         </tr>
 122
 123
 124
 125
 126
 127                 <tr class="config-row expandable config-row-alt0 notInherited">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 131                         <a id="Roo.form.TriggerField-cfg-autoCreate" name=".autoCreate"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">autoCreate</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">A DomHelper element spec, or true for a default element spec (defaults to<br/>{tag: "input", type: "text", size: "16", autocomplete: "off"})</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">A DomHelper element spec, or true for a default element spec (defaults to<br/>{tag: "input", type: "text", size: "16", autocomplete: "off"})</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.form.TriggerField
 152
 153                     </td>
 154                 </tr>
 155
 156
 157                 <tr class="config-row expandable config-row-alt1 notInherited">
 158                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 159                     <td class="sig">
 160
 161                         <a id="Roo.form.TriggerField-cfg-hideTrigger" name=".hideTrigger"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">hideTrigger</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">True to hide the trigger element and display only the base text field (defaults to false)</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">True to hide the trigger element and display only the base text field (defaults to false)</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.form.TriggerField
 182
 183                     </td>
 184                 </tr>
 185
 186
 187                 <tr class="config-row expandable config-row-alt0 notInherited">
 188                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 189                     <td class="sig">
 190
 191                         <a id="Roo.form.TriggerField-cfg-triggerClass" name=".triggerClass"></a>
 192                         <div class="fixedFont">
 193                                 <b  class="itemname">triggerClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 199                             <div class="short">An additional CSS class used to style the trigger button.</div>
 200                         </div>
 201
 202                         <div class="mdesc">
 203                             <div class="long">An additional CSS class used to style the trigger button.  The trigger will always get the<br/>class 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.</div>
 204                         </div>
 205
 206
 207
 208                     </td>
 209                     <td class="msource">
 210
 211                         Roo.form.TriggerField
 212
 213                     </td>
 214                 </tr>
 215
 216
 217     </table>
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227   <!-- ============================== public properties ==================== -->
 228
 229
 230
 231     <a id="Roo.form.TriggerField-props"></a>
 232
 233
 234
 235
 236
 237      <table cellspacing="0" class="member-table">
 238       <caption class="Empty">Public Properties - Has None</caption>
 239      </table>
 240
 241
 242
 243
 244   <!-- ============================== methods summary / details ======================== -->
 245
 246
 247   <a id="Roo.form.TriggerField-methods"></a>
 248         <!-- constructor?? -->
 249
 250         <!-- static's first
 251
 252
 253         -->
 254
 255         <!-- then dynamics first -->
 256
 257
 258
 259
 260
 261
 262       <table cellspacing="0" class="member-table">
 263       <caption>Public Methods</caption>
 264         <tr>
 265             <th class="sig-header" colspan="2">Method</th>
 266             <th class="msource-header">Defined By</th>
 267
 268         </tr>
 269
 270
 271
 272
 273
 274
 275
 276           <tr class="method-row config-row-alt0 expandable notInherited">
 277             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 278
 279
 280             <td class="sig">
 281                 <a id="Roo.form-method-TriggerField"   name=".TriggerField"></a>
 282                 <div class="fixedFont">
 283                         <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">TriggerField</b>
 284
 285                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 286
 287
 288
 289                 </div>
 290                 <div class="mdesc">
 291
 292
 293                         <div class="short">Create a new Roo.form.TriggerField</div>
 294
 295
 296                     <div class="long">
 297
 298
 299
 300                                 Create a new Roo.form.TriggerField
 301
 302
 303                                 <dl class="detailList">
 304                                 <dt class="heading">Parameters:</dt>
 305
 306                                         <dt>
 307                                                 <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>
 308
 309                                         </dt>
 310                                         <dd>Configuration options (valid {<b>Roo</b>.form.TextField} config options will also be applied<br/>to the base TextField)</dd>
 311
 312                                 </dl>
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324                     </div>
 325                 </div>
 326
 327             </td>
 328             <td class="msource">
 329                 &nbsp;
 330             </td>
 331         </tr>
 332
 333
 334           <tr class="method-row config-row-alt1 expandable notInherited">
 335             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 336
 337
 338             <td class="sig">
 339                 <a id="Roo.form.TriggerField-method-autoSize"   name=".autoSize"></a>
 340                 <div class="fixedFont">
 341                         <span class="attributes"></span><b class="itemname">autoSize</b>
 342
 343                                  ()
 344
 345
 346
 347                 </div>
 348                 <div class="mdesc">
 349
 350                    <div class="short"></div>
 351
 352
 353
 354                     <div class="long">
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373                     </div>
 374                 </div>
 375
 376             </td>
 377             <td class="msource">
 378
 379                         Roo.form.TriggerField
 380                 &nbsp;
 381             </td>
 382         </tr>
 383
 384
 385           <tr class="method-row config-row-alt0 expandable notInherited">
 386             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 387
 388
 389             <td class="sig">
 390                 <a id="Roo.form.TriggerField-method-onTriggerClick"   name=".onTriggerClick"></a>
 391                 <div class="fixedFont">
 392                         <span class="attributes"></span><b class="itemname">onTriggerClick</b>
 393
 394                                  (EventObject <B><i>e</i></B>)
 395
 396
 397
 398                 </div>
 399                 <div class="mdesc">
 400
 401                    <div class="short">The function that should handle the trigger's click event.</div>
 402
 403
 404
 405                     <div class="long">
 406
 407                                 The function that should handle the trigger's click event.  This method does nothing by default until overridden<br/>by an implementing function.
 408
 409
 410
 411
 412
 413
 414                                 <dl class="detailList">
 415                                 <dt class="heading">Parameters:</dt>
 416
 417                                         <dt>
 418                                                 <span class="fixedFont">EventObject</span>  <b>e</b>
 419
 420                                         </dt>
 421                                         <dd></dd>
 422
 423                                 </dl>
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435                     </div>
 436                 </div>
 437
 438             </td>
 439             <td class="msource">
 440
 441                         Roo.form.TriggerField
 442                 &nbsp;
 443             </td>
 444         </tr>
 445
 446
 447     </table>
 448
 449
 450   <!-- ============================== events summary / details ======================== -->
 451
 452
 453   <a id="Roo.form.TriggerField-events"></a>
 454
 455
 456
 457
 458
 459      <table cellspacing="0" class="member-table">
 460       <caption class="Empty">Events - Has None</caption>
 461      </table>
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471 <!-- ============================== footer ================================= -->
 472                 <div class="fineprint" style="clear:both">
 473
 474                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:43:12 GMT+0800 (HKT)
 475                         Based on
 476                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 477                 </div>
 478         </body>
 479 </html>