git.roojs.org Git - roojs1/blob - docs.old/symbols/Roo.form.Form.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.Form</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.Form-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.form.Form-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.form.Form-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.form.Form-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.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  47 <img src="../../images/default/s.gif" height="1" width="20"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
  48 <img src="../../images/default/s.gif" height="1"  width="40"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.Form
  49
  50                    </pre>
  51                 </div>
  52
  53 <!-- ============================== class title / details ============================ -->
  54
  55
  56     <h1 class="classTitle">
  57
  58                                 Class Roo.form.Form
  59                         </h1>
  60
  61     <table cellspacing="0" class="class-summary-table">
  62
  63                 <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
  64
  65         <tr><td class="label">Defined In:</td><td class="hd-info">
  66
  67                                         <a href="./src/Roo_form_Form.js.html">Roo/form/Form.js</a>.
  68
  69         </td></tr>
  70         <tr><td class="label">Class:</td><td class="hd-info">Form</td></tr>
  71
  72
  73
  74
  75                 <tr><td class="label">Extends:</td><td class="hd-info">
  76                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
  77
  78                 </td></tr>
  79
  80
  81     </table>
  82
  83
  84 <!-- ============================== class summary ========================== -->
  85     <div class="description">
  86         Adds the ability to dynamically render forms with JavaScript to {<b>link</b> Roo.form.BasicForm}.
  87     </div>
  88
  89
  90 <!-- ============================== Class comment block... ========================== -->
  91
  92 <div class="comments">
  93         <b>Class Comments / Notes</B> =>
  94         <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.Form';">[Add Your comment/notes about this class]</u>
  95         <br/>
  96         <iframe frameborder="0"  id="comments-Roo.form" style="border: none;width:100%;"
  97                 src="/blog.php/GtkDjsComments/Roo.form.Form.html"></iframe>
  98 </div>
  99
 100
 101
 102 <!-- ============================== config options ========================== -->
 103
 104
 105
 106
 107     <div class="hr"></div>
 108     <a id="Roo.form.Form-configs"></a>
 109
 110
 111
 112
 113
 114       <table cellspacing="0" class="member-table">
 115       <caption>Config Options (Usually are also Properties)</caption>
 116
 117
 118         <tr>
 119             <th class="sig-header" colspan="2">Options</th>
 120
 121             <th class="msource-header">Defined By</th>
 122         </tr>
 123
 124
 125
 126
 127
 128                 <tr class="config-row expandable config-row-alt0">
 129                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 130                     <td class="sig">
 131
 132                         <a id="Roo.form.BasicForm-cfg-baseParams" name=".baseParams"></a>
 133                         <div class="fixedFont">
 134                                 <b  class="itemname">baseParams</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 135
 136
 137                         </div>
 138
 139                         <div class="mdesc">
 140                             <div class="short">Parameters to pass with all requests.</div>
 141                         </div>
 142
 143                         <div class="mdesc">
 144                             <div class="long">
 145                     Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.
 146
 147                 </div>
 148                         </div>
 149
 150
 151
 152                     </td>
 153                     <td class="msource">
 154
 155                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
 156
 157                     </td>
 158                 </tr>
 159
 160
 161                 <tr class="config-row expandable config-row-alt1 notInherited">
 162                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 163                     <td class="sig">
 164
 165                         <a id="Roo.form.Form-cfg-buttonAlign" name=".buttonAlign"></a>
 166                         <div class="fixedFont">
 167                                 <b  class="itemname">buttonAlign</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 168
 169
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="short">Valid values are "left," "center" and "right" (defaults to "center")</div>
 174                         </div>
 175
 176                         <div class="mdesc">
 177                             <div class="long">
 178                     Valid values are "left," "center" and "right" (defaults to "center")
 179
 180                 </div>
 181                         </div>
 182
 183
 184
 185                     </td>
 186                     <td class="msource">
 187
 188                         Roo.form.Form
 189
 190                     </td>
 191                 </tr>
 192
 193
 194                 <tr class="config-row expandable config-row-alt0">
 195                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 196                     <td class="sig">
 197
 198                         <a id="Roo.form.BasicForm-cfg-errorReader" name=".errorReader"></a>
 199                         <div class="fixedFont">
 200                                 <b  class="itemname">errorReader</b> : DataReader
 201
 202
 203                         </div>
 204
 205                         <div class="mdesc">
 206                             <div class="short">An Roo.data.DataReader (e.g.</div>
 207                         </div>
 208
 209                         <div class="mdesc">
 210                             <div class="long">
 211                     An Roo.data.DataReader (e.g. {<b>link</b> Roo.data.XmlReader}) to be used to read data when reading validation errors on "submit" actions.<br/>This is completely optional as there is built-in support for processing JSON.
 212
 213                 </div>
 214                         </div>
 215
 216
 217
 218                     </td>
 219                     <td class="msource">
 220
 221                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
 222
 223                     </td>
 224                 </tr>
 225
 226
 227                 <tr class="config-row expandable config-row-alt1">
 228                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 229                     <td class="sig">
 230
 231                         <a id="Roo.form.BasicForm-cfg-fileUpload" name=".fileUpload"></a>
 232                         <div class="fixedFont">
 233                                 <b  class="itemname">fileUpload</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 234
 235
 236                         </div>
 237
 238                         <div class="mdesc">
 239                             <div class="short">Set to true if this form is a file upload.</div>
 240                         </div>
 241
 242                         <div class="mdesc">
 243                             <div class="long">
 244                     Set to true if this form is a file upload.
 245
 246                 </div>
 247                         </div>
 248
 249
 250
 251                     </td>
 252                     <td class="msource">
 253
 254                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
 255
 256                     </td>
 257                 </tr>
 258
 259
 260                 <tr class="config-row expandable config-row-alt0 notInherited">
 261                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 262                     <td class="sig">
 263
 264                         <a id="Roo.form.Form-cfg-itemCls" name=".itemCls"></a>
 265                         <div class="fixedFont">
 266                                 <b  class="itemname">itemCls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 267
 268
 269                         </div>
 270
 271                         <div class="mdesc">
 272                             <div class="short">A css class to apply to the x-form-item of fields.</div>
 273                         </div>
 274
 275                         <div class="mdesc">
 276                             <div class="long">
 277                     A css class to apply to the x-form-item of fields. This property cascades to child containers.
 278
 279                 </div>
 280                         </div>
 281
 282
 283
 284                     </td>
 285                     <td class="msource">
 286
 287                         Roo.form.Form
 288
 289                     </td>
 290                 </tr>
 291
 292
 293                 <tr class="config-row expandable config-row-alt1 notInherited">
 294                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 295                     <td class="sig">
 296
 297                         <a id="Roo.form.Form-cfg-labelAlign" name=".labelAlign"></a>
 298                         <div class="fixedFont">
 299                                 <b  class="itemname">labelAlign</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 300
 301
 302                         </div>
 303
 304                         <div class="mdesc">
 305                             <div class="short">Valid values are "left," "top" and "right" (defaults to "left").</div>
 306                         </div>
 307
 308                         <div class="mdesc">
 309                             <div class="long">
 310                     Valid values are "left," "top" and "right" (defaults to "left").<br/>This property cascades to child containers if not set.
 311
 312                 </div>
 313                         </div>
 314
 315
 316
 317                     </td>
 318                     <td class="msource">
 319
 320                         Roo.form.Form
 321
 322                     </td>
 323                 </tr>
 324
 325
 326                 <tr class="config-row expandable config-row-alt0 notInherited">
 327                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 328                     <td class="sig">
 329
 330                         <a id="Roo.form.Form-cfg-labelWidth" name=".labelWidth"></a>
 331                         <div class="fixedFont">
 332                                 <b  class="itemname">labelWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 333
 334
 335                         </div>
 336
 337                         <div class="mdesc">
 338                             <div class="short">The width of labels.</div>
 339                         </div>
 340
 341                         <div class="mdesc">
 342                             <div class="long">
 343                     The width of labels. This property cascades to child containers.
 344
 345                 </div>
 346                         </div>
 347
 348
 349
 350                     </td>
 351                     <td class="msource">
 352
 353                         Roo.form.Form
 354
 355                     </td>
 356                 </tr>
 357
 358
 359                 <tr class="config-row expandable config-row-alt1">
 360                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 361                     <td class="sig">
 362
 363                         <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
 364                         <div class="fixedFont">
 365                                 <b  class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 366
 367
 368                         </div>
 369
 370                         <div class="mdesc">
 371                             <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           .</div>
 372                         </div>
 373
 374                         <div class="mdesc">
 375                             <div class="long">
 376                     list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           ..... <br/>        } ,<br/>        .... <br/>    } <br/>  </code></pre>
 377
 378                 </div>
 379                         </div>
 380
 381
 382
 383                     </td>
 384                     <td class="msource">
 385
 386                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 387
 388                     </td>
 389                 </tr>
 390
 391
 392                 <tr class="config-row expandable config-row-alt0">
 393                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 394                     <td class="sig">
 395
 396                         <a id="Roo.form.BasicForm-cfg-method" name=".method"></a>
 397                         <div class="fixedFont">
 398                                 <b  class="itemname">method</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 399
 400
 401                         </div>
 402
 403                         <div class="mdesc">
 404                             <div class="short">The request method to use (GET or POST) for form actions if one isn't supplied in the action options.</div>
 405                         </div>
 406
 407                         <div class="mdesc">
 408                             <div class="long">
 409                     The request method to use (GET or POST) for form actions if one isn't supplied in the action options.
 410
 411                 </div>
 412                         </div>
 413
 414
 415
 416                     </td>
 417                     <td class="msource">
 418
 419                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
 420
 421                     </td>
 422                 </tr>
 423
 424
 425                 <tr class="config-row expandable config-row-alt1 notInherited">
 426                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 427                     <td class="sig">
 428
 429                         <a id="Roo.form.Form-cfg-minButtonWidth" name=".minButtonWidth"></a>
 430                         <div class="fixedFont">
 431                                 <b  class="itemname">minButtonWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 432
 433
 434                         </div>
 435
 436                         <div class="mdesc">
 437                             <div class="short">Minimum width of all buttons in pixels (defaults to 75)</div>
 438                         </div>
 439
 440                         <div class="mdesc">
 441                             <div class="long">
 442                     Minimum width of all buttons in pixels (defaults to 75)
 443
 444                 </div>
 445                         </div>
 446
 447
 448
 449                     </td>
 450                     <td class="msource">
 451
 452                         Roo.form.Form
 453
 454                     </td>
 455                 </tr>
 456
 457
 458                 <tr class="config-row expandable config-row-alt0 notInherited">
 459                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 460                     <td class="sig">
 461
 462                         <a id="Roo.form.Form-cfg-monitorPoll" name=".monitorPoll"></a>
 463                         <div class="fixedFont">
 464                                 <b  class="itemname">monitorPoll</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 465
 466
 467                         </div>
 468
 469                         <div class="mdesc">
 470                             <div class="short">The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)</div>
 471                         </div>
 472
 473                         <div class="mdesc">
 474                             <div class="long">
 475                     The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)
 476
 477                 </div>
 478                         </div>
 479
 480
 481
 482                     </td>
 483                     <td class="msource">
 484
 485                         Roo.form.Form
 486
 487                     </td>
 488                 </tr>
 489
 490
 491                 <tr class="config-row expandable config-row-alt1 notInherited">
 492                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 493                     <td class="sig">
 494
 495                         <a id="Roo.form.Form-cfg-monitorValid" name=".monitorValid"></a>
 496                         <div class="fixedFont">
 497                                 <b  class="itemname">monitorValid</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 498
 499
 500                         </div>
 501
 502                         <div class="mdesc">
 503                             <div class="short">If true the form monitors its valid state <b>client-side</b> and<br/>fires a looping event with that state.</div>
 504                         </div>
 505
 506                         <div class="mdesc">
 507                             <div class="long">
 508                     If true the form monitors its valid state <b>client-side</b> and<br/>fires a looping event with that state. This is required to bind buttons to the valid<br/>state using the config value formBind:true on the button.
 509
 510                 </div>
 511                         </div>
 512
 513
 514
 515                     </td>
 516                     <td class="msource">
 517
 518                         Roo.form.Form
 519
 520                     </td>
 521                 </tr>
 522
 523
 524                 <tr class="config-row expandable config-row-alt0 notInherited">
 525                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 526                     <td class="sig">
 527
 528                         <a id="Roo.form.Form-cfg-progressUrl" name=".progressUrl"></a>
 529                         <div class="fixedFont">
 530                                 <b  class="itemname">progressUrl</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 531
 532
 533                         </div>
 534
 535                         <div class="mdesc">
 536                             <div class="short">- Url to return progress data</div>
 537                         </div>
 538
 539                         <div class="mdesc">
 540                             <div class="long">
 541                     - Url to return progress data
 542
 543                 </div>
 544                         </div>
 545
 546
 547
 548                     </td>
 549                     <td class="msource">
 550
 551                         Roo.form.Form
 552
 553                     </td>
 554                 </tr>
 555
 556
 557                 <tr class="config-row expandable config-row-alt1">
 558                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 559                     <td class="sig">
 560
 561                         <a id="Roo.form.BasicForm-cfg-reader" name=".reader"></a>
 562                         <div class="fixedFont">
 563                                 <b  class="itemname">reader</b> : DataReader
 564
 565
 566                         </div>
 567
 568                         <div class="mdesc">
 569                             <div class="short">An Roo.data.DataReader (e.g.</div>
 570                         </div>
 571
 572                         <div class="mdesc">
 573                             <div class="long">
 574                     An Roo.data.DataReader (e.g. {<b>link</b> Roo.data.XmlReader}) to be used to read data when executing "load" actions.<br/>This is optional as there is built-in support for processing JSON.
 575
 576                 </div>
 577                         </div>
 578
 579
 580
 581                     </td>
 582                     <td class="msource">
 583
 584                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
 585
 586                     </td>
 587                 </tr>
 588
 589
 590                 <tr class="config-row expandable config-row-alt0">
 591                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 592                     <td class="sig">
 593
 594                         <a id="Roo.form.BasicForm-cfg-timeout" name=".timeout"></a>
 595                         <div class="fixedFont">
 596                                 <b  class="itemname">timeout</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 597
 598
 599                         </div>
 600
 601                         <div class="mdesc">
 602                             <div class="short">Timeout for form actions in seconds (default is 30 seconds).</div>
 603                         </div>
 604
 605                         <div class="mdesc">
 606                             <div class="long">
 607                     Timeout for form actions in seconds (default is 30 seconds).
 608
 609                 </div>
 610                         </div>
 611
 612
 613
 614                     </td>
 615                     <td class="msource">
 616
 617                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
 618
 619                     </td>
 620                 </tr>
 621
 622
 623                 <tr class="config-row expandable config-row-alt1">
 624                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 625                     <td class="sig">
 626
 627                         <a id="Roo.form.BasicForm-cfg-trackResetOnLoad" name=".trackResetOnLoad"></a>
 628                         <div class="fixedFont">
 629                                 <b  class="itemname">trackResetOnLoad</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 630
 631
 632                         </div>
 633
 634                         <div class="mdesc">
 635                             <div class="short">If set to true, form.reset() resets to the last loaded<br/>or setValues() data instead of when the form was first created.</div>
 636                         </div>
 637
 638                         <div class="mdesc">
 639                             <div class="long">
 640                     If set to true, form.reset() resets to the last loaded<br/>or setValues() data instead of when the form was first created.
 641
 642                 </div>
 643                         </div>
 644
 645
 646
 647                     </td>
 648                     <td class="msource">
 649
 650                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
 651
 652                     </td>
 653                 </tr>
 654
 655
 656                 <tr class="config-row expandable config-row-alt0">
 657                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 658                     <td class="sig">
 659
 660                         <a id="Roo.form.BasicForm-cfg-url" name=".url"></a>
 661                         <div class="fixedFont">
 662                                 <b  class="itemname">url</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 663
 664
 665                         </div>
 666
 667                         <div class="mdesc">
 668                             <div class="short">The URL to use for form actions if one isn't supplied in the action options.</div>
 669                         </div>
 670
 671                         <div class="mdesc">
 672                             <div class="long">
 673                     The URL to use for form actions if one isn't supplied in the action options.
 674
 675                 </div>
 676                         </div>
 677
 678
 679
 680                     </td>
 681                     <td class="msource">
 682
 683                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
 684
 685                     </td>
 686                 </tr>
 687
 688
 689     </table>
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699   <!-- ============================== public properties ==================== -->
 700
 701
 702
 703     <a id="Roo.form.Form-props"></a>
 704
 705
 706
 707
 708
 709      <table cellspacing="0" class="member-table">
 710       <caption class="Empty">Public Properties - Has None</caption>
 711      </table>
 712
 713
 714
 715
 716   <!-- ============================== methods summary / details ======================== -->
 717
 718
 719   <a id="Roo.form.Form-methods"></a>
 720         <!-- constructor?? -->
 721
 722         <!-- static's first
 723
 724
 725         -->
 726
 727         <!-- then dynamics first -->
 728
 729
 730
 731
 732
 733
 734       <table cellspacing="0" class="member-table">
 735       <caption>Public Methods</caption>
 736         <tr>
 737             <th class="sig-header" colspan="2">Method</th>
 738             <th class="msource-header">Defined By</th>
 739
 740         </tr>
 741
 742
 743
 744
 745
 746
 747
 748           <tr class="method-row config-row-alt0 expandable notInherited">
 749             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 750
 751
 752             <td class="sig">
 753                 <a id="Roo.form-method-Form"   name=".Form"></a>
 754                 <div class="fixedFont">
 755                         <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">Form</b>
 756
 757                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 758
 759
 760
 761                 </div>
 762                 <div class="mdesc">
 763
 764
 765                         <div class="short">Create a new Roo.form.Form</div>
 766
 767
 768                     <div class="long">
 769
 770
 771
 772                                 Create a new Roo.form.Form
 773
 774
 775                                 <dl class="detailList">
 776                                 <dt class="heading">Parameters:</dt>
 777
 778                                         <dt>
 779                                                 <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>
 780
 781                                         </dt>
 782                                         <dd>Configuration options</dd>
 783
 784                                 </dl>
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796                     </div>
 797                 </div>
 798
 799             </td>
 800             <td class="msource">
 801                 &nbsp;
 802             </td>
 803         </tr>
 804
 805
 806           <tr class="method-row config-row-alt1 expandable notInherited">
 807             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 808
 809
 810             <td class="sig">
 811                 <a id="Roo.form.Form-method-add"   name=".add"></a>
 812                 <div class="fixedFont">
 813                         <span class="attributes"></span><b class="itemname">add</b>
 814
 815                                  (Field <B><i>field1</i></B>, Field <B><i>field2</i></B>)
 816
 817
 818                                          :
 819
 820
 821                                                 Form
 822
 823
 824
 825
 826
 827                 </div>
 828                 <div class="mdesc">
 829
 830                    <div class="short">Add Roo.form components to the current open container (e.g.</div>
 831
 832
 833
 834                     <div class="long">
 835
 836                                 Add Roo.form components to the current open container (e.g. column, fieldset, etc.).  Fields added via this method<br/>can also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display<br/>as the label of the field.
 837
 838
 839
 840
 841
 842
 843                                 <dl class="detailList">
 844                                 <dt class="heading">Parameters:</dt>
 845
 846                                         <dt>
 847                                                 <span class="fixedFont">Field</span>  <b>field1</b>
 848
 849                                         </dt>
 850                                         <dd></dd>
 851
 852                                         <dt>
 853                                                 <span class="fixedFont">Field</span>  <b>field2</b>
 854
 855                                         </dt>
 856                                         <dd>(optional)</dd>
 857
 858                                         <dt>
 859                                                 <span class="fixedFont">Field</span>  <b>etc.</b>
 860
 861                                         </dt>
 862                                         <dd>(optional)</dd>
 863
 864                                 </dl>
 865
 866
 867
 868
 869
 870                                 <dl class="detailList">
 871                                 <dt class="heading">Returns:</dt>
 872
 873                                         <dd><span class="fixedFont">Form</span>  this</dd>
 874
 875                                 </dl>
 876
 877
 878
 879
 880
 881
 882
 883                     </div>
 884                 </div>
 885
 886             </td>
 887             <td class="msource">
 888
 889                         Roo.form.Form
 890                 &nbsp;
 891             </td>
 892         </tr>
 893
 894
 895           <tr class="method-row config-row-alt0 expandable notInherited">
 896             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 897
 898
 899             <td class="sig">
 900                 <a id="Roo.form.Form-method-addButton"   name=".addButton"></a>
 901                 <div class="fixedFont">
 902                         <span class="attributes"></span><b class="itemname">addButton</b>
 903
 904                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object <B><i>config</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
 905
 906
 907                                          :
 908
 909
 910                                                 <a href="./Roo.Button.html#constructor" roo:cls="Roo.Button.html#constructor">Roo.Button</a>
 911
 912
 913
 914
 915
 916                 </div>
 917                 <div class="mdesc">
 918
 919                    <div class="short">Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.</div>
 920
 921
 922
 923                     <div class="long">
 924
 925                                 Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.
 926
 927
 928
 929
 930
 931
 932                                 <dl class="detailList">
 933                                 <dt class="heading">Parameters:</dt>
 934
 935                                         <dt>
 936                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span>  <b>config</b>
 937
 938                                         </dt>
 939                                         <dd>A string becomes the button text, an object can either be a Button config<br/>object or a valid Roo.DomHelper element config</dd>
 940
 941                                         <dt>
 942                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 943
 944                                         </dt>
 945                                         <dd>The function called when the button is clicked</dd>
 946
 947                                         <dt>
 948                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 949
 950                                         </dt>
 951                                         <dd>(optional) The scope of the handler function</dd>
 952
 953                                 </dl>
 954
 955
 956
 957
 958
 959                                 <dl class="detailList">
 960                                 <dt class="heading">Returns:</dt>
 961
 962                                         <dd><span class="fixedFont"><a href="./Roo.Button.html#constructor" roo:cls="Roo.Button.html#constructor">Roo.Button</a></span>  </dd>
 963
 964                                 </dl>
 965
 966
 967
 968
 969
 970
 971
 972                     </div>
 973                 </div>
 974
 975             </td>
 976             <td class="msource">
 977
 978                         Roo.form.Form
 979                 &nbsp;
 980             </td>
 981         </tr>
 982
 983
 984           <tr class="method-row config-row-alt1 expandable">
 985             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 986
 987
 988             <td class="sig">
 989                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 990                 <div class="fixedFont">
 991                         <span class="attributes"></span><b class="itemname">addEvents</b>
 992
 993                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 994
 995
 996
 997                 </div>
 998                 <div class="mdesc">
 999
1000                    <div class="short">Used to define events on this Observable</div>
1001
1002
1003
1004                     <div class="long">
1005
1006                                 Used to define events on this Observable
1007
1008
1009
1010
1011
1012
1013                                 <dl class="detailList">
1014                                 <dt class="heading">Parameters:</dt>
1015
1016                                         <dt>
1017                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>object</b>
1018
1019                                         </dt>
1020                                         <dd>The object with the events defined</dd>
1021
1022                                 </dl>
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034                     </div>
1035                 </div>
1036
1037             </td>
1038             <td class="msource">
1039
1040                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1041                 &nbsp;
1042             </td>
1043         </tr>
1044
1045
1046           <tr class="method-row config-row-alt0 expandable">
1047             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1048
1049
1050             <td class="sig">
1051                 <a id="Roo.form.BasicForm-method-addForm"   name=".addForm"></a>
1052                 <div class="fixedFont">
1053                         <span class="attributes"></span><b class="itemname">addForm</b>
1054
1055                                  (<a href="./Roo.form.Form.html#constructor" roo:cls="Roo.form.Form.html#constructor">Roo.form.Form</a> <B><i>form</i></B>)
1056
1057
1058
1059                 </div>
1060                 <div class="mdesc">
1061
1062                    <div class="short">Add a secondary form to this one, <br/>Used to provide tabbed forms.</div>
1063
1064
1065
1066                     <div class="long">
1067
1068                                 Add a secondary form to this one, <br/>Used to provide tabbed forms. One form is primary, with hidden values <br/>which mirror the elements from the other forms.
1069
1070
1071
1072
1073
1074
1075                                 <dl class="detailList">
1076                                 <dt class="heading">Parameters:</dt>
1077
1078                                         <dt>
1079                                                 <span class="fixedFont"><a href="./Roo.form.Form.html#constructor" roo:cls="Roo.form.Form.html#constructor">Roo.form.Form</a></span>  <b>form</b>
1080
1081                                         </dt>
1082                                         <dd>to add.</dd>
1083
1084                                 </dl>
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096                     </div>
1097                 </div>
1098
1099             </td>
1100             <td class="msource">
1101
1102                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
1103                 &nbsp;
1104             </td>
1105         </tr>
1106
1107
1108           <tr class="method-row config-row-alt1 expandable">
1109             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1110
1111
1112             <td class="sig">
1113                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
1114                 <div class="fixedFont">
1115                         <span class="attributes"></span><b class="itemname">addListener</b>
1116
1117                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1118
1119
1120
1121                 </div>
1122                 <div class="mdesc">
1123
1124                    <div class="short">Appends an event handler to this component</div>
1125
1126
1127
1128                     <div class="long">
1129
1130                                 Appends an event handler to this component
1131
1132
1133
1134
1135
1136
1137                                 <dl class="detailList">
1138                                 <dt class="heading">Parameters:</dt>
1139
1140                                         <dt>
1141                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1142
1143                                         </dt>
1144                                         <dd>The type of event to listen for</dd>
1145
1146                                         <dt>
1147                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1148
1149                                         </dt>
1150                                         <dd>The method the event invokes</dd>
1151
1152                                         <dt>
1153                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
1154
1155                                         </dt>
1156                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1157
1158                                         <dt>
1159                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
1160
1161                                         </dt>
1162                                         <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/>             <pre><code><br/>                el.on('click', this.onClick, this, {<br/>                       single: true,<br/>              delay: 100,<br/>                forumId: 4<br/>         });<br/>                </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/>               el.on({<br/>                    'click': {<br/>                 fn: this.onClick,<br/>                  scope: this,<br/>                       delay: 100<br/>                 }, <br/>                'mouseover': {<br/>                     fn: this.onMouseOver,<br/>                      scope: this<br/>                },<br/>                 'mouseout': {<br/>                      fn: this.onMouseOut,<br/>                       scope: this<br/>                }<br/>          });<br/>                </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/>        <pre><code><br/>                el.on({<br/>                    'click': this.onClick,<br/>             'mouseover': this.onMouseOver,<br/>             'mouseout': this.onMouseOut,<br/>               scope: this<br/>                });<br/>                </code></pre></dd>
1163
1164                                 </dl>
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176                     </div>
1177                 </div>
1178
1179             </td>
1180             <td class="msource">
1181
1182                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1183                 &nbsp;
1184             </td>
1185         </tr>
1186
1187
1188           <tr class="method-row config-row-alt0 expandable notInherited">
1189             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1190
1191
1192             <td class="sig">
1193                 <a id="Roo.form.Form-method-addxtype"   name=".addxtype"></a>
1194                 <div class="fixedFont">
1195                         <span class="attributes"></span><b class="itemname">addxtype</b>
1196
1197                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
1198
1199
1200
1201                 </div>
1202                 <div class="mdesc">
1203
1204                    <div class="short">Adds a series of form elements (using the xtype property as the factory method.</div>
1205
1206
1207
1208                     <div class="long">
1209
1210                                 Adds a series of form elements (using the xtype property as the factory method.<br/>Valid xtypes are:  TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)
1211
1212
1213
1214
1215
1216
1217                                 <dl class="detailList">
1218                                 <dt class="heading">Parameters:</dt>
1219
1220                                         <dt>
1221                                                 <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>
1222
1223                                         </dt>
1224                                         <dd></dd>
1225
1226                                 </dl>
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238                     </div>
1239                 </div>
1240
1241             </td>
1242             <td class="msource">
1243
1244                         Roo.form.Form
1245                 &nbsp;
1246             </td>
1247         </tr>
1248
1249
1250           <tr class="method-row config-row-alt1 expandable">
1251             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1252
1253
1254             <td class="sig">
1255                 <a id="Roo.form.BasicForm-method-applyIfToFields"   name=".applyIfToFields"></a>
1256                 <div class="fixedFont">
1257                         <span class="attributes"></span><b class="itemname">applyIfToFields</b>
1258
1259                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
1260
1261
1262                                          :
1263
1264
1265                                                 BasicForm
1266
1267
1268
1269
1270
1271                 </div>
1272                 <div class="mdesc">
1273
1274                    <div class="short">Calls {<b>link</b> Ext<b>applyIf</b>} for all field in this form with the passed object.</div>
1275
1276
1277
1278                     <div class="long">
1279
1280                                 Calls {<b>link</b> Ext<b>applyIf</b>} for all field in this form with the passed object.
1281
1282
1283
1284
1285
1286
1287                                 <dl class="detailList">
1288                                 <dt class="heading">Parameters:</dt>
1289
1290                                         <dt>
1291                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>values</b>
1292
1293                                         </dt>
1294                                         <dd></dd>
1295
1296                                 </dl>
1297
1298
1299
1300
1301
1302                                 <dl class="detailList">
1303                                 <dt class="heading">Returns:</dt>
1304
1305                                         <dd><span class="fixedFont">BasicForm</span>  this</dd>
1306
1307                                 </dl>
1308
1309
1310
1311
1312
1313
1314
1315                     </div>
1316                 </div>
1317
1318             </td>
1319             <td class="msource">
1320
1321                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
1322                 &nbsp;
1323             </td>
1324         </tr>
1325
1326
1327           <tr class="method-row config-row-alt0 expandable">
1328             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1329
1330
1331             <td class="sig">
1332                 <a id="Roo.form.BasicForm-method-applyToFields"   name=".applyToFields"></a>
1333                 <div class="fixedFont">
1334                         <span class="attributes"></span><b class="itemname">applyToFields</b>
1335
1336                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
1337
1338
1339                                          :
1340
1341
1342                                                 BasicForm
1343
1344
1345
1346
1347
1348                 </div>
1349                 <div class="mdesc">
1350
1351                    <div class="short">Calls {<b>link</b> Ext<b>apply</b>} for all fields in this form with the passed object.</div>
1352
1353
1354
1355                     <div class="long">
1356
1357                                 Calls {<b>link</b> Ext<b>apply</b>} for all fields in this form with the passed object.
1358
1359
1360
1361
1362
1363
1364                                 <dl class="detailList">
1365                                 <dt class="heading">Parameters:</dt>
1366
1367                                         <dt>
1368                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>values</b>
1369
1370                                         </dt>
1371                                         <dd></dd>
1372
1373                                 </dl>
1374
1375
1376
1377
1378
1379                                 <dl class="detailList">
1380                                 <dt class="heading">Returns:</dt>
1381
1382                                         <dd><span class="fixedFont">BasicForm</span>  this</dd>
1383
1384                                 </dl>
1385
1386
1387
1388
1389
1390
1391
1392                     </div>
1393                 </div>
1394
1395             </td>
1396             <td class="msource">
1397
1398                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
1399                 &nbsp;
1400             </td>
1401         </tr>
1402
1403
1404           <tr class="method-row config-row-alt1 expandable">
1405             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1406
1407
1408             <td class="sig">
1409                 <a id="Roo.form.BasicForm-method-clearInvalid"   name=".clearInvalid"></a>
1410                 <div class="fixedFont">
1411                         <span class="attributes"></span><b class="itemname">clearInvalid</b>
1412
1413                                  ()
1414
1415
1416                                          :
1417
1418
1419                                                 BasicForm
1420
1421
1422
1423
1424
1425                 </div>
1426                 <div class="mdesc">
1427
1428                    <div class="short">Clears all invalid messages in this form.</div>
1429
1430
1431
1432                     <div class="long">
1433
1434                                 Clears all invalid messages in this form.
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445                                 <dl class="detailList">
1446                                 <dt class="heading">Returns:</dt>
1447
1448                                         <dd><span class="fixedFont">BasicForm</span>  this</dd>
1449
1450                                 </dl>
1451
1452
1453
1454
1455
1456
1457
1458                     </div>
1459                 </div>
1460
1461             </td>
1462             <td class="msource">
1463
1464                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
1465                 &nbsp;
1466             </td>
1467         </tr>
1468
1469
1470           <tr class="method-row config-row-alt0 expandable notInherited">
1471             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1472
1473
1474             <td class="sig">
1475                 <a id="Roo.form.Form-method-column"   name=".column"></a>
1476                 <div class="fixedFont">
1477                         <span class="attributes"></span><b class="itemname">column</b>
1478
1479                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>, Field <B><i>field1</i></B>, Field <B><i>field2</i></B>, Field <B><i>etc</i></B>)
1480
1481
1482                                          :
1483
1484
1485
1486
1487
1488
1489
1490
1491                 </div>
1492                 <div class="mdesc">
1493
1494                    <div class="short">Opens a new {<b>link</b> Roo.form.Column} container in the layout stack.</div>
1495
1496
1497
1498                     <div class="long">
1499
1500                                 Opens a new {<b>link</b> Roo.form.Column} container in the layout stack. If fields are passed after the config, the<br/>fields are added and the column is closed. If no fields are passed the column remains open<br/>until end() is called.
1501
1502
1503
1504
1505
1506
1507                                 <dl class="detailList">
1508                                 <dt class="heading">Parameters:</dt>
1509
1510                                         <dt>
1511                                                 <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>
1512
1513                                         </dt>
1514                                         <dd>The config to pass to the column</dd>
1515
1516                                         <dt>
1517                                                 <span class="fixedFont">Field</span>  <b>field1</b>
1518
1519                                         </dt>
1520                                         <dd>(optional)</dd>
1521
1522                                         <dt>
1523                                                 <span class="fixedFont">Field</span>  <b>field2</b>
1524
1525                                         </dt>
1526                                         <dd>(optional)</dd>
1527
1528                                         <dt>
1529                                                 <span class="fixedFont">Field</span>  <b>etc</b>
1530
1531                                         </dt>
1532                                         <dd>(optional)</dd>
1533
1534                                 </dl>
1535
1536
1537
1538
1539
1540                                 <dl class="detailList">
1541                                 <dt class="heading">Returns:</dt>
1542
1543                                         <dd> Column The column container object</dd>
1544
1545                                 </dl>
1546
1547
1548
1549
1550
1551
1552
1553                     </div>
1554                 </div>
1555
1556             </td>
1557             <td class="msource">
1558
1559                         Roo.form.Form
1560                 &nbsp;
1561             </td>
1562         </tr>
1563
1564
1565           <tr class="method-row config-row-alt1 expandable notInherited">
1566             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1567
1568
1569             <td class="sig">
1570                 <a id="Roo.form.Form-method-container"   name=".container"></a>
1571                 <div class="fixedFont">
1572                         <span class="attributes"></span><b class="itemname">container</b>
1573
1574                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>, Field <B><i>field1</i></B>, Field <B><i>field2</i></B>, Field <B><i>etc</i></B>)
1575
1576
1577                                          :
1578
1579
1580
1581
1582
1583
1584
1585
1586                 </div>
1587                 <div class="mdesc">
1588
1589                    <div class="short">Opens a new {<b>link</b> Roo.form.Layout} container in the layout stack.</div>
1590
1591
1592
1593                     <div class="long">
1594
1595                                 Opens a new {<b>link</b> Roo.form.Layout} container in the layout stack. If fields are passed after the config, the<br/>fields are added and the container is closed. If no fields are passed the container remains open<br/>until end() is called.
1596
1597
1598
1599
1600
1601
1602                                 <dl class="detailList">
1603                                 <dt class="heading">Parameters:</dt>
1604
1605                                         <dt>
1606                                                 <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>
1607
1608                                         </dt>
1609                                         <dd>The config to pass to the Layout</dd>
1610
1611                                         <dt>
1612                                                 <span class="fixedFont">Field</span>  <b>field1</b>
1613
1614                                         </dt>
1615                                         <dd>(optional)</dd>
1616
1617                                         <dt>
1618                                                 <span class="fixedFont">Field</span>  <b>field2</b>
1619
1620                                         </dt>
1621                                         <dd>(optional)</dd>
1622
1623                                         <dt>
1624                                                 <span class="fixedFont">Field</span>  <b>etc</b>
1625
1626                                         </dt>
1627                                         <dd>(optional)</dd>
1628
1629                                 </dl>
1630
1631
1632
1633
1634
1635                                 <dl class="detailList">
1636                                 <dt class="heading">Returns:</dt>
1637
1638                                         <dd> Layout The container object</dd>
1639
1640                                 </dl>
1641
1642
1643
1644
1645
1646
1647
1648                     </div>
1649                 </div>
1650
1651             </td>
1652             <td class="msource">
1653
1654                         Roo.form.Form
1655                 &nbsp;
1656             </td>
1657         </tr>
1658
1659
1660           <tr class="method-row config-row-alt0 expandable">
1661             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1662
1663
1664             <td class="sig">
1665                 <a id="Roo.form.BasicForm-method-doAction"   name=".doAction"></a>
1666                 <div class="fixedFont">
1667                         <span class="attributes"></span><b class="itemname">doAction</b>
1668
1669                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>actionName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1670
1671
1672                                          :
1673
1674
1675                                                 BasicForm
1676
1677
1678
1679
1680
1681                 </div>
1682                 <div class="mdesc">
1683
1684                    <div class="short">Performs a predefined action (submit or load) or custom actions you define on this form.</div>
1685
1686
1687
1688                     <div class="long">
1689
1690                                 Performs a predefined action (submit or load) or custom actions you define on this form.
1691
1692
1693
1694
1695
1696
1697                                 <dl class="detailList">
1698                                 <dt class="heading">Parameters:</dt>
1699
1700                                         <dt>
1701                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>actionName</b>
1702
1703                                         </dt>
1704                                         <dd>The name of the action type</dd>
1705
1706                                         <dt>
1707                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
1708
1709                                         </dt>
1710                                         <dd>(optional) The options to pass to the action.  All of the config options listed<br/>below are supported by both the submit and load actions unless otherwise noted (custom actions could also<br/>accept other config options):<br/><pre><br/>Property          Type             Description<br/>----------------  ---------------  ----------------------------------------------------------------------------------<br/>url               String           The url for the action (defaults to the form's url)<br/>method            String           The form method to use (defaults to the form's method, or POST if not defined)<br/>params            String/Object    The params to pass (defaults to the form's baseParams, or none if not defined)<br/>clientValidation  Boolean          Applies to submit only.  Pass true to call form.isValid() prior to posting to<br/>                                   validate the form on the client (defaults to false)<br/></pre></dd>
1711
1712                                 </dl>
1713
1714
1715
1716
1717
1718                                 <dl class="detailList">
1719                                 <dt class="heading">Returns:</dt>
1720
1721                                         <dd><span class="fixedFont">BasicForm</span>  this</dd>
1722
1723                                 </dl>
1724
1725
1726
1727
1728
1729
1730
1731                     </div>
1732                 </div>
1733
1734             </td>
1735             <td class="msource">
1736
1737                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
1738                 &nbsp;
1739             </td>
1740         </tr>
1741
1742
1743           <tr class="method-row config-row-alt1 expandable notInherited">
1744             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1745
1746
1747             <td class="sig">
1748                 <a id="Roo.form.Form-method-end"   name=".end"></a>
1749                 <div class="fixedFont">
1750                         <span class="attributes"></span><b class="itemname">end</b>
1751
1752                                  ()
1753
1754
1755                                          :
1756
1757
1758                                                 Form
1759
1760
1761
1762
1763
1764                 </div>
1765                 <div class="mdesc">
1766
1767                    <div class="short">Closes the current open container</div>
1768
1769
1770
1771                     <div class="long">
1772
1773                                 Closes the current open container
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784                                 <dl class="detailList">
1785                                 <dt class="heading">Returns:</dt>
1786
1787                                         <dd><span class="fixedFont">Form</span>  this</dd>
1788
1789                                 </dl>
1790
1791
1792
1793
1794
1795
1796
1797                     </div>
1798                 </div>
1799
1800             </td>
1801             <td class="msource">
1802
1803                         Roo.form.Form
1804                 &nbsp;
1805             </td>
1806         </tr>
1807
1808
1809           <tr class="method-row config-row-alt0 expandable notInherited">
1810             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1811
1812
1813             <td class="sig">
1814                 <a id="Roo.form.Form-method-fieldset"   name=".fieldset"></a>
1815                 <div class="fixedFont">
1816                         <span class="attributes"></span><b class="itemname">fieldset</b>
1817
1818                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>, Field <B><i>field1</i></B>, Field <B><i>field2</i></B>, Field <B><i>etc</i></B>)
1819
1820
1821                                          :
1822
1823
1824
1825
1826
1827
1828
1829
1830                 </div>
1831                 <div class="mdesc">
1832
1833                    <div class="short">Opens a new {<b>link</b> Roo.form.FieldSet} container in the layout stack.</div>
1834
1835
1836
1837                     <div class="long">
1838
1839                                 Opens a new {<b>link</b> Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the<br/>fields are added and the fieldset is closed. If no fields are passed the fieldset remains open<br/>until end() is called.
1840
1841
1842
1843
1844
1845
1846                                 <dl class="detailList">
1847                                 <dt class="heading">Parameters:</dt>
1848
1849                                         <dt>
1850                                                 <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>
1851
1852                                         </dt>
1853                                         <dd>The config to pass to the fieldset</dd>
1854
1855                                         <dt>
1856                                                 <span class="fixedFont">Field</span>  <b>field1</b>
1857
1858                                         </dt>
1859                                         <dd>(optional)</dd>
1860
1861                                         <dt>
1862                                                 <span class="fixedFont">Field</span>  <b>field2</b>
1863
1864                                         </dt>
1865                                         <dd>(optional)</dd>
1866
1867                                         <dt>
1868                                                 <span class="fixedFont">Field</span>  <b>etc</b>
1869
1870                                         </dt>
1871                                         <dd>(optional)</dd>
1872
1873                                 </dl>
1874
1875
1876
1877
1878
1879                                 <dl class="detailList">
1880                                 <dt class="heading">Returns:</dt>
1881
1882                                         <dd> FieldSet The fieldset container object</dd>
1883
1884                                 </dl>
1885
1886
1887
1888
1889
1890
1891
1892                     </div>
1893                 </div>
1894
1895             </td>
1896             <td class="msource">
1897
1898                         Roo.form.Form
1899                 &nbsp;
1900             </td>
1901         </tr>
1902
1903
1904           <tr class="method-row config-row-alt1 expandable">
1905             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1906
1907
1908             <td class="sig">
1909                 <a id="Roo.form.BasicForm-method-findField"   name=".findField"></a>
1910                 <div class="fixedFont">
1911                         <span class="attributes"></span><b class="itemname">findField</b>
1912
1913                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1914
1915
1916                                          :
1917
1918
1919
1920
1921
1922
1923
1924
1925                 </div>
1926                 <div class="mdesc">
1927
1928                    <div class="short">Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName</div>
1929
1930
1931
1932                     <div class="long">
1933
1934                                 Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName
1935
1936
1937
1938
1939
1940
1941                                 <dl class="detailList">
1942                                 <dt class="heading">Parameters:</dt>
1943
1944                                         <dt>
1945                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
1946
1947                                         </dt>
1948                                         <dd>The value to search for</dd>
1949
1950                                 </dl>
1951
1952
1953
1954
1955
1956                                 <dl class="detailList">
1957                                 <dt class="heading">Returns:</dt>
1958
1959                                         <dd> Field</dd>
1960
1961                                 </dl>
1962
1963
1964
1965
1966
1967
1968
1969                     </div>
1970                 </div>
1971
1972             </td>
1973             <td class="msource">
1974
1975                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
1976                 &nbsp;
1977             </td>
1978         </tr>
1979
1980
1981           <tr class="method-row config-row-alt0 expandable notInherited">
1982             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1983
1984
1985             <td class="sig">
1986                 <a id="Roo.form.Form-method-findbyId"   name=".findbyId"></a>
1987                 <div class="fixedFont">
1988                         <span class="attributes"></span><b class="itemname">findbyId</b>
1989
1990                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1991
1992
1993                                          :
1994
1995
1996                                                 Element
1997
1998
1999
2000
2001
2002                 </div>
2003                 <div class="mdesc">
2004
2005                    <div class="short">Find any element that has been added to a form, using it's ID or name<br/>This can include framesets, columns etc.</div>
2006
2007
2008
2009                     <div class="long">
2010
2011                                 Find any element that has been added to a form, using it's ID or name<br/>This can include framesets, columns etc. along with regular fields..
2012
2013
2014
2015
2016
2017
2018                                 <dl class="detailList">
2019                                 <dt class="heading">Parameters:</dt>
2020
2021                                         <dt>
2022                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
2023
2024                                         </dt>
2025                                         <dd>- id or name to find.</dd>
2026
2027                                 </dl>
2028
2029
2030
2031
2032
2033                                 <dl class="detailList">
2034                                 <dt class="heading">Returns:</dt>
2035
2036                                         <dd><span class="fixedFont">Element</span>  e - or false if nothing found.</dd>
2037
2038                                 </dl>
2039
2040
2041
2042
2043
2044
2045
2046                     </div>
2047                 </div>
2048
2049             </td>
2050             <td class="msource">
2051
2052                         Roo.form.Form
2053                 &nbsp;
2054             </td>
2055         </tr>
2056
2057
2058           <tr class="method-row config-row-alt1 expandable">
2059             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2060
2061
2062             <td class="sig">
2063                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
2064                 <div class="fixedFont">
2065                         <span class="attributes"></span><b class="itemname">fireEvent</b>
2066
2067                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
2068
2069
2070                                          :
2071
2072
2073                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2074
2075
2076
2077
2078
2079                 </div>
2080                 <div class="mdesc">
2081
2082                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
2083
2084
2085
2086                     <div class="long">
2087
2088                                 Fires the specified event with the passed parameters (minus the event name).
2089
2090
2091
2092
2093
2094
2095                                 <dl class="detailList">
2096                                 <dt class="heading">Parameters:</dt>
2097
2098                                         <dt>
2099                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
2100
2101                                         </dt>
2102                                         <dd></dd>
2103
2104                                         <dt>
2105                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span>  <b>args</b>
2106
2107                                         </dt>
2108                                         <dd>Variable number of parameters are passed to handlers</dd>
2109
2110                                 </dl>
2111
2112
2113
2114
2115
2116                                 <dl class="detailList">
2117                                 <dt class="heading">Returns:</dt>
2118
2119                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  returns false if any of the handlers return false otherwise it returns true</dd>
2120
2121                                 </dl>
2122
2123
2124
2125
2126
2127
2128
2129                     </div>
2130                 </div>
2131
2132             </td>
2133             <td class="msource">
2134
2135                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2136                 &nbsp;
2137             </td>
2138         </tr>
2139
2140
2141           <tr class="method-row config-row-alt0 expandable">
2142             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2143
2144
2145             <td class="sig">
2146                 <a id="Roo.form.BasicForm-method-getFieldValues"   name=".getFieldValues"></a>
2147                 <div class="fixedFont">
2148                         <span class="attributes"></span><b class="itemname">getFieldValues</b>
2149
2150                                  ()
2151
2152
2153                                          :
2154
2155
2156                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
2157
2158
2159
2160
2161
2162                 </div>
2163                 <div class="mdesc">
2164
2165                    <div class="short">Returns the fields in this form as an object with key/value pairs.</div>
2166
2167
2168
2169                     <div class="long">
2170
2171                                 Returns the fields in this form as an object with key/value pairs. <br/>This differs from getValues as it calls getValue on each child item, rather than using dom data.
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182                                 <dl class="detailList">
2183                                 <dt class="heading">Returns:</dt>
2184
2185                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  </dd>
2186
2187                                 </dl>
2188
2189
2190
2191
2192
2193
2194
2195                     </div>
2196                 </div>
2197
2198             </td>
2199             <td class="msource">
2200
2201                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2202                 &nbsp;
2203             </td>
2204         </tr>
2205
2206
2207           <tr class="method-row config-row-alt1 expandable">
2208             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2209
2210
2211             <td class="sig">
2212                 <a id="Roo.form.BasicForm-method-getValues"   name=".getValues"></a>
2213                 <div class="fixedFont">
2214                         <span class="attributes"></span><b class="itemname">getValues</b>
2215
2216                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>asString</i></B>)
2217
2218
2219                                          :
2220
2221
2222                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
2223
2224
2225
2226
2227
2228                 </div>
2229                 <div class="mdesc">
2230
2231                    <div class="short">Returns the fields in this form as an object with key/value pairs.</div>
2232
2233
2234
2235                     <div class="long">
2236
2237                                 Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name<br/>they are returned as an array.
2238
2239
2240
2241
2242
2243
2244                                 <dl class="detailList">
2245                                 <dt class="heading">Parameters:</dt>
2246
2247                                         <dt>
2248                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>asString</b>
2249
2250                                         </dt>
2251                                         <dd></dd>
2252
2253                                 </dl>
2254
2255
2256
2257
2258
2259                                 <dl class="detailList">
2260                                 <dt class="heading">Returns:</dt>
2261
2262                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  </dd>
2263
2264                                 </dl>
2265
2266
2267
2268
2269
2270
2271
2272                     </div>
2273                 </div>
2274
2275             </td>
2276             <td class="msource">
2277
2278                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2279                 &nbsp;
2280             </td>
2281         </tr>
2282
2283
2284           <tr class="method-row config-row-alt0 expandable">
2285             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2286
2287
2288             <td class="sig">
2289                 <a id="Roo.form.BasicForm-method-hasChanged"   name=".hasChanged"></a>
2290                 <div class="fixedFont">
2291                         <span class="attributes"></span><b class="itemname">hasChanged</b>
2292
2293                                  ()
2294
2295
2296                                          :
2297
2298
2299
2300
2301
2302
2303
2304
2305                 </div>
2306                 <div class="mdesc">
2307
2308                    <div class="short">Returns true if any fields in this form have changed since their original load.</div>
2309
2310
2311
2312                     <div class="long">
2313
2314                                 Returns true if any fields in this form have changed since their original load. (New version)
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325                                 <dl class="detailList">
2326                                 <dt class="heading">Returns:</dt>
2327
2328                                         <dd> Boolean</dd>
2329
2330                                 </dl>
2331
2332
2333
2334
2335
2336
2337
2338                     </div>
2339                 </div>
2340
2341             </td>
2342             <td class="msource">
2343
2344                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2345                 &nbsp;
2346             </td>
2347         </tr>
2348
2349
2350           <tr class="method-row config-row-alt1 expandable">
2351             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2352
2353
2354             <td class="sig">
2355                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
2356                 <div class="fixedFont">
2357                         <span class="attributes"></span><b class="itemname">hasListener</b>
2358
2359                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
2360
2361
2362                                          :
2363
2364
2365                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2366
2367
2368
2369
2370
2371                 </div>
2372                 <div class="mdesc">
2373
2374                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
2375
2376
2377
2378                     <div class="long">
2379
2380                                 Checks to see if this object has any listeners for a specified event
2381
2382
2383
2384
2385
2386
2387                                 <dl class="detailList">
2388                                 <dt class="heading">Parameters:</dt>
2389
2390                                         <dt>
2391                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
2392
2393                                         </dt>
2394                                         <dd>The name of the event to check for</dd>
2395
2396                                 </dl>
2397
2398
2399
2400
2401
2402                                 <dl class="detailList">
2403                                 <dt class="heading">Returns:</dt>
2404
2405                                         <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 event is being listened for, else false</dd>
2406
2407                                 </dl>
2408
2409
2410
2411
2412
2413
2414
2415                     </div>
2416                 </div>
2417
2418             </td>
2419             <td class="msource">
2420
2421                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2422                 &nbsp;
2423             </td>
2424         </tr>
2425
2426
2427           <tr class="method-row config-row-alt0 expandable">
2428             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2429
2430
2431             <td class="sig">
2432                 <a id="Roo.form.BasicForm-method-isDirty"   name=".isDirty"></a>
2433                 <div class="fixedFont">
2434                         <span class="attributes"></span><b class="itemname">isDirty</b>
2435
2436                                  ()
2437
2438
2439                                          :
2440
2441
2442
2443
2444
2445
2446
2447
2448                 </div>
2449                 <div class="mdesc">
2450
2451                    <div class="short">DEPRICATED Returns true if any fields in this form have changed since their original load.</div>
2452
2453
2454
2455                     <div class="long">
2456
2457                                 DEPRICATED Returns true if any fields in this form have changed since their original load.
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468                                 <dl class="detailList">
2469                                 <dt class="heading">Returns:</dt>
2470
2471                                         <dd> Boolean</dd>
2472
2473                                 </dl>
2474
2475
2476
2477
2478
2479
2480
2481                     </div>
2482                 </div>
2483
2484             </td>
2485             <td class="msource">
2486
2487                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2488                 &nbsp;
2489             </td>
2490         </tr>
2491
2492
2493           <tr class="method-row config-row-alt1 expandable">
2494             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2495
2496
2497             <td class="sig">
2498                 <a id="Roo.form.BasicForm-method-isValid"   name=".isValid"></a>
2499                 <div class="fixedFont">
2500                         <span class="attributes"></span><b class="itemname">isValid</b>
2501
2502                                  ()
2503
2504
2505                                          :
2506
2507
2508
2509
2510
2511
2512
2513
2514                 </div>
2515                 <div class="mdesc">
2516
2517                    <div class="short">Returns true if client-side validation on the form is successful.</div>
2518
2519
2520
2521                     <div class="long">
2522
2523                                 Returns true if client-side validation on the form is successful.
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534                                 <dl class="detailList">
2535                                 <dt class="heading">Returns:</dt>
2536
2537                                         <dd> Boolean</dd>
2538
2539                                 </dl>
2540
2541
2542
2543
2544
2545
2546
2547                     </div>
2548                 </div>
2549
2550             </td>
2551             <td class="msource">
2552
2553                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2554                 &nbsp;
2555             </td>
2556         </tr>
2557
2558
2559           <tr class="method-row config-row-alt0 expandable">
2560             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2561
2562
2563             <td class="sig">
2564                 <a id="Roo.form.BasicForm-method-load"   name=".load"></a>
2565                 <div class="fixedFont">
2566                         <span class="attributes"></span><b class="itemname">load</b>
2567
2568                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
2569
2570
2571                                          :
2572
2573
2574                                                 BasicForm
2575
2576
2577
2578
2579
2580                 </div>
2581                 <div class="mdesc">
2582
2583                    <div class="short">Shortcut to do a load action.</div>
2584
2585
2586
2587                     <div class="long">
2588
2589                                 Shortcut to do a load action.
2590
2591
2592
2593
2594
2595
2596                                 <dl class="detailList">
2597                                 <dt class="heading">Parameters:</dt>
2598
2599                                         <dt>
2600                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
2601
2602                                         </dt>
2603                                         <dd>The options to pass to the action (see {<b>link</b> <b>doAction</b>} for details)</dd>
2604
2605                                 </dl>
2606
2607
2608
2609
2610
2611                                 <dl class="detailList">
2612                                 <dt class="heading">Returns:</dt>
2613
2614                                         <dd><span class="fixedFont">BasicForm</span>  this</dd>
2615
2616                                 </dl>
2617
2618
2619
2620
2621
2622
2623
2624                     </div>
2625                 </div>
2626
2627             </td>
2628             <td class="msource">
2629
2630                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2631                 &nbsp;
2632             </td>
2633         </tr>
2634
2635
2636           <tr class="method-row config-row-alt1 expandable">
2637             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2638
2639
2640             <td class="sig">
2641                 <a id="Roo.form.BasicForm-method-loadRecord"   name=".loadRecord"></a>
2642                 <div class="fixedFont">
2643                         <span class="attributes"></span><b class="itemname">loadRecord</b>
2644
2645                                  (Record <B><i>record</i></B>)
2646
2647
2648                                          :
2649
2650
2651                                                 BasicForm
2652
2653
2654
2655
2656
2657                 </div>
2658                 <div class="mdesc">
2659
2660                    <div class="short">Loads an Roo.data.Record into this form.</div>
2661
2662
2663
2664                     <div class="long">
2665
2666                                 Loads an Roo.data.Record into this form.
2667
2668
2669
2670
2671
2672
2673                                 <dl class="detailList">
2674                                 <dt class="heading">Parameters:</dt>
2675
2676                                         <dt>
2677                                                 <span class="fixedFont">Record</span>  <b>record</b>
2678
2679                                         </dt>
2680                                         <dd>The record to load</dd>
2681
2682                                 </dl>
2683
2684
2685
2686
2687
2688                                 <dl class="detailList">
2689                                 <dt class="heading">Returns:</dt>
2690
2691                                         <dd><span class="fixedFont">BasicForm</span>  this</dd>
2692
2693                                 </dl>
2694
2695
2696
2697
2698
2699
2700
2701                     </div>
2702                 </div>
2703
2704             </td>
2705             <td class="msource">
2706
2707                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2708                 &nbsp;
2709             </td>
2710         </tr>
2711
2712
2713           <tr class="method-row config-row-alt0 expandable">
2714             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2715
2716
2717             <td class="sig">
2718                 <a id="Roo.form.BasicForm-method-markInvalid"   name=".markInvalid"></a>
2719                 <div class="fixedFont">
2720                         <span class="attributes"></span><b class="itemname">markInvalid</b>
2721
2722                                  (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>errors</i></B>)
2723
2724
2725                                          :
2726
2727
2728                                                 BasicForm
2729
2730
2731
2732
2733
2734                 </div>
2735                 <div class="mdesc">
2736
2737                    <div class="short">Mark fields in this form invalid in bulk.</div>
2738
2739
2740
2741                     <div class="long">
2742
2743                                 Mark fields in this form invalid in bulk.
2744
2745
2746
2747
2748
2749
2750                                 <dl class="detailList">
2751                                 <dt class="heading">Parameters:</dt>
2752
2753                                         <dt>
2754                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span>  <b>errors</b>
2755
2756                                         </dt>
2757                                         <dd>Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}</dd>
2758
2759                                 </dl>
2760
2761
2762
2763
2764
2765                                 <dl class="detailList">
2766                                 <dt class="heading">Returns:</dt>
2767
2768                                         <dd><span class="fixedFont">BasicForm</span>  this</dd>
2769
2770                                 </dl>
2771
2772
2773
2774
2775
2776
2777
2778                     </div>
2779                 </div>
2780
2781             </td>
2782             <td class="msource">
2783
2784                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2785                 &nbsp;
2786             </td>
2787         </tr>
2788
2789
2790           <tr class="method-row config-row-alt1 expandable">
2791             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2792
2793
2794             <td class="sig">
2795                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
2796                 <div class="fixedFont">
2797                         <span class="attributes"></span><b class="itemname">on</b>
2798
2799                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
2800
2801
2802
2803                 </div>
2804                 <div class="mdesc">
2805
2806                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2807
2808
2809
2810                     <div class="long">
2811
2812                                 Appends an event handler to this element (shorthand for addListener)
2813
2814
2815
2816
2817
2818
2819                                 <dl class="detailList">
2820                                 <dt class="heading">Parameters:</dt>
2821
2822                                         <dt>
2823                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
2824
2825                                         </dt>
2826                                         <dd>The type of event to listen for</dd>
2827
2828                                         <dt>
2829                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
2830
2831                                         </dt>
2832                                         <dd>The method the event invokes</dd>
2833
2834                                         <dt>
2835                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
2836
2837                                         </dt>
2838                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2839
2840                                         <dt>
2841                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
2842
2843                                         </dt>
2844                                         <dd>(optional)</dd>
2845
2846                                 </dl>
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858                     </div>
2859                 </div>
2860
2861             </td>
2862             <td class="msource">
2863
2864                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2865                 &nbsp;
2866             </td>
2867         </tr>
2868
2869
2870           <tr class="method-row config-row-alt0 expandable">
2871             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2872
2873
2874             <td class="sig">
2875                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
2876                 <div class="fixedFont">
2877                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
2878
2879                                  ()
2880
2881
2882
2883                 </div>
2884                 <div class="mdesc">
2885
2886                    <div class="short">Removes all listeners for this object</div>
2887
2888
2889
2890                     <div class="long">
2891
2892                                 Removes all listeners for this object
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909                     </div>
2910                 </div>
2911
2912             </td>
2913             <td class="msource">
2914
2915                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2916                 &nbsp;
2917             </td>
2918         </tr>
2919
2920
2921           <tr class="method-row config-row-alt1 expandable">
2922             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2923
2924
2925             <td class="sig">
2926                 <a id="Roo.form.BasicForm-method-remove"   name=".remove"></a>
2927                 <div class="fixedFont">
2928                         <span class="attributes"></span><b class="itemname">remove</b>
2929
2930                                  (Field <B><i>field</i></B>)
2931
2932
2933                                          :
2934
2935
2936                                                 BasicForm
2937
2938
2939
2940
2941
2942                 </div>
2943                 <div class="mdesc">
2944
2945                    <div class="short">Removes a field from the items collection (does NOT remove its markup).</div>
2946
2947
2948
2949                     <div class="long">
2950
2951                                 Removes a field from the items collection (does NOT remove its markup).
2952
2953
2954
2955
2956
2957
2958                                 <dl class="detailList">
2959                                 <dt class="heading">Parameters:</dt>
2960
2961                                         <dt>
2962                                                 <span class="fixedFont">Field</span>  <b>field</b>
2963
2964                                         </dt>
2965                                         <dd></dd>
2966
2967                                 </dl>
2968
2969
2970
2971
2972
2973                                 <dl class="detailList">
2974                                 <dt class="heading">Returns:</dt>
2975
2976                                         <dd><span class="fixedFont">BasicForm</span>  this</dd>
2977
2978                                 </dl>
2979
2980
2981
2982
2983
2984
2985
2986                     </div>
2987                 </div>
2988
2989             </td>
2990             <td class="msource">
2991
2992                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2993                 &nbsp;
2994             </td>
2995         </tr>
2996
2997
2998           <tr class="method-row config-row-alt0 expandable">
2999             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3000
3001
3002             <td class="sig">
3003                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
3004                 <div class="fixedFont">
3005                         <span class="attributes"></span><b class="itemname">removeListener</b>
3006
3007                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
3008
3009
3010
3011                 </div>
3012                 <div class="mdesc">
3013
3014                    <div class="short">Removes a listener</div>
3015
3016
3017
3018                     <div class="long">
3019
3020                                 Removes a listener
3021
3022
3023
3024
3025
3026
3027                                 <dl class="detailList">
3028                                 <dt class="heading">Parameters:</dt>
3029
3030                                         <dt>
3031                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
3032
3033                                         </dt>
3034                                         <dd>The type of event to listen for</dd>
3035
3036                                         <dt>
3037                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
3038
3039                                         </dt>
3040                                         <dd>The handler to remove</dd>
3041
3042                                         <dt>
3043                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
3044
3045                                         </dt>
3046                                         <dd>(optional) The scope (this object) for the handler</dd>
3047
3048                                 </dl>
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060                     </div>
3061                 </div>
3062
3063             </td>
3064             <td class="msource">
3065
3066                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3067                 &nbsp;
3068             </td>
3069         </tr>
3070
3071
3072           <tr class="method-row config-row-alt1 expandable notInherited">
3073             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3074
3075
3076             <td class="sig">
3077                 <a id="Roo.form.Form-method-render"   name=".render"></a>
3078                 <div class="fixedFont">
3079                         <span class="attributes"></span><b class="itemname">render</b>
3080
3081                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
3082
3083
3084                                          :
3085
3086
3087                                                 Form
3088
3089
3090
3091
3092
3093                 </div>
3094                 <div class="mdesc">
3095
3096                    <div class="short">Render this form into the passed container.</div>
3097
3098
3099
3100                     <div class="long">
3101
3102                                 Render this form into the passed container. This should only be called once!
3103
3104
3105
3106
3107
3108
3109                                 <dl class="detailList">
3110                                 <dt class="heading">Parameters:</dt>
3111
3112                                         <dt>
3113                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>container</b>
3114
3115                                         </dt>
3116                                         <dd>The element this component should be rendered into</dd>
3117
3118                                 </dl>
3119
3120
3121
3122
3123
3124                                 <dl class="detailList">
3125                                 <dt class="heading">Returns:</dt>
3126
3127                                         <dd><span class="fixedFont">Form</span>  this</dd>
3128
3129                                 </dl>
3130
3131
3132
3133
3134
3135
3136
3137                     </div>
3138                 </div>
3139
3140             </td>
3141             <td class="msource">
3142
3143                         Roo.form.Form
3144                 &nbsp;
3145             </td>
3146         </tr>
3147
3148
3149           <tr class="method-row config-row-alt0 expandable">
3150             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3151
3152
3153             <td class="sig">
3154                 <a id="Roo.form.BasicForm-method-reset"   name=".reset"></a>
3155                 <div class="fixedFont">
3156                         <span class="attributes"></span><b class="itemname">reset</b>
3157
3158                                  ()
3159
3160
3161                                          :
3162
3163
3164                                                 BasicForm
3165
3166
3167
3168
3169
3170                 </div>
3171                 <div class="mdesc">
3172
3173                    <div class="short">Resets this form.</div>
3174
3175
3176
3177                     <div class="long">
3178
3179                                 Resets this form.
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190                                 <dl class="detailList">
3191                                 <dt class="heading">Returns:</dt>
3192
3193                                         <dd><span class="fixedFont">BasicForm</span>  this</dd>
3194
3195                                 </dl>
3196
3197
3198
3199
3200
3201
3202
3203                     </div>
3204                 </div>
3205
3206             </td>
3207             <td class="msource">
3208
3209                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
3210                 &nbsp;
3211             </td>
3212         </tr>
3213
3214
3215           <tr class="method-row config-row-alt1 expandable">
3216             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3217
3218
3219             <td class="sig">
3220                 <a id="Roo.form.BasicForm-method-resetHasChanged"   name=".resetHasChanged"></a>
3221                 <div class="fixedFont">
3222                         <span class="attributes"></span><b class="itemname">resetHasChanged</b>
3223
3224                                  ()
3225
3226
3227                                          :
3228
3229
3230
3231
3232
3233
3234
3235
3236                 </div>
3237                 <div class="mdesc">
3238
3239                    <div class="short">Resets all hasChanged to 'false' -<br/>The old 'isDirty' used 'original value.</div>
3240
3241
3242
3243                     <div class="long">
3244
3245                                 Resets all hasChanged to 'false' -<br/>The old 'isDirty' used 'original value..' however this breaks reset() and a few other things.<br/>So hasChanged storage is only to be used for this purpose
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256                                 <dl class="detailList">
3257                                 <dt class="heading">Returns:</dt>
3258
3259                                         <dd> Boolean</dd>
3260
3261                                 </dl>
3262
3263
3264
3265
3266
3267
3268
3269                     </div>
3270                 </div>
3271
3272             </td>
3273             <td class="msource">
3274
3275                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
3276                 &nbsp;
3277             </td>
3278         </tr>
3279
3280
3281           <tr class="method-row config-row-alt0 expandable">
3282             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3283
3284
3285             <td class="sig">
3286                 <a id="Roo.form.BasicForm-method-setValues"   name=".setValues"></a>
3287                 <div class="fixedFont">
3288                         <span class="attributes"></span><b class="itemname">setValues</b>
3289
3290                                  (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>values</i></B>)
3291
3292
3293                                          :
3294
3295
3296                                                 BasicForm
3297
3298
3299
3300
3301
3302                 </div>
3303                 <div class="mdesc">
3304
3305                    <div class="short">Set values for fields in this form in bulk.</div>
3306
3307
3308
3309                     <div class="long">
3310
3311                                 Set values for fields in this form in bulk.
3312
3313
3314
3315
3316
3317
3318                                 <dl class="detailList">
3319                                 <dt class="heading">Parameters:</dt>
3320
3321                                         <dt>
3322                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span>  <b>values</b>
3323
3324                                         </dt>
3325                                         <dd>Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}</dd>
3326
3327                                 </dl>
3328
3329
3330
3331
3332
3333                                 <dl class="detailList">
3334                                 <dt class="heading">Returns:</dt>
3335
3336                                         <dd><span class="fixedFont">BasicForm</span>  this</dd>
3337
3338                                 </dl>
3339
3340
3341
3342
3343
3344
3345
3346                     </div>
3347                 </div>
3348
3349             </td>
3350             <td class="msource">
3351
3352                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
3353                 &nbsp;
3354             </td>
3355         </tr>
3356
3357
3358           <tr class="method-row config-row-alt1 expandable notInherited">
3359             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3360
3361
3362             <td class="sig">
3363                 <a id="Roo.form.Form-method-start"   name=".start"></a>
3364                 <div class="fixedFont">
3365                         <span class="attributes"></span><b class="itemname">start</b>
3366
3367                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>container</i></B>)
3368
3369
3370                                          :
3371
3372
3373                                                 Form
3374
3375
3376
3377
3378
3379                 </div>
3380                 <div class="mdesc">
3381
3382                    <div class="short">Opens the passed container in the layout stack.</div>
3383
3384
3385
3386                     <div class="long">
3387
3388                                 Opens the passed container in the layout stack. The container can be any {<b>link</b> Roo.form.Layout} or subclass.
3389
3390
3391
3392
3393
3394
3395                                 <dl class="detailList">
3396                                 <dt class="heading">Parameters:</dt>
3397
3398                                         <dt>
3399                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>container</b>
3400
3401                                         </dt>
3402                                         <dd>A Roo.form.Layout or subclass of Layout</dd>
3403
3404                                 </dl>
3405
3406
3407
3408
3409
3410                                 <dl class="detailList">
3411                                 <dt class="heading">Returns:</dt>
3412
3413                                         <dd><span class="fixedFont">Form</span>  this</dd>
3414
3415                                 </dl>
3416
3417
3418
3419
3420
3421
3422
3423                     </div>
3424                 </div>
3425
3426             </td>
3427             <td class="msource">
3428
3429                         Roo.form.Form
3430                 &nbsp;
3431             </td>
3432         </tr>
3433
3434
3435           <tr class="method-row config-row-alt0 expandable notInherited">
3436             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3437
3438
3439             <td class="sig">
3440                 <a id="Roo.form.Form-method-startMonitoring"   name=".startMonitoring"></a>
3441                 <div class="fixedFont">
3442                         <span class="attributes"></span><b class="itemname">startMonitoring</b>
3443
3444                                  ()
3445
3446
3447
3448                 </div>
3449                 <div class="mdesc">
3450
3451                    <div class="short">Starts monitoring of the valid state of this form.</div>
3452
3453
3454
3455                     <div class="long">
3456
3457                                 Starts monitoring of the valid state of this form. Usually this is done by passing the config<br/>option "monitorValid"
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474                     </div>
3475                 </div>
3476
3477             </td>
3478             <td class="msource">
3479
3480                         Roo.form.Form
3481                 &nbsp;
3482             </td>
3483         </tr>
3484
3485
3486           <tr class="method-row config-row-alt1 expandable notInherited">
3487             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3488
3489
3490             <td class="sig">
3491                 <a id="Roo.form.Form-method-stopMonitoring"   name=".stopMonitoring"></a>
3492                 <div class="fixedFont">
3493                         <span class="attributes"></span><b class="itemname">stopMonitoring</b>
3494
3495                                  ()
3496
3497
3498
3499                 </div>
3500                 <div class="mdesc">
3501
3502                    <div class="short">Stops monitoring of the valid state of this form</div>
3503
3504
3505
3506                     <div class="long">
3507
3508                                 Stops monitoring of the valid state of this form
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525                     </div>
3526                 </div>
3527
3528             </td>
3529             <td class="msource">
3530
3531                         Roo.form.Form
3532                 &nbsp;
3533             </td>
3534         </tr>
3535
3536
3537           <tr class="method-row config-row-alt0 expandable">
3538             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3539
3540
3541             <td class="sig">
3542                 <a id="Roo.form.BasicForm-method-submit"   name=".submit"></a>
3543                 <div class="fixedFont">
3544                         <span class="attributes"></span><b class="itemname">submit</b>
3545
3546                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
3547
3548
3549                                          :
3550
3551
3552                                                 BasicForm
3553
3554
3555
3556
3557
3558                 </div>
3559                 <div class="mdesc">
3560
3561                    <div class="short">Shortcut to do a submit action.</div>
3562
3563
3564
3565                     <div class="long">
3566
3567                                 Shortcut to do a submit action.
3568
3569
3570
3571
3572
3573
3574                                 <dl class="detailList">
3575                                 <dt class="heading">Parameters:</dt>
3576
3577                                         <dt>
3578                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
3579
3580                                         </dt>
3581                                         <dd>The options to pass to the action (see {<b>link</b> <b>doAction</b>} for details)</dd>
3582
3583                                 </dl>
3584
3585
3586
3587
3588
3589                                 <dl class="detailList">
3590                                 <dt class="heading">Returns:</dt>
3591
3592                                         <dd><span class="fixedFont">BasicForm</span>  this</dd>
3593
3594                                 </dl>
3595
3596
3597
3598
3599
3600
3601
3602                     </div>
3603                 </div>
3604
3605             </td>
3606             <td class="msource">
3607
3608                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
3609                 &nbsp;
3610             </td>
3611         </tr>
3612
3613
3614           <tr class="method-row config-row-alt1 expandable">
3615             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3616
3617
3618             <td class="sig">
3619                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
3620                 <div class="fixedFont">
3621                         <span class="attributes"></span><b class="itemname">un</b>
3622
3623                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
3624
3625
3626
3627                 </div>
3628                 <div class="mdesc">
3629
3630                    <div class="short">Removes a listener (shorthand for removeListener)</div>
3631
3632
3633
3634                     <div class="long">
3635
3636                                 Removes a listener (shorthand for removeListener)
3637
3638
3639
3640
3641
3642
3643                                 <dl class="detailList">
3644                                 <dt class="heading">Parameters:</dt>
3645
3646                                         <dt>
3647                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
3648
3649                                         </dt>
3650                                         <dd>The type of event to listen for</dd>
3651
3652                                         <dt>
3653                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
3654
3655                                         </dt>
3656                                         <dd>The handler to remove</dd>
3657
3658                                         <dt>
3659                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
3660
3661                                         </dt>
3662                                         <dd>(optional) The scope (this object) for the handler</dd>
3663
3664                                 </dl>
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676                     </div>
3677                 </div>
3678
3679             </td>
3680             <td class="msource">
3681
3682                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3683                 &nbsp;
3684             </td>
3685         </tr>
3686
3687
3688           <tr class="method-row config-row-alt0 expandable">
3689             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3690
3691
3692             <td class="sig">
3693                 <a id="Roo.form.BasicForm-method-updateRecord"   name=".updateRecord"></a>
3694                 <div class="fixedFont">
3695                         <span class="attributes"></span><b class="itemname">updateRecord</b>
3696
3697                                  (Record <B><i>record</i></B>)
3698
3699
3700                                          :
3701
3702
3703                                                 BasicForm
3704
3705
3706
3707
3708
3709                 </div>
3710                 <div class="mdesc">
3711
3712                    <div class="short">Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.</div>
3713
3714
3715
3716                     <div class="long">
3717
3718                                 Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.
3719
3720
3721
3722
3723
3724
3725                                 <dl class="detailList">
3726                                 <dt class="heading">Parameters:</dt>
3727
3728                                         <dt>
3729                                                 <span class="fixedFont">Record</span>  <b>record</b>
3730
3731                                         </dt>
3732                                         <dd>The record to edit</dd>
3733
3734                                 </dl>
3735
3736
3737
3738
3739
3740                                 <dl class="detailList">
3741                                 <dt class="heading">Returns:</dt>
3742
3743                                         <dd><span class="fixedFont">BasicForm</span>  this</dd>
3744
3745                                 </dl>
3746
3747
3748
3749
3750
3751
3752
3753                     </div>
3754                 </div>
3755
3756             </td>
3757             <td class="msource">
3758
3759                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
3760                 &nbsp;
3761             </td>
3762         </tr>
3763
3764
3765     </table>
3766
3767
3768   <!-- ============================== events summary / details ======================== -->
3769
3770
3771   <a id="Roo.form.Form-events"></a>
3772
3773
3774
3775
3776
3777
3778
3779
3780       <table cellspacing="0" class="member-table">
3781                 <caption>Events</caption>
3782               <thead>
3783                 <tr>
3784                     <th class="sig-header" colspan="2">Event</th>
3785                     <th class="msource-header">Defined By</th>
3786
3787                 </tr>
3788               </thead>
3789
3790
3791
3792
3793
3794           <tr class="method-row expandable config-row-alt0">
3795             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3796
3797             <td class="sig">
3798                 <a id="Roo.form.BasicForm-event-*actioncomplete"></a>
3799
3800                <div class="fixedFont">
3801                 <b class="itemname">actioncomplete</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
3802
3803                 </div>
3804
3805                 <div class="mdesc">
3806
3807                    <div class="short">Fires when an action is completed.
3808
3809                 </div>
3810
3811                     <div class="long">
3812
3813                         Fires when an action is completed.
3814
3815
3816
3817
3818
3819                                 <dl class="detailList">
3820                                 <dt class="heading">Parameters:</dt>
3821
3822                                         <dt>
3823                                                 <span class="fixedFont">Form</span> <b>this</b>
3824
3825                                         </dt>
3826                                         <dd></dd>
3827
3828                                         <dt>
3829                                                 <span class="fixedFont">Action</span> <b>action</b>
3830
3831                                         </dt>
3832                                         <dd>The action that completed</dd>
3833
3834                                 </dl>
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846                     </div>
3847                 </div>
3848
3849             </td>
3850             <td class="msource">
3851                 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
3852             </td>
3853         </tr>
3854
3855           <tr class="method-row expandable config-row-alt1">
3856             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3857
3858             <td class="sig">
3859                 <a id="Roo.form.BasicForm-event-*actionfailed"></a>
3860
3861                <div class="fixedFont">
3862                 <b class="itemname">actionfailed</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
3863
3864                 </div>
3865
3866                 <div class="mdesc">
3867
3868                    <div class="short">Fires when an action fails.
3869
3870                 </div>
3871
3872                     <div class="long">
3873
3874                         Fires when an action fails.
3875
3876
3877
3878
3879
3880                                 <dl class="detailList">
3881                                 <dt class="heading">Parameters:</dt>
3882
3883                                         <dt>
3884                                                 <span class="fixedFont">Form</span> <b>this</b>
3885
3886                                         </dt>
3887                                         <dd></dd>
3888
3889                                         <dt>
3890                                                 <span class="fixedFont">Action</span> <b>action</b>
3891
3892                                         </dt>
3893                                         <dd>The action that failed</dd>
3894
3895                                 </dl>
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907                     </div>
3908                 </div>
3909
3910             </td>
3911             <td class="msource">
3912                 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
3913             </td>
3914         </tr>
3915
3916           <tr class="method-row expandable config-row-alt0">
3917             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3918
3919             <td class="sig">
3920                 <a id="Roo.form.BasicForm-event-*beforeaction"></a>
3921
3922                <div class="fixedFont">
3923                 <b class="itemname">beforeaction</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
3924
3925                 </div>
3926
3927                 <div class="mdesc">
3928
3929                    <div class="short">Fires before any action is performed.
3930
3931                 </div>
3932
3933                     <div class="long">
3934
3935                         Fires before any action is performed. Return false to cancel the action.
3936
3937
3938
3939
3940
3941                                 <dl class="detailList">
3942                                 <dt class="heading">Parameters:</dt>
3943
3944                                         <dt>
3945                                                 <span class="fixedFont">Form</span> <b>this</b>
3946
3947                                         </dt>
3948                                         <dd></dd>
3949
3950                                         <dt>
3951                                                 <span class="fixedFont">Action</span> <b>action</b>
3952
3953                                         </dt>
3954                                         <dd>The action to be performed</dd>
3955
3956                                 </dl>
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968                     </div>
3969                 </div>
3970
3971             </td>
3972             <td class="msource">
3973                 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
3974             </td>
3975         </tr>
3976
3977           <tr class="method-row expandable config-row-alt1 notInherited">
3978             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3979
3980             <td class="sig">
3981                 <a id="Roo.form.Form-event-*clientvalidation"></a>
3982
3983                <div class="fixedFont">
3984                 <b class="itemname">clientvalidation</b> (Form <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>valid</i></B>)
3985
3986                 </div>
3987
3988                 <div class="mdesc">
3989
3990                    <div class="short">If the monitorValid config option is true, this event fires repetitively to notify of valid state
3991
3992                 </div>
3993
3994                     <div class="long">
3995
3996                         If the monitorValid config option is true, this event fires repetitively to notify of valid state
3997
3998
3999
4000
4001
4002                                 <dl class="detailList">
4003                                 <dt class="heading">Parameters:</dt>
4004
4005                                         <dt>
4006                                                 <span class="fixedFont">Form</span> <b>this</b>
4007
4008                                         </dt>
4009                                         <dd></dd>
4010
4011                                         <dt>
4012                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>valid</b>
4013
4014                                         </dt>
4015                                         <dd>true if the form has passed client-side validation</dd>
4016
4017                                 </dl>
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029                     </div>
4030                 </div>
4031
4032             </td>
4033             <td class="msource">
4034                 Roo.form.Form
4035             </td>
4036         </tr>
4037
4038           <tr class="method-row expandable config-row-alt0 notInherited">
4039             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
4040
4041             <td class="sig">
4042                 <a id="Roo.form.Form-event-*rendered"></a>
4043
4044                <div class="fixedFont">
4045                 <b class="itemname">rendered</b> (<a href="./Roo.form.Form.html#constructor" roo:cls="Roo.form.Form.html#constructor">Roo.form.Form</a> <B><i>form</i></B>)
4046
4047                 </div>
4048
4049                 <div class="mdesc">
4050
4051                    <div class="short">Fires when the form is rendered
4052
4053                 </div>
4054
4055                     <div class="long">
4056
4057                         Fires when the form is rendered
4058
4059
4060
4061
4062
4063                                 <dl class="detailList">
4064                                 <dt class="heading">Parameters:</dt>
4065
4066                                         <dt>
4067                                                 <span class="fixedFont"><a href="./Roo.form.Form.html#constructor" roo:cls="Roo.form.Form.html#constructor">Roo.form.Form</a></span> <b>form</b>
4068
4069                                         </dt>
4070                                         <dd></dd>
4071
4072                                 </dl>
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084                     </div>
4085                 </div>
4086
4087             </td>
4088             <td class="msource">
4089                 Roo.form.Form
4090             </td>
4091         </tr>
4092
4093
4094     </table>
4095
4096
4097
4098
4099
4100 <!-- ============================== footer ================================= -->
4101                 <div class="fineprint" style="clear:both">
4102
4103                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:54 GMT+0800 (HKT)
4104                         Based on
4105                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
4106                 </div>
4107         </body>
4108 </html>