git.roojs.org Git - roojs1/blob - docs/symbols/Roo.form.TextField.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.TextField</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.TextField-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.form.TextField-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.form.TextField-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.form.TextField-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.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.TextField
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.form.TextField
  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_TextField.js.html">Roo/form/TextField.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">TextField</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         Basic text field.  Can be used as a direct replacement for traditional text inputs, or as the base<br/>class for more sophisticated input controls (like {<b>link</b> Roo.form.TextArea} and {<b>link</b> Roo.form.ComboBox}).
  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.TextField';">[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.TextField.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.form.TextField-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.TextField-cfg-allowBlank" name=".allowBlank"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">allowBlank</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">False to validate that the value length > 0 (defaults to true)</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">False to validate that the value length > 0 (defaults to true)</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.form.TextField
 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.TextField-cfg-blankText" name=".blankText"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">blankText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">Error text to display if the allow blank validation fails (defaults to "This field is required")</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">Error text to display if the allow blank validation fails (defaults to "This field is required")</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.form.TextField
 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.TextField-cfg-disableKeyFilter" name=".disableKeyFilter"></a>
 192                         <div class="fixedFont">
 193                                 <b  class="itemname">disableKeyFilter</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 199                             <div class="short">True to disable input keystroke filtering (defaults to false)</div>
 200                         </div>
 201
 202                         <div class="mdesc">
 203                             <div class="long">True to disable input keystroke filtering (defaults to false)</div>
 204                         </div>
 205
 206
 207
 208                     </td>
 209                     <td class="msource">
 210
 211                         Roo.form.TextField
 212
 213                     </td>
 214                 </tr>
 215
 216
 217                 <tr class="config-row expandable config-row-alt1 notInherited">
 218                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 219                     <td class="sig">
 220
 221                         <a id="Roo.form.TextField-cfg-emptyClass" name=".emptyClass"></a>
 222                         <div class="fixedFont">
 223                                 <b  class="itemname">emptyClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 224
 225
 226                         </div>
 227
 228                         <div class="mdesc">
 229                             <div class="short">The CSS class to apply to an empty field to style the {<b>link</b> <b>emptyText</b>} (defaults to<br/>'x-form-empty-field').</div>
 230                         </div>
 231
 232                         <div class="mdesc">
 233                             <div class="long">The CSS class to apply to an empty field to style the {<b>link</b> <b>emptyText</b>} (defaults to<br/>'x-form-empty-field').  This class is automatically added and removed as needed depending on the current field value.</div>
 234                         </div>
 235
 236
 237
 238                     </td>
 239                     <td class="msource">
 240
 241                         Roo.form.TextField
 242
 243                     </td>
 244                 </tr>
 245
 246
 247                 <tr class="config-row expandable config-row-alt0 notInherited">
 248                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 249                     <td class="sig">
 250
 251                         <a id="Roo.form.TextField-cfg-emptyText" name=".emptyText"></a>
 252                         <div class="fixedFont">
 253                                 <b  class="itemname">emptyText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 254
 255
 256                         </div>
 257
 258                         <div class="mdesc">
 259                             <div class="short">The default text to display in an empty field (defaults to null).</div>
 260                         </div>
 261
 262                         <div class="mdesc">
 263                             <div class="long">The default text to display in an empty field (defaults to null).</div>
 264                         </div>
 265
 266
 267
 268                     </td>
 269                     <td class="msource">
 270
 271                         Roo.form.TextField
 272
 273                     </td>
 274                 </tr>
 275
 276
 277                 <tr class="config-row expandable config-row-alt1 notInherited">
 278                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 279                     <td class="sig">
 280
 281                         <a id="Roo.form.TextField-cfg-grow" name=".grow"></a>
 282                         <div class="fixedFont">
 283                                 <b  class="itemname">grow</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 284
 285
 286                         </div>
 287
 288                         <div class="mdesc">
 289                             <div class="short">True if this field should automatically grow and shrink to its content</div>
 290                         </div>
 291
 292                         <div class="mdesc">
 293                             <div class="long">True if this field should automatically grow and shrink to its content</div>
 294                         </div>
 295
 296
 297
 298                     </td>
 299                     <td class="msource">
 300
 301                         Roo.form.TextField
 302
 303                     </td>
 304                 </tr>
 305
 306
 307                 <tr class="config-row expandable config-row-alt0 notInherited">
 308                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 309                     <td class="sig">
 310
 311                         <a id="Roo.form.TextField-cfg-growMax" name=".growMax"></a>
 312                         <div class="fixedFont">
 313                                 <b  class="itemname">growMax</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 314
 315
 316                         </div>
 317
 318                         <div class="mdesc">
 319                             <div class="short">The maximum width to allow when grow = true (defaults to 800)</div>
 320                         </div>
 321
 322                         <div class="mdesc">
 323                             <div class="long">The maximum width to allow when grow = true (defaults to 800)</div>
 324                         </div>
 325
 326
 327
 328                     </td>
 329                     <td class="msource">
 330
 331                         Roo.form.TextField
 332
 333                     </td>
 334                 </tr>
 335
 336
 337                 <tr class="config-row expandable config-row-alt1 notInherited">
 338                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 339                     <td class="sig">
 340
 341                         <a id="Roo.form.TextField-cfg-growMin" name=".growMin"></a>
 342                         <div class="fixedFont">
 343                                 <b  class="itemname">growMin</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 344
 345
 346                         </div>
 347
 348                         <div class="mdesc">
 349                             <div class="short">The minimum width to allow when grow = true (defaults to 30)</div>
 350                         </div>
 351
 352                         <div class="mdesc">
 353                             <div class="long">The minimum width to allow when grow = true (defaults to 30)</div>
 354                         </div>
 355
 356
 357
 358                     </td>
 359                     <td class="msource">
 360
 361                         Roo.form.TextField
 362
 363                     </td>
 364                 </tr>
 365
 366
 367                 <tr class="config-row expandable config-row-alt0 notInherited">
 368                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 369                     <td class="sig">
 370
 371                         <a id="Roo.form.TextField-cfg-maskRe" name=".maskRe"></a>
 372                         <div class="fixedFont">
 373                                 <b  class="itemname">maskRe</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 374
 375
 376                         </div>
 377
 378                         <div class="mdesc">
 379                             <div class="short">An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)</div>
 380                         </div>
 381
 382                         <div class="mdesc">
 383                             <div class="long">An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)</div>
 384                         </div>
 385
 386
 387
 388                     </td>
 389                     <td class="msource">
 390
 391                         Roo.form.TextField
 392
 393                     </td>
 394                 </tr>
 395
 396
 397                 <tr class="config-row expandable config-row-alt1 notInherited">
 398                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 399                     <td class="sig">
 400
 401                         <a id="Roo.form.TextField-cfg-maxLength" name=".maxLength"></a>
 402                         <div class="fixedFont">
 403                                 <b  class="itemname">maxLength</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 404
 405
 406                         </div>
 407
 408                         <div class="mdesc">
 409                             <div class="short">Maximum input field length allowed (defaults to Number.MAX_VALUE)</div>
 410                         </div>
 411
 412                         <div class="mdesc">
 413                             <div class="long">Maximum input field length allowed (defaults to Number.MAX_VALUE)</div>
 414                         </div>
 415
 416
 417
 418                     </td>
 419                     <td class="msource">
 420
 421                         Roo.form.TextField
 422
 423                     </td>
 424                 </tr>
 425
 426
 427                 <tr class="config-row expandable config-row-alt0 notInherited">
 428                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 429                     <td class="sig">
 430
 431                         <a id="Roo.form.TextField-cfg-maxLengthText" name=".maxLengthText"></a>
 432                         <div class="fixedFont">
 433                                 <b  class="itemname">maxLengthText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 434
 435
 436                         </div>
 437
 438                         <div class="mdesc">
 439                             <div class="short">Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxLength}")</div>
 440                         </div>
 441
 442                         <div class="mdesc">
 443                             <div class="long">Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxLength}")</div>
 444                         </div>
 445
 446
 447
 448                     </td>
 449                     <td class="msource">
 450
 451                         Roo.form.TextField
 452
 453                     </td>
 454                 </tr>
 455
 456
 457                 <tr class="config-row expandable config-row-alt1 notInherited">
 458                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 459                     <td class="sig">
 460
 461                         <a id="Roo.form.TextField-cfg-minLength" name=".minLength"></a>
 462                         <div class="fixedFont">
 463                                 <b  class="itemname">minLength</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 464
 465
 466                         </div>
 467
 468                         <div class="mdesc">
 469                             <div class="short">Minimum input field length required (defaults to 0)</div>
 470                         </div>
 471
 472                         <div class="mdesc">
 473                             <div class="long">Minimum input field length required (defaults to 0)</div>
 474                         </div>
 475
 476
 477
 478                     </td>
 479                     <td class="msource">
 480
 481                         Roo.form.TextField
 482
 483                     </td>
 484                 </tr>
 485
 486
 487                 <tr class="config-row expandable config-row-alt0 notInherited">
 488                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 489                     <td class="sig">
 490
 491                         <a id="Roo.form.TextField-cfg-minLengthText" name=".minLengthText"></a>
 492                         <div class="fixedFont">
 493                                 <b  class="itemname">minLengthText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 494
 495
 496                         </div>
 497
 498                         <div class="mdesc">
 499                             <div class="short">Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minLength}")</div>
 500                         </div>
 501
 502                         <div class="mdesc">
 503                             <div class="long">Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minLength}")</div>
 504                         </div>
 505
 506
 507
 508                     </td>
 509                     <td class="msource">
 510
 511                         Roo.form.TextField
 512
 513                     </td>
 514                 </tr>
 515
 516
 517                 <tr class="config-row expandable config-row-alt1 notInherited">
 518                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 519                     <td class="sig">
 520
 521                         <a id="Roo.form.TextField-cfg-regex" name=".regex"></a>
 522                         <div class="fixedFont">
 523                                 <b  class="itemname">regex</b> : RegExp
 524
 525
 526                         </div>
 527
 528                         <div class="mdesc">
 529                             <div class="short">A JavaScript RegExp object to be tested against the field value during validation (defaults to null).</div>
 530                         </div>
 531
 532                         <div class="mdesc">
 533                             <div class="long">A JavaScript RegExp object to be tested against the field value during validation (defaults to null).<br/>If available, this regex will be evaluated only after the basic validators all return true, and will be passed the<br/>current field value.  If the test fails, the field will be marked invalid using {<b>link</b> <b>regexText</b>}.</div>
 534                         </div>
 535
 536
 537
 538                     </td>
 539                     <td class="msource">
 540
 541                         Roo.form.TextField
 542
 543                     </td>
 544                 </tr>
 545
 546
 547                 <tr class="config-row expandable config-row-alt0 notInherited">
 548                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 549                     <td class="sig">
 550
 551                         <a id="Roo.form.TextField-cfg-regexText" name=".regexText"></a>
 552                         <div class="fixedFont">
 553                                 <b  class="itemname">regexText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 554
 555
 556                         </div>
 557
 558                         <div class="mdesc">
 559                             <div class="short">The error text to display if {<b>link</b> <b>regex</b>} is used and the test fails during validation (defaults to "")</div>
 560                         </div>
 561
 562                         <div class="mdesc">
 563                             <div class="long">The error text to display if {<b>link</b> <b>regex</b>} is used and the test fails during validation (defaults to "")</div>
 564                         </div>
 565
 566
 567
 568                     </td>
 569                     <td class="msource">
 570
 571                         Roo.form.TextField
 572
 573                     </td>
 574                 </tr>
 575
 576
 577                 <tr class="config-row expandable config-row-alt1 notInherited">
 578                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 579                     <td class="sig">
 580
 581                         <a id="Roo.form.TextField-cfg-selectOnFocus" name=".selectOnFocus"></a>
 582                         <div class="fixedFont">
 583                                 <b  class="itemname">selectOnFocus</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 584
 585
 586                         </div>
 587
 588                         <div class="mdesc">
 589                             <div class="short">True to automatically select any existing field text when the field receives input focus (defaults to false)</div>
 590                         </div>
 591
 592                         <div class="mdesc">
 593                             <div class="long">True to automatically select any existing field text when the field receives input focus (defaults to false)</div>
 594                         </div>
 595
 596
 597
 598                     </td>
 599                     <td class="msource">
 600
 601                         Roo.form.TextField
 602
 603                     </td>
 604                 </tr>
 605
 606
 607                 <tr class="config-row expandable config-row-alt0 notInherited">
 608                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 609                     <td class="sig">
 610
 611                         <a id="Roo.form.TextField-cfg-validator" name=".validator"></a>
 612                         <div class="fixedFont">
 613                                 <b  class="itemname">validator</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
 614
 615
 616                         </div>
 617
 618                         <div class="mdesc">
 619                             <div class="short">A custom validation function to be called during field validation (defaults to null).</div>
 620                         </div>
 621
 622                         <div class="mdesc">
 623                             <div class="long">A custom validation function to be called during field validation (defaults to null).<br/>If available, this function will be called only after the basic validators all return true, and will be passed the<br/>current field value and expected to return boolean true if the value is valid or a string error message if invalid.</div>
 624                         </div>
 625
 626
 627
 628                     </td>
 629                     <td class="msource">
 630
 631                         Roo.form.TextField
 632
 633                     </td>
 634                 </tr>
 635
 636
 637                 <tr class="config-row expandable config-row-alt1 notInherited">
 638                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 639                     <td class="sig">
 640
 641                         <a id="Roo.form.TextField-cfg-vtype" name=".vtype"></a>
 642                         <div class="fixedFont">
 643                                 <b  class="itemname">vtype</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 644
 645
 646                         </div>
 647
 648                         <div class="mdesc">
 649                             <div class="short">A validation type name as defined in {<b>link</b> Roo.form.VTypes} (defaults to null)</div>
 650                         </div>
 651
 652                         <div class="mdesc">
 653                             <div class="long">A validation type name as defined in {<b>link</b> Roo.form.VTypes} (defaults to null)</div>
 654                         </div>
 655
 656
 657
 658                     </td>
 659                     <td class="msource">
 660
 661                         Roo.form.TextField
 662
 663                     </td>
 664                 </tr>
 665
 666
 667     </table>
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677   <!-- ============================== public properties ==================== -->
 678
 679
 680
 681     <a id="Roo.form.TextField-props"></a>
 682
 683
 684
 685
 686
 687      <table cellspacing="0" class="member-table">
 688       <caption class="Empty">Public Properties - Has None</caption>
 689      </table>
 690
 691
 692
 693
 694   <!-- ============================== methods summary / details ======================== -->
 695
 696
 697   <a id="Roo.form.TextField-methods"></a>
 698         <!-- constructor?? -->
 699
 700         <!-- static's first
 701
 702
 703         -->
 704
 705         <!-- then dynamics first -->
 706
 707
 708
 709
 710
 711
 712       <table cellspacing="0" class="member-table">
 713       <caption>Public Methods</caption>
 714         <tr>
 715             <th class="sig-header" colspan="2">Method</th>
 716             <th class="msource-header">Defined By</th>
 717
 718         </tr>
 719
 720
 721
 722
 723
 724
 725
 726           <tr class="method-row config-row-alt0 expandable notInherited">
 727             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 728
 729
 730             <td class="sig">
 731                 <a id="Roo.form-method-TextField"   name=".TextField"></a>
 732                 <div class="fixedFont">
 733                         <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">TextField</b>
 734
 735                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 736
 737
 738
 739                 </div>
 740                 <div class="mdesc">
 741
 742
 743                         <div class="short">Create a new Roo.form.TextField</div>
 744
 745
 746                     <div class="long">
 747
 748
 749
 750                                 Create a new Roo.form.TextField
 751
 752
 753                                 <dl class="detailList">
 754                                 <dt class="heading">Parameters:</dt>
 755
 756                                         <dt>
 757                                                 <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>
 758
 759                                         </dt>
 760                                         <dd>Configuration options</dd>
 761
 762                                 </dl>
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774                     </div>
 775                 </div>
 776
 777             </td>
 778             <td class="msource">
 779                 &nbsp;
 780             </td>
 781         </tr>
 782
 783
 784           <tr class="method-row config-row-alt1 expandable notInherited">
 785             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 786
 787
 788             <td class="sig">
 789                 <a id="Roo.form.TextField-method-autoSize"   name=".autoSize"></a>
 790                 <div class="fixedFont">
 791                         <span class="attributes"></span><b class="itemname">autoSize</b>
 792
 793                                  ()
 794
 795
 796
 797                 </div>
 798                 <div class="mdesc">
 799
 800                    <div class="short">Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.</div>
 801
 802
 803
 804                     <div class="long">
 805
 806                                 Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.<br/>This only takes effect if grow = true, and fires the autosize event.
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823                     </div>
 824                 </div>
 825
 826             </td>
 827             <td class="msource">
 828
 829                         Roo.form.TextField
 830                 &nbsp;
 831             </td>
 832         </tr>
 833
 834
 835           <tr class="method-row config-row-alt0 expandable notInherited">
 836             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 837
 838
 839             <td class="sig">
 840                 <a id="Roo.form.TextField-method-reset"   name=".reset"></a>
 841                 <div class="fixedFont">
 842                         <span class="attributes"></span><b class="itemname">reset</b>
 843
 844                                  ()
 845
 846
 847
 848                 </div>
 849                 <div class="mdesc">
 850
 851                    <div class="short">Resets the current field value to the originally-loaded value and clears any validation messages.</div>
 852
 853
 854
 855                     <div class="long">
 856
 857                                 Resets the current field value to the originally-loaded value and clears any validation messages.<br/>Also adds emptyText and emptyClass if the original value was blank.
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874                     </div>
 875                 </div>
 876
 877             </td>
 878             <td class="msource">
 879
 880                         Roo.form.TextField
 881                 &nbsp;
 882             </td>
 883         </tr>
 884
 885
 886           <tr class="method-row config-row-alt1 expandable notInherited">
 887             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 888
 889
 890             <td class="sig">
 891                 <a id="Roo.form.TextField-method-selectText"   name=".selectText"></a>
 892                 <div class="fixedFont">
 893                         <span class="attributes"></span><b class="itemname">selectText</b>
 894
 895                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>start</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>end</i></B>)
 896
 897
 898
 899                 </div>
 900                 <div class="mdesc">
 901
 902                    <div class="short">Selects text in this field</div>
 903
 904
 905
 906                     <div class="long">
 907
 908                                 Selects text in this field
 909
 910
 911
 912
 913
 914
 915                                 <dl class="detailList">
 916                                 <dt class="heading">Parameters:</dt>
 917
 918                                         <dt>
 919                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>start</b>
 920
 921                                         </dt>
 922                                         <dd>(optional) The index where the selection should start (defaults to 0)</dd>
 923
 924                                         <dt>
 925                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>end</b>
 926
 927                                         </dt>
 928                                         <dd>(optional) The index where the selection should end (defaults to the text length)</dd>
 929
 930                                 </dl>
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942                     </div>
 943                 </div>
 944
 945             </td>
 946             <td class="msource">
 947
 948                         Roo.form.TextField
 949                 &nbsp;
 950             </td>
 951         </tr>
 952
 953
 954           <tr class="method-row config-row-alt0 expandable notInherited">
 955             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 956
 957
 958             <td class="sig">
 959                 <a id="Roo.form.TextField-method-validateValue"   name=".validateValue"></a>
 960                 <div class="fixedFont">
 961                         <span class="attributes"></span><b class="itemname">validateValue</b>
 962
 963                                  (Mixed <B><i>value</i></B>)
 964
 965
 966                                          :
 967
 968
 969                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 970
 971
 972
 973
 974
 975                 </div>
 976                 <div class="mdesc">
 977
 978                    <div class="short">Validates a value according to the field's validation rules and marks the field as invalid<br/>if the validation fails</div>
 979
 980
 981
 982                     <div class="long">
 983
 984                                 Validates a value according to the field's validation rules and marks the field as invalid<br/>if the validation fails
 985
 986
 987
 988
 989
 990
 991                                 <dl class="detailList">
 992                                 <dt class="heading">Parameters:</dt>
 993
 994                                         <dt>
 995                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
 996
 997                                         </dt>
 998                                         <dd>The value to validate</dd>
 999
1000                                 </dl>
1001
1002
1003
1004
1005
1006                                 <dl class="detailList">
1007                                 <dt class="heading">Returns:</dt>
1008
1009                                         <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 is valid, else false</dd>
1010
1011                                 </dl>
1012
1013
1014
1015
1016
1017
1018
1019                     </div>
1020                 </div>
1021
1022             </td>
1023             <td class="msource">
1024
1025                         Roo.form.TextField
1026                 &nbsp;
1027             </td>
1028         </tr>
1029
1030
1031     </table>
1032
1033
1034   <!-- ============================== events summary / details ======================== -->
1035
1036
1037   <a id="Roo.form.TextField-events"></a>
1038
1039
1040
1041
1042
1043
1044
1045
1046       <table cellspacing="0" class="member-table">
1047                 <caption>Events</caption>
1048               <thead>
1049                 <tr>
1050                     <th class="sig-header" colspan="2">Event</th>
1051                     <th class="msource-header">Defined By</th>
1052
1053                 </tr>
1054               </thead>
1055
1056
1057
1058
1059
1060           <tr class="method-row expandable config-row-alt0 notInherited">
1061             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1062
1063             <td class="sig">
1064                 <a id="Roo.form.TextField-event-*autosize"></a>
1065
1066                <div class="fixedFont">
1067                 <b class="itemname">autosize</b> (<a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>width</i></B>)
1068
1069                 </div>
1070
1071                 <div class="mdesc">
1072
1073                    <div class="short">Fires when the autosize function is triggered.
1074
1075                 </div>
1076
1077                     <div class="long">
1078
1079                         Fires when the autosize function is triggered.  The field may or may not have actually changed size<br/>according to the default logic, but this event provides a hook for the developer to apply additional<br/>logic at runtime to resize the field if needed.
1080
1081
1082
1083
1084
1085                                 <dl class="detailList">
1086                                 <dt class="heading">Parameters:</dt>
1087
1088                                         <dt>
1089                                                 <span class="fixedFont"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a></span> <b>this</b>
1090
1091                                         </dt>
1092                                         <dd>This text field</dd>
1093
1094                                         <dt>
1095                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>width</b>
1096
1097                                         </dt>
1098                                         <dd>The new field width</dd>
1099
1100                                 </dl>
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112                     </div>
1113                 </div>
1114
1115             </td>
1116             <td class="msource">
1117                 Roo.form.TextField
1118             </td>
1119         </tr>
1120
1121
1122     </table>
1123
1124
1125
1126
1127
1128 <!-- ============================== footer ================================= -->
1129                 <div class="fineprint" style="clear:both">
1130
1131                         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)
1132                         Based on
1133                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1134                 </div>
1135         </body>
1136 </html>