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.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.Form
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.form.Form
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_form_Form.js.html">Roo/form/Form.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">Form</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         Adds the ability to dynamically render forms with JavaScript to {<b>link</b> Roo.form.BasicForm}.
  86     </div>
  87
  88
  89 <!-- ============================== Class comment block... ========================== -->
  90
  91 <div class="comments">
  92         <b>Class Comments / Notes</B> =>
  93         <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.Form';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo.form" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.form.Form.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.form.Form-configs"></a>
 108
 109
 110
 111
 112
 113       <table cellspacing="0" class="member-table">
 114       <caption>Config Options (Usually are also Properties)</caption>
 115
 116
 117         <tr>
 118             <th class="sig-header" colspan="2">Options</th>
 119
 120             <th class="msource-header">Defined By</th>
 121         </tr>
 122
 123
 124
 125
 126
 127                 <tr class="config-row expandable config-row-alt0 notInherited">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 131                         <a id="Roo.form.Form-cfg-buttonAlign" name=".buttonAlign"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">buttonAlign</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">Valid values are "left," "center" and "right" (defaults to "center")</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">Valid values are "left," "center" and "right" (defaults to "center")</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.form.Form
 152
 153                     </td>
 154                 </tr>
 155
 156
 157                 <tr class="config-row expandable config-row-alt1 notInherited">
 158                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 159                     <td class="sig">
 160
 161                         <a id="Roo.form.Form-cfg-itemCls" name=".itemCls"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">itemCls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">A css class to apply to the x-form-item of fields.</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">A css class to apply to the x-form-item of fields. This property cascades to child containers.</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.form.Form
 182
 183                     </td>
 184                 </tr>
 185
 186
 187                 <tr class="config-row expandable config-row-alt0 notInherited">
 188                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 189                     <td class="sig">
 190
 191                         <a id="Roo.form.Form-cfg-labelAlign" name=".labelAlign"></a>
 192                         <div class="fixedFont">
 193                                 <b  class="itemname">labelAlign</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 199                             <div class="short">Valid values are "left," "top" and "right" (defaults to "left").</div>
 200                         </div>
 201
 202                         <div class="mdesc">
 203                             <div class="long">Valid values are "left," "top" and "right" (defaults to "left").<br/>This property cascades to child containers if not set.</div>
 204                         </div>
 205
 206
 207
 208                     </td>
 209                     <td class="msource">
 210
 211                         Roo.form.Form
 212
 213                     </td>
 214                 </tr>
 215
 216
 217                 <tr class="config-row expandable config-row-alt1 notInherited">
 218                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 219                     <td class="sig">
 220
 221                         <a id="Roo.form.Form-cfg-labelWidth" name=".labelWidth"></a>
 222                         <div class="fixedFont">
 223                                 <b  class="itemname">labelWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 224
 225
 226                         </div>
 227
 228                         <div class="mdesc">
 229                             <div class="short">The width of labels.</div>
 230                         </div>
 231
 232                         <div class="mdesc">
 233                             <div class="long">The width of labels. This property cascades to child containers.</div>
 234                         </div>
 235
 236
 237
 238                     </td>
 239                     <td class="msource">
 240
 241                         Roo.form.Form
 242
 243                     </td>
 244                 </tr>
 245
 246
 247                 <tr class="config-row expandable config-row-alt0 notInherited">
 248                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 249                     <td class="sig">
 250
 251                         <a id="Roo.form.Form-cfg-minButtonWidth" name=".minButtonWidth"></a>
 252                         <div class="fixedFont">
 253                                 <b  class="itemname">minButtonWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 254
 255
 256                         </div>
 257
 258                         <div class="mdesc">
 259                             <div class="short">Minimum width of all buttons in pixels (defaults to 75)</div>
 260                         </div>
 261
 262                         <div class="mdesc">
 263                             <div class="long">Minimum width of all buttons in pixels (defaults to 75)</div>
 264                         </div>
 265
 266
 267
 268                     </td>
 269                     <td class="msource">
 270
 271                         Roo.form.Form
 272
 273                     </td>
 274                 </tr>
 275
 276
 277                 <tr class="config-row expandable config-row-alt1 notInherited">
 278                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 279                     <td class="sig">
 280
 281                         <a id="Roo.form.Form-cfg-monitorPoll" name=".monitorPoll"></a>
 282                         <div class="fixedFont">
 283                                 <b  class="itemname">monitorPoll</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 284
 285
 286                         </div>
 287
 288                         <div class="mdesc">
 289                             <div class="short">The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)</div>
 290                         </div>
 291
 292                         <div class="mdesc">
 293                             <div class="long">The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)</div>
 294                         </div>
 295
 296
 297
 298                     </td>
 299                     <td class="msource">
 300
 301                         Roo.form.Form
 302
 303                     </td>
 304                 </tr>
 305
 306
 307                 <tr class="config-row expandable config-row-alt0 notInherited">
 308                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 309                     <td class="sig">
 310
 311                         <a id="Roo.form.Form-cfg-monitorValid" name=".monitorValid"></a>
 312                         <div class="fixedFont">
 313                                 <b  class="itemname">monitorValid</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 314
 315
 316                         </div>
 317
 318                         <div class="mdesc">
 319                             <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>
 320                         </div>
 321
 322                         <div class="mdesc">
 323                             <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>
 324                         </div>
 325
 326
 327
 328                     </td>
 329                     <td class="msource">
 330
 331                         Roo.form.Form
 332
 333                     </td>
 334                 </tr>
 335
 336
 337     </table>
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347   <!-- ============================== public properties ==================== -->
 348
 349
 350
 351     <a id="Roo.form.Form-props"></a>
 352
 353
 354
 355
 356
 357      <table cellspacing="0" class="member-table">
 358       <caption class="Empty">Public Properties - Has None</caption>
 359      </table>
 360
 361
 362
 363
 364   <!-- ============================== methods summary / details ======================== -->
 365
 366
 367   <a id="Roo.form.Form-methods"></a>
 368         <!-- constructor?? -->
 369
 370         <!-- static's first
 371
 372
 373         -->
 374
 375         <!-- then dynamics first -->
 376
 377
 378
 379
 380
 381
 382       <table cellspacing="0" class="member-table">
 383       <caption>Public Methods</caption>
 384         <tr>
 385             <th class="sig-header" colspan="2">Method</th>
 386             <th class="msource-header">Defined By</th>
 387
 388         </tr>
 389
 390
 391
 392
 393
 394
 395
 396           <tr class="method-row config-row-alt0 expandable notInherited">
 397             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 398
 399
 400             <td class="sig">
 401                 <a id="Roo.form-method-Form"   name=".Form"></a>
 402                 <div class="fixedFont">
 403                         <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">Form</b>
 404
 405                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 406
 407
 408
 409                 </div>
 410                 <div class="mdesc">
 411
 412
 413                         <div class="short">Create a new Roo.form.Form</div>
 414
 415
 416                     <div class="long">
 417
 418
 419
 420                                 Create a new Roo.form.Form
 421
 422
 423                                 <dl class="detailList">
 424                                 <dt class="heading">Parameters:</dt>
 425
 426                                         <dt>
 427                                                 <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>
 428
 429                                         </dt>
 430                                         <dd>Configuration options</dd>
 431
 432                                 </dl>
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444                     </div>
 445                 </div>
 446
 447             </td>
 448             <td class="msource">
 449                 &nbsp;
 450             </td>
 451         </tr>
 452
 453
 454           <tr class="method-row config-row-alt1 expandable notInherited">
 455             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 456
 457
 458             <td class="sig">
 459                 <a id="Roo.form.Form-method-add"   name=".add"></a>
 460                 <div class="fixedFont">
 461                         <span class="attributes"></span><b class="itemname">add</b>
 462
 463                                  (Field <B><i>field1</i></B>, Field <B><i>field2</i></B>)
 464
 465
 466                                          :
 467
 468
 469                                                 Form
 470
 471
 472
 473
 474
 475                 </div>
 476                 <div class="mdesc">
 477
 478                    <div class="short">Add Roo.form components to the current open container (e.g.</div>
 479
 480
 481
 482                     <div class="long">
 483
 484                                 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.
 485
 486
 487
 488
 489
 490
 491                                 <dl class="detailList">
 492                                 <dt class="heading">Parameters:</dt>
 493
 494                                         <dt>
 495                                                 <span class="fixedFont">Field</span>  <b>field1</b>
 496
 497                                         </dt>
 498                                         <dd></dd>
 499
 500                                         <dt>
 501                                                 <span class="fixedFont">Field</span>  <b>field2</b>
 502
 503                                         </dt>
 504                                         <dd>(optional)</dd>
 505
 506                                         <dt>
 507                                                 <span class="fixedFont">Field</span>  <b>etc.</b>
 508
 509                                         </dt>
 510                                         <dd>(optional)</dd>
 511
 512                                 </dl>
 513
 514
 515
 516
 517
 518                                 <dl class="detailList">
 519                                 <dt class="heading">Returns:</dt>
 520
 521                                         <dd><span class="fixedFont">Form</span>  this</dd>
 522
 523                                 </dl>
 524
 525
 526
 527
 528
 529
 530
 531                     </div>
 532                 </div>
 533
 534             </td>
 535             <td class="msource">
 536
 537                         Roo.form.Form
 538                 &nbsp;
 539             </td>
 540         </tr>
 541
 542
 543           <tr class="method-row config-row-alt0 expandable notInherited">
 544             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 545
 546
 547             <td class="sig">
 548                 <a id="Roo.form.Form-method-addButton"   name=".addButton"></a>
 549                 <div class="fixedFont">
 550                         <span class="attributes"></span><b class="itemname">addButton</b>
 551
 552                                  (<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>)
 553
 554
 555                                          :
 556
 557
 558                                                 <a href="./Roo.Button.html#constructor" roo:cls="Roo.Button.html#constructor">Roo.Button</a>
 559
 560
 561
 562
 563
 564                 </div>
 565                 <div class="mdesc">
 566
 567                    <div class="short">Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.</div>
 568
 569
 570
 571                     <div class="long">
 572
 573                                 Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.
 574
 575
 576
 577
 578
 579
 580                                 <dl class="detailList">
 581                                 <dt class="heading">Parameters:</dt>
 582
 583                                         <dt>
 584                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span>  <b>config</b>
 585
 586                                         </dt>
 587                                         <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>
 588
 589                                         <dt>
 590                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 591
 592                                         </dt>
 593                                         <dd>The function called when the button is clicked</dd>
 594
 595                                         <dt>
 596                                                 <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>
 597
 598                                         </dt>
 599                                         <dd>(optional) The scope of the handler function</dd>
 600
 601                                 </dl>
 602
 603
 604
 605
 606
 607                                 <dl class="detailList">
 608                                 <dt class="heading">Returns:</dt>
 609
 610                                         <dd><span class="fixedFont"><a href="./Roo.Button.html#constructor" roo:cls="Roo.Button.html#constructor">Roo.Button</a></span>  </dd>
 611
 612                                 </dl>
 613
 614
 615
 616
 617
 618
 619
 620                     </div>
 621                 </div>
 622
 623             </td>
 624             <td class="msource">
 625
 626                         Roo.form.Form
 627                 &nbsp;
 628             </td>
 629         </tr>
 630
 631
 632           <tr class="method-row config-row-alt1 expandable notInherited">
 633             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 634
 635
 636             <td class="sig">
 637                 <a id="Roo.form.Form-method-addxtype"   name=".addxtype"></a>
 638                 <div class="fixedFont">
 639                         <span class="attributes"></span><b class="itemname">addxtype</b>
 640
 641                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 642
 643
 644
 645                 </div>
 646                 <div class="mdesc">
 647
 648                    <div class="short">Adds a series of form elements (using the xtype property as the factory method.</div>
 649
 650
 651
 652                     <div class="long">
 653
 654                                 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)
 655
 656
 657
 658
 659
 660
 661                                 <dl class="detailList">
 662                                 <dt class="heading">Parameters:</dt>
 663
 664                                         <dt>
 665                                                 <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>
 666
 667                                         </dt>
 668                                         <dd></dd>
 669
 670                                 </dl>
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682                     </div>
 683                 </div>
 684
 685             </td>
 686             <td class="msource">
 687
 688                         Roo.form.Form
 689                 &nbsp;
 690             </td>
 691         </tr>
 692
 693
 694           <tr class="method-row config-row-alt0 expandable notInherited">
 695             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 696
 697
 698             <td class="sig">
 699                 <a id="Roo.form.Form-method-column"   name=".column"></a>
 700                 <div class="fixedFont">
 701                         <span class="attributes"></span><b class="itemname">column</b>
 702
 703                                  (<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>)
 704
 705
 706                                          :
 707
 708
 709
 710
 711
 712
 713
 714
 715                 </div>
 716                 <div class="mdesc">
 717
 718                    <div class="short">Opens a new {<b>link</b> Roo.form.Column} container in the layout stack.</div>
 719
 720
 721
 722                     <div class="long">
 723
 724                                 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.
 725
 726
 727
 728
 729
 730
 731                                 <dl class="detailList">
 732                                 <dt class="heading">Parameters:</dt>
 733
 734                                         <dt>
 735                                                 <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>
 736
 737                                         </dt>
 738                                         <dd>The config to pass to the column</dd>
 739
 740                                         <dt>
 741                                                 <span class="fixedFont">Field</span>  <b>field1</b>
 742
 743                                         </dt>
 744                                         <dd>(optional)</dd>
 745
 746                                         <dt>
 747                                                 <span class="fixedFont">Field</span>  <b>field2</b>
 748
 749                                         </dt>
 750                                         <dd>(optional)</dd>
 751
 752                                         <dt>
 753                                                 <span class="fixedFont">Field</span>  <b>etc</b>
 754
 755                                         </dt>
 756                                         <dd>(optional)</dd>
 757
 758                                 </dl>
 759
 760
 761
 762
 763
 764                                 <dl class="detailList">
 765                                 <dt class="heading">Returns:</dt>
 766
 767                                         <dd> Column The column container object</dd>
 768
 769                                 </dl>
 770
 771
 772
 773
 774
 775
 776
 777                     </div>
 778                 </div>
 779
 780             </td>
 781             <td class="msource">
 782
 783                         Roo.form.Form
 784                 &nbsp;
 785             </td>
 786         </tr>
 787
 788
 789           <tr class="method-row config-row-alt1 expandable notInherited">
 790             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 791
 792
 793             <td class="sig">
 794                 <a id="Roo.form.Form-method-container"   name=".container"></a>
 795                 <div class="fixedFont">
 796                         <span class="attributes"></span><b class="itemname">container</b>
 797
 798                                  (<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>)
 799
 800
 801                                          :
 802
 803
 804
 805
 806
 807
 808
 809
 810                 </div>
 811                 <div class="mdesc">
 812
 813                    <div class="short">Opens a new {<b>link</b> Roo.form.Layout} container in the layout stack.</div>
 814
 815
 816
 817                     <div class="long">
 818
 819                                 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.
 820
 821
 822
 823
 824
 825
 826                                 <dl class="detailList">
 827                                 <dt class="heading">Parameters:</dt>
 828
 829                                         <dt>
 830                                                 <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>
 831
 832                                         </dt>
 833                                         <dd>The config to pass to the Layout</dd>
 834
 835                                         <dt>
 836                                                 <span class="fixedFont">Field</span>  <b>field1</b>
 837
 838                                         </dt>
 839                                         <dd>(optional)</dd>
 840
 841                                         <dt>
 842                                                 <span class="fixedFont">Field</span>  <b>field2</b>
 843
 844                                         </dt>
 845                                         <dd>(optional)</dd>
 846
 847                                         <dt>
 848                                                 <span class="fixedFont">Field</span>  <b>etc</b>
 849
 850                                         </dt>
 851                                         <dd>(optional)</dd>
 852
 853                                 </dl>
 854
 855
 856
 857
 858
 859                                 <dl class="detailList">
 860                                 <dt class="heading">Returns:</dt>
 861
 862                                         <dd> Layout The container object</dd>
 863
 864                                 </dl>
 865
 866
 867
 868
 869
 870
 871
 872                     </div>
 873                 </div>
 874
 875             </td>
 876             <td class="msource">
 877
 878                         Roo.form.Form
 879                 &nbsp;
 880             </td>
 881         </tr>
 882
 883
 884           <tr class="method-row config-row-alt0 expandable notInherited">
 885             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 886
 887
 888             <td class="sig">
 889                 <a id="Roo.form.Form-method-end"   name=".end"></a>
 890                 <div class="fixedFont">
 891                         <span class="attributes"></span><b class="itemname">end</b>
 892
 893                                  ()
 894
 895
 896                                          :
 897
 898
 899                                                 Form
 900
 901
 902
 903
 904
 905                 </div>
 906                 <div class="mdesc">
 907
 908                    <div class="short">Closes the current open container</div>
 909
 910
 911
 912                     <div class="long">
 913
 914                                 Closes the current open container
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925                                 <dl class="detailList">
 926                                 <dt class="heading">Returns:</dt>
 927
 928                                         <dd><span class="fixedFont">Form</span>  this</dd>
 929
 930                                 </dl>
 931
 932
 933
 934
 935
 936
 937
 938                     </div>
 939                 </div>
 940
 941             </td>
 942             <td class="msource">
 943
 944                         Roo.form.Form
 945                 &nbsp;
 946             </td>
 947         </tr>
 948
 949
 950           <tr class="method-row config-row-alt1 expandable notInherited">
 951             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 952
 953
 954             <td class="sig">
 955                 <a id="Roo.form.Form-method-fieldset"   name=".fieldset"></a>
 956                 <div class="fixedFont">
 957                         <span class="attributes"></span><b class="itemname">fieldset</b>
 958
 959                                  (<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>)
 960
 961
 962                                          :
 963
 964
 965
 966
 967
 968
 969
 970
 971                 </div>
 972                 <div class="mdesc">
 973
 974                    <div class="short">Opens a new {<b>link</b> Roo.form.FieldSet} container in the layout stack.</div>
 975
 976
 977
 978                     <div class="long">
 979
 980                                 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.
 981
 982
 983
 984
 985
 986
 987                                 <dl class="detailList">
 988                                 <dt class="heading">Parameters:</dt>
 989
 990                                         <dt>
 991                                                 <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>
 992
 993                                         </dt>
 994                                         <dd>The config to pass to the fieldset</dd>
 995
 996                                         <dt>
 997                                                 <span class="fixedFont">Field</span>  <b>field1</b>
 998
 999                                         </dt>
1000                                         <dd>(optional)</dd>
1001
1002                                         <dt>
1003                                                 <span class="fixedFont">Field</span>  <b>field2</b>
1004
1005                                         </dt>
1006                                         <dd>(optional)</dd>
1007
1008                                         <dt>
1009                                                 <span class="fixedFont">Field</span>  <b>etc</b>
1010
1011                                         </dt>
1012                                         <dd>(optional)</dd>
1013
1014                                 </dl>
1015
1016
1017
1018
1019
1020                                 <dl class="detailList">
1021                                 <dt class="heading">Returns:</dt>
1022
1023                                         <dd> FieldSet The fieldset container object</dd>
1024
1025                                 </dl>
1026
1027
1028
1029
1030
1031
1032
1033                     </div>
1034                 </div>
1035
1036             </td>
1037             <td class="msource">
1038
1039                         Roo.form.Form
1040                 &nbsp;
1041             </td>
1042         </tr>
1043
1044
1045           <tr class="method-row config-row-alt0 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-findbyId"   name=".findbyId"></a>
1051                 <div class="fixedFont">
1052                         <span class="attributes"></span><b class="itemname">findbyId</b>
1053
1054                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1055
1056
1057                                          :
1058
1059
1060                                                 Element
1061
1062
1063
1064
1065
1066                 </div>
1067                 <div class="mdesc">
1068
1069                    <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>
1070
1071
1072
1073                     <div class="long">
1074
1075                                 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..
1076
1077
1078
1079
1080
1081
1082                                 <dl class="detailList">
1083                                 <dt class="heading">Parameters:</dt>
1084
1085                                         <dt>
1086                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
1087
1088                                         </dt>
1089                                         <dd>- id or name to find.</dd>
1090
1091                                 </dl>
1092
1093
1094
1095
1096
1097                                 <dl class="detailList">
1098                                 <dt class="heading">Returns:</dt>
1099
1100                                         <dd><span class="fixedFont">Element</span>  e - or false if nothing found.</dd>
1101
1102                                 </dl>
1103
1104
1105
1106
1107
1108
1109
1110                     </div>
1111                 </div>
1112
1113             </td>
1114             <td class="msource">
1115
1116                         Roo.form.Form
1117                 &nbsp;
1118             </td>
1119         </tr>
1120
1121
1122           <tr class="method-row config-row-alt1 expandable notInherited">
1123             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1124
1125
1126             <td class="sig">
1127                 <a id="Roo.form.Form-method-render"   name=".render"></a>
1128                 <div class="fixedFont">
1129                         <span class="attributes"></span><b class="itemname">render</b>
1130
1131                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
1132
1133
1134                                          :
1135
1136
1137                                                 Form
1138
1139
1140
1141
1142
1143                 </div>
1144                 <div class="mdesc">
1145
1146                    <div class="short">Render this form into the passed container.</div>
1147
1148
1149
1150                     <div class="long">
1151
1152                                 Render this form into the passed container. This should only be called once!
1153
1154
1155
1156
1157
1158
1159                                 <dl class="detailList">
1160                                 <dt class="heading">Parameters:</dt>
1161
1162                                         <dt>
1163                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>container</b>
1164
1165                                         </dt>
1166                                         <dd>The element this component should be rendered into</dd>
1167
1168                                 </dl>
1169
1170
1171
1172
1173
1174                                 <dl class="detailList">
1175                                 <dt class="heading">Returns:</dt>
1176
1177                                         <dd><span class="fixedFont">Form</span>  this</dd>
1178
1179                                 </dl>
1180
1181
1182
1183
1184
1185
1186
1187                     </div>
1188                 </div>
1189
1190             </td>
1191             <td class="msource">
1192
1193                         Roo.form.Form
1194                 &nbsp;
1195             </td>
1196         </tr>
1197
1198
1199           <tr class="method-row config-row-alt0 expandable notInherited">
1200             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1201
1202
1203             <td class="sig">
1204                 <a id="Roo.form.Form-method-start"   name=".start"></a>
1205                 <div class="fixedFont">
1206                         <span class="attributes"></span><b class="itemname">start</b>
1207
1208                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>container</i></B>)
1209
1210
1211                                          :
1212
1213
1214                                                 Form
1215
1216
1217
1218
1219
1220                 </div>
1221                 <div class="mdesc">
1222
1223                    <div class="short">Opens the passed container in the layout stack.</div>
1224
1225
1226
1227                     <div class="long">
1228
1229                                 Opens the passed container in the layout stack. The container can be any {<b>link</b> Roo.form.Layout} or subclass.
1230
1231
1232
1233
1234
1235
1236                                 <dl class="detailList">
1237                                 <dt class="heading">Parameters:</dt>
1238
1239                                         <dt>
1240                                                 <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>
1241
1242                                         </dt>
1243                                         <dd>A Roo.form.Layout or subclass of Layout</dd>
1244
1245                                 </dl>
1246
1247
1248
1249
1250
1251                                 <dl class="detailList">
1252                                 <dt class="heading">Returns:</dt>
1253
1254                                         <dd><span class="fixedFont">Form</span>  this</dd>
1255
1256                                 </dl>
1257
1258
1259
1260
1261
1262
1263
1264                     </div>
1265                 </div>
1266
1267             </td>
1268             <td class="msource">
1269
1270                         Roo.form.Form
1271                 &nbsp;
1272             </td>
1273         </tr>
1274
1275
1276           <tr class="method-row config-row-alt1 expandable notInherited">
1277             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1278
1279
1280             <td class="sig">
1281                 <a id="Roo.form.Form-method-startMonitoring"   name=".startMonitoring"></a>
1282                 <div class="fixedFont">
1283                         <span class="attributes"></span><b class="itemname">startMonitoring</b>
1284
1285                                  ()
1286
1287
1288
1289                 </div>
1290                 <div class="mdesc">
1291
1292                    <div class="short">Starts monitoring of the valid state of this form.</div>
1293
1294
1295
1296                     <div class="long">
1297
1298                                 Starts monitoring of the valid state of this form. Usually this is done by passing the config<br/>option "monitorValid"
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315                     </div>
1316                 </div>
1317
1318             </td>
1319             <td class="msource">
1320
1321                         Roo.form.Form
1322                 &nbsp;
1323             </td>
1324         </tr>
1325
1326
1327           <tr class="method-row config-row-alt0 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-stopMonitoring"   name=".stopMonitoring"></a>
1333                 <div class="fixedFont">
1334                         <span class="attributes"></span><b class="itemname">stopMonitoring</b>
1335
1336                                  ()
1337
1338
1339
1340                 </div>
1341                 <div class="mdesc">
1342
1343                    <div class="short">Stops monitoring of the valid state of this form</div>
1344
1345
1346
1347                     <div class="long">
1348
1349                                 Stops monitoring of the valid state of this form
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366                     </div>
1367                 </div>
1368
1369             </td>
1370             <td class="msource">
1371
1372                         Roo.form.Form
1373                 &nbsp;
1374             </td>
1375         </tr>
1376
1377
1378     </table>
1379
1380
1381   <!-- ============================== events summary / details ======================== -->
1382
1383
1384   <a id="Roo.form.Form-events"></a>
1385
1386
1387
1388
1389
1390
1391
1392
1393       <table cellspacing="0" class="member-table">
1394                 <caption>Events</caption>
1395               <thead>
1396                 <tr>
1397                     <th class="sig-header" colspan="2">Event</th>
1398                     <th class="msource-header">Defined By</th>
1399
1400                 </tr>
1401               </thead>
1402
1403
1404
1405
1406
1407           <tr class="method-row expandable config-row-alt0 notInherited">
1408             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1409
1410             <td class="sig">
1411                 <a id="Roo.form.Form-event-*clientvalidation"></a>
1412
1413                <div class="fixedFont">
1414                 <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>)
1415
1416                 </div>
1417
1418                 <div class="mdesc">
1419
1420                    <div class="short">If the monitorValid config option is true, this event fires repetitively to notify of valid state
1421
1422                 </div>
1423
1424                     <div class="long">
1425
1426                         If the monitorValid config option is true, this event fires repetitively to notify of valid state
1427
1428
1429
1430
1431
1432                                 <dl class="detailList">
1433                                 <dt class="heading">Parameters:</dt>
1434
1435                                         <dt>
1436                                                 <span class="fixedFont">Form</span> <b>this</b>
1437
1438                                         </dt>
1439                                         <dd></dd>
1440
1441                                         <dt>
1442                                                 <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>
1443
1444                                         </dt>
1445                                         <dd>true if the form has passed client-side validation</dd>
1446
1447                                 </dl>
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459                     </div>
1460                 </div>
1461
1462             </td>
1463             <td class="msource">
1464                 Roo.form.Form
1465             </td>
1466         </tr>
1467
1468           <tr class="method-row expandable config-row-alt1 notInherited">
1469             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1470
1471             <td class="sig">
1472                 <a id="Roo.form.Form-event-*rendered"></a>
1473
1474                <div class="fixedFont">
1475                 <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>)
1476
1477                 </div>
1478
1479                 <div class="mdesc">
1480
1481                    <div class="short">Fires when the form is rendered
1482
1483                 </div>
1484
1485                     <div class="long">
1486
1487                         Fires when the form is rendered
1488
1489
1490
1491
1492
1493                                 <dl class="detailList">
1494                                 <dt class="heading">Parameters:</dt>
1495
1496                                         <dt>
1497                                                 <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>
1498
1499                                         </dt>
1500                                         <dd></dd>
1501
1502                                 </dl>
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514                     </div>
1515                 </div>
1516
1517             </td>
1518             <td class="msource">
1519                 Roo.form.Form
1520             </td>
1521         </tr>
1522
1523
1524     </table>
1525
1526
1527
1528
1529
1530 <!-- ============================== footer ================================= -->
1531                 <div class="fineprint" style="clear:both">
1532
1533                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:11:55 GMT+0800 (HKT)
1534                         Based on
1535                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1536                 </div>
1537         </body>
1538 </html>