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