git.roojs.org Git - roojs1/blob - docs/symbols/Roo.bootstrap.Form.json

   1 {
   2   "name" : "Roo.bootstrap.Form",
   3   "augments" : [
   4     "Roo.bootstrap.Component",
   5     "Roo.Component",
   6     "Roo.util.Observable"
   7   ],
   8   "desc" : "Bootstrap Form class",
   9   "isSingleton" : false,
  10   "isStatic" : false,
  11   "isBuiltin" : false,
  12   "memberOf" : "Form",
  13   "example" : "",
  14   "deprecated" : "",
  15   "since" : "",
  16   "see" : "",
  17   "params" : [
  18     {
  19       "name" : "config",
  20       "type" : "Object",
  21       "desc" : "The config object",
  22       "isOptional" : false
  23     }
  24   ],
  25   "returns" : [
  26   ],
  27   "config" : [
  28     {
  29       "name" : "labelAlign",
  30       "type" : "String",
  31       "desc" : "top | left (default top)",
  32       "memberOf" : "Roo.bootstrap.Form",
  33       "values" : [
  34       ]
  35     },
  36     {
  37       "name" : "listeners",
  38       "type" : "Object",
  39       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
  40       "memberOf" : "Roo.util.Observable",
  41       "values" : [
  42       ]
  43     },
  44     {
  45       "name" : "fileUpload",
  46       "type" : "Boolean",
  47       "desc" : "Set to true if this form is a file upload.",
  48       "memberOf" : "Roo.bootstrap.Form",
  49       "values" : [
  50       ]
  51     },
  52     {
  53       "name" : "tooltip",
  54       "type" : "string",
  55       "desc" : "Text for the tooltip",
  56       "memberOf" : "Roo.bootstrap.Component",
  57       "values" : [
  58       ]
  59     },
  60     {
  61       "name" : "container_method",
  62       "type" : "string",
  63       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
  64       "memberOf" : "Roo.bootstrap.Component",
  65       "values" : [
  66       ]
  67     },
  68     {
  69       "name" : "visibilityEl",
  70       "type" : "string|object",
  71       "desc" : "What element to use for visibility (@see getVisibilityEl())",
  72       "memberOf" : "Roo.bootstrap.Component",
  73       "values" : [
  74         "(el",
  75         "parent)"
  76       ]
  77     },
  78     {
  79       "name" : "align",
  80       "type" : "String",
  81       "desc" : "left  | right - for navbars",
  82       "memberOf" : "Roo.bootstrap.Form",
  83       "values" : [
  84       ]
  85     },
  86     {
  87       "name" : "can_build_overlaid",
  88       "type" : "Boolean",
  89       "desc" : "True if element can be rebuild from a HTML page",
  90       "memberOf" : "Roo.bootstrap.Component",
  91       "values" : [
  92       ]
  93     },
  94     {
  95       "name" : "hideMode",
  96       "type" : "String",
  97       "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
  98       "memberOf" : "Roo.Component",
  99       "values" : [
 100         "(display",
 101         "visibility)"
 102       ]
 103     },
 104     {
 105       "name" : "method",
 106       "type" : "String",
 107       "desc" : "GET | POST (default POST)",
 108       "memberOf" : "Roo.bootstrap.Form",
 109       "values" : [
 110       ]
 111     },
 112     {
 113       "name" : "errorMask",
 114       "type" : "Boolean",
 115       "desc" : "default false",
 116       "memberOf" : "Roo.bootstrap.Form",
 117       "values" : [
 118         "(true",
 119         "false)"
 120       ]
 121     },
 122     {
 123       "name" : "style",
 124       "type" : "String",
 125       "desc" : "any extra css",
 126       "memberOf" : "Roo.bootstrap.Component",
 127       "values" : [
 128       ]
 129     },
 130     {
 131       "name" : "allowDomMove",
 132       "type" : "Boolean",
 133       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 134       "memberOf" : "Roo.Component",
 135       "values" : [
 136       ]
 137     },
 138     {
 139       "name" : "timeout",
 140       "type" : "Number",
 141       "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
 142       "memberOf" : "Roo.bootstrap.Form",
 143       "values" : [
 144       ]
 145     },
 146     {
 147       "name" : "cls",
 148       "type" : "String",
 149       "desc" : "css class",
 150       "memberOf" : "Roo.bootstrap.Component",
 151       "values" : [
 152       ]
 153     },
 154     {
 155       "name" : "loadMask",
 156       "type" : "Boolean",
 157       "desc" : "load mask when submit (default true)",
 158       "memberOf" : "Roo.bootstrap.Form",
 159       "values" : [
 160       ]
 161     },
 162     {
 163       "name" : "baseParams",
 164       "type" : "Object",
 165       "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
 166       "memberOf" : "Roo.bootstrap.Form",
 167       "values" : [
 168       ]
 169     },
 170     {
 171       "name" : "xattr",
 172       "type" : "Object",
 173       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
 174       "memberOf" : "Roo.bootstrap.Component",
 175       "values" : [
 176       ]
 177     },
 178     {
 179       "name" : "actionMode",
 180       "type" : "String",
 181       "desc" : "which property holds the element that used for  hide() / show() / disable() / enable()\ndefault is 'el'",
 182       "memberOf" : "Roo.Component",
 183       "values" : [
 184       ]
 185     },
 186     {
 187       "name" : "maskBody",
 188       "type" : "Boolean",
 189       "desc" : "",
 190       "memberOf" : "Roo.bootstrap.Form",
 191       "values" : [
 192       ]
 193     },
 194     {
 195       "name" : "dataId",
 196       "type" : "string",
 197       "desc" : "cutomer id",
 198       "memberOf" : "Roo.bootstrap.Component",
 199       "values" : [
 200       ]
 201     },
 202     {
 203       "name" : "url",
 204       "type" : "String",
 205       "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
 206       "memberOf" : "Roo.bootstrap.Form",
 207       "values" : [
 208       ]
 209     },
 210     {
 211       "name" : "name",
 212       "type" : "string",
 213       "desc" : "Specifies name attribute",
 214       "memberOf" : "Roo.bootstrap.Component",
 215       "values" : [
 216       ]
 217     },
 218     {
 219       "name" : "disableClass",
 220       "type" : "String",
 221       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 222       "memberOf" : "Roo.Component",
 223       "values" : [
 224       ]
 225     },
 226     {
 227       "name" : "maskOffset",
 228       "type" : "Number",
 229       "desc" : "Default 100",
 230       "memberOf" : "Roo.bootstrap.Form",
 231       "values" : [
 232       ]
 233     }
 234   ],
 235   "methods" : [
 236     {
 237       "name" : "doAction",
 238       "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
 239       "isStatic" : false,
 240       "isConstructor" : false,
 241       "isPrivate" : false,
 242       "memberOf" : "Roo.bootstrap.Form",
 243       "example" : "",
 244       "deprecated" : "",
 245       "since" : "",
 246       "see" : "",
 247       "params" : [
 248         {
 249           "name" : "actionName",
 250           "type" : "String",
 251           "desc" : "The name of the action type",
 252           "isOptional" : false
 253         },
 254         {
 255           "name" : "options",
 256           "type" : "Object",
 257           "desc" : "(optional) The options to pass to the action.  All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty          Type             Description\n----------------  ---------------  ----------------------------------------------------------------------------------\nurl               String           The url for the action (defaults to the form's url)\nmethod            String           The form method to use (defaults to the form's method, or POST if not defined)\nparams            String/Object    The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation  Boolean          Applies to submit only.  Pass true to call form.isValid() prior to posting to\n                                   validate the form on the client (defaults to false)\n</pre>",
 258           "isOptional" : false
 259         }
 260       ],
 261       "returns" : [
 262         {
 263           "name" : "",
 264           "type" : "BasicForm",
 265           "desc" : "this"
 266         }
 267       ]
 268     },
 269     {
 270       "name" : "setValues",
 271       "desc" : "Set values for fields in this form in bulk.",
 272       "isStatic" : false,
 273       "isConstructor" : false,
 274       "isPrivate" : false,
 275       "memberOf" : "Roo.bootstrap.Form",
 276       "example" : "",
 277       "deprecated" : "",
 278       "since" : "",
 279       "see" : "",
 280       "params" : [
 281         {
 282           "name" : "values",
 283           "type" : "Array/Object",
 284           "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
 285           "isOptional" : false
 286         }
 287       ],
 288       "returns" : [
 289         {
 290           "name" : "",
 291           "type" : "BasicForm",
 292           "desc" : "this"
 293         }
 294       ]
 295     },
 296     {
 297       "name" : "getFieldValues",
 298       "desc" : "Returns the fields in this form as an object with key/value pairs.\nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
 299       "isStatic" : false,
 300       "isConstructor" : false,
 301       "isPrivate" : false,
 302       "memberOf" : "Roo.bootstrap.Form",
 303       "example" : "",
 304       "deprecated" : "",
 305       "since" : "",
 306       "see" : "",
 307       "params" : [
 308       ],
 309       "returns" : [
 310         {
 311           "name" : "",
 312           "type" : "Object",
 313           "desc" : ""
 314         }
 315       ]
 316     },
 317     {
 318       "name" : "markInvalid",
 319       "desc" : "Mark fields in this form invalid in bulk.",
 320       "isStatic" : false,
 321       "isConstructor" : false,
 322       "isPrivate" : false,
 323       "memberOf" : "Roo.bootstrap.Form",
 324       "example" : "",
 325       "deprecated" : "",
 326       "since" : "",
 327       "see" : "",
 328       "params" : [
 329         {
 330           "name" : "errors",
 331           "type" : "Array/Object",
 332           "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
 333           "isOptional" : false
 334         }
 335       ],
 336       "returns" : [
 337         {
 338           "name" : "",
 339           "type" : "BasicForm",
 340           "desc" : "this"
 341         }
 342       ]
 343     },
 344     {
 345       "name" : "clearInvalid",
 346       "desc" : "Clears all invalid messages in this form.",
 347       "isStatic" : false,
 348       "isConstructor" : false,
 349       "isPrivate" : false,
 350       "memberOf" : "Roo.bootstrap.Form",
 351       "example" : "",
 352       "deprecated" : "",
 353       "since" : "",
 354       "see" : "",
 355       "params" : [
 356       ],
 357       "returns" : [
 358         {
 359           "name" : "",
 360           "type" : "BasicForm",
 361           "desc" : "this"
 362         }
 363       ]
 364     },
 365     {
 366       "name" : "findField",
 367       "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
 368       "isStatic" : false,
 369       "isConstructor" : false,
 370       "isPrivate" : false,
 371       "memberOf" : "Roo.bootstrap.Form",
 372       "example" : "",
 373       "deprecated" : "",
 374       "since" : "",
 375       "see" : "",
 376       "params" : [
 377         {
 378           "name" : "id",
 379           "type" : "String",
 380           "desc" : "The value to search for",
 381           "isOptional" : false
 382         }
 383       ],
 384       "returns" : [
 385         {
 386           "name" : "",
 387           "type" : "",
 388           "desc" : "Field"
 389         }
 390       ]
 391     },
 392     {
 393       "name" : "isDirty",
 394       "desc" : "Returns true if any fields in this form have changed since their original load.",
 395       "isStatic" : false,
 396       "isConstructor" : false,
 397       "isPrivate" : false,
 398       "memberOf" : "Roo.bootstrap.Form",
 399       "example" : "",
 400       "deprecated" : "",
 401       "since" : "",
 402       "see" : "",
 403       "params" : [
 404       ],
 405       "returns" : [
 406         {
 407           "name" : "",
 408           "type" : "",
 409           "desc" : "Boolean"
 410         }
 411       ]
 412     },
 413     {
 414       "name" : "reset",
 415       "desc" : "Resets this form.",
 416       "isStatic" : false,
 417       "isConstructor" : false,
 418       "isPrivate" : false,
 419       "memberOf" : "Roo.bootstrap.Form",
 420       "example" : "",
 421       "deprecated" : "",
 422       "since" : "",
 423       "see" : "",
 424       "params" : [
 425       ],
 426       "returns" : [
 427         {
 428           "name" : "",
 429           "type" : "BasicForm",
 430           "desc" : "this"
 431         }
 432       ]
 433     },
 434     {
 435       "name" : "getValues",
 436       "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
 437       "isStatic" : false,
 438       "isConstructor" : false,
 439       "isPrivate" : false,
 440       "memberOf" : "Roo.bootstrap.Form",
 441       "example" : "",
 442       "deprecated" : "",
 443       "since" : "",
 444       "see" : "",
 445       "params" : [
 446         {
 447           "name" : "asString",
 448           "type" : "Boolean",
 449           "desc" : "",
 450           "isOptional" : false
 451         }
 452       ],
 453       "returns" : [
 454         {
 455           "name" : "",
 456           "type" : "Object",
 457           "desc" : ""
 458         }
 459       ]
 460     },
 461     {
 462       "name" : "isValid",
 463       "desc" : "Returns true if client-side validation on the form is successful.",
 464       "isStatic" : false,
 465       "isConstructor" : false,
 466       "isPrivate" : false,
 467       "memberOf" : "Roo.bootstrap.Form",
 468       "example" : "",
 469       "deprecated" : "",
 470       "since" : "",
 471       "see" : "",
 472       "params" : [
 473       ],
 474       "returns" : [
 475         {
 476           "name" : "",
 477           "type" : "",
 478           "desc" : "Boolean"
 479         }
 480       ]
 481     },
 482     {
 483       "name" : "tooltipEl",
 484       "desc" : "Fetch the element to display the tooltip on.",
 485       "isStatic" : false,
 486       "isConstructor" : false,
 487       "isPrivate" : false,
 488       "memberOf" : "Roo.bootstrap.Component",
 489       "example" : "",
 490       "deprecated" : "",
 491       "since" : "",
 492       "see" : "",
 493       "params" : [
 494       ],
 495       "returns" : [
 496         {
 497           "name" : "",
 498           "type" : "Roo.Element",
 499           "desc" : "defaults to this.el"
 500         }
 501       ]
 502     },
 503     {
 504       "name" : "hide",
 505       "desc" : "Hide a component - adds 'hidden' class",
 506       "isStatic" : false,
 507       "isConstructor" : false,
 508       "isPrivate" : false,
 509       "memberOf" : "Roo.bootstrap.Component",
 510       "example" : "",
 511       "deprecated" : "",
 512       "since" : "",
 513       "see" : "",
 514       "params" : [
 515       ],
 516       "returns" : [
 517       ]
 518     },
 519     {
 520       "name" : "show",
 521       "desc" : "Show a component - removes 'hidden' class",
 522       "isStatic" : false,
 523       "isConstructor" : false,
 524       "isPrivate" : false,
 525       "memberOf" : "Roo.bootstrap.Component",
 526       "example" : "",
 527       "deprecated" : "",
 528       "since" : "",
 529       "see" : "",
 530       "params" : [
 531       ],
 532       "returns" : [
 533       ]
 534     },
 535     {
 536       "name" : "setVisibilityEl",
 537       "desc" : "Set the element that will be used to show or hide",
 538       "isStatic" : false,
 539       "isConstructor" : false,
 540       "isPrivate" : false,
 541       "memberOf" : "Roo.bootstrap.Component",
 542       "example" : "",
 543       "deprecated" : "",
 544       "since" : "",
 545       "see" : "",
 546       "params" : [
 547       ],
 548       "returns" : [
 549       ]
 550     },
 551     {
 552       "name" : "getVisibilityEl",
 553       "desc" : "Get the element that will be used to show or hide",
 554       "isStatic" : false,
 555       "isConstructor" : false,
 556       "isPrivate" : false,
 557       "memberOf" : "Roo.bootstrap.Component",
 558       "example" : "",
 559       "deprecated" : "",
 560       "since" : "",
 561       "see" : "",
 562       "params" : [
 563       ],
 564       "returns" : [
 565       ]
 566     },
 567     {
 568       "name" : "initEvents",
 569       "desc" : "Initialize Events for the element",
 570       "isStatic" : false,
 571       "isConstructor" : false,
 572       "isPrivate" : false,
 573       "memberOf" : "Roo.bootstrap.Component",
 574       "example" : "",
 575       "deprecated" : "",
 576       "since" : "",
 577       "see" : "",
 578       "params" : [
 579       ],
 580       "returns" : [
 581       ]
 582     },
 583     {
 584       "name" : "getChildContainer",
 585       "desc" : "Fetch the element to add children to",
 586       "isStatic" : false,
 587       "isConstructor" : false,
 588       "isPrivate" : false,
 589       "memberOf" : "Roo.bootstrap.Component",
 590       "example" : "",
 591       "deprecated" : "",
 592       "since" : "",
 593       "see" : "",
 594       "params" : [
 595       ],
 596       "returns" : [
 597         {
 598           "name" : "",
 599           "type" : "Roo.Element",
 600           "desc" : "defaults to this.el"
 601         }
 602       ]
 603     },
 604     {
 605       "name" : "getId",
 606       "desc" : "Returns the id of this component.",
 607       "isStatic" : false,
 608       "isConstructor" : false,
 609       "isPrivate" : false,
 610       "memberOf" : "Roo.Component",
 611       "example" : "",
 612       "deprecated" : "",
 613       "since" : "",
 614       "see" : "",
 615       "params" : [
 616       ],
 617       "returns" : [
 618         {
 619           "name" : "",
 620           "type" : "String",
 621           "desc" : ""
 622         }
 623       ]
 624     },
 625     {
 626       "name" : "render",
 627       "desc" : "If this is a lazy rendering component, render it to its container element.",
 628       "isStatic" : false,
 629       "isConstructor" : false,
 630       "isPrivate" : false,
 631       "memberOf" : "Roo.Component",
 632       "example" : "",
 633       "deprecated" : "",
 634       "since" : "",
 635       "see" : "",
 636       "params" : [
 637         {
 638           "name" : "container",
 639           "type" : "String/HTMLElement/Element",
 640           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 641           "isOptional" : false
 642         }
 643       ],
 644       "returns" : [
 645       ]
 646     },
 647     {
 648       "name" : "destroy",
 649       "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
 650       "isStatic" : false,
 651       "isConstructor" : false,
 652       "isPrivate" : false,
 653       "memberOf" : "Roo.Component",
 654       "example" : "",
 655       "deprecated" : "",
 656       "since" : "",
 657       "see" : "",
 658       "params" : [
 659       ],
 660       "returns" : [
 661       ]
 662     },
 663     {
 664       "name" : "isVisible",
 665       "desc" : "Returns true if this component is visible.",
 666       "isStatic" : false,
 667       "isConstructor" : false,
 668       "isPrivate" : false,
 669       "memberOf" : "Roo.Component",
 670       "example" : "",
 671       "deprecated" : "",
 672       "since" : "",
 673       "see" : "",
 674       "params" : [
 675       ],
 676       "returns" : [
 677       ]
 678     },
 679     {
 680       "name" : "setDisabled",
 681       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 682       "isStatic" : false,
 683       "isConstructor" : false,
 684       "isPrivate" : false,
 685       "memberOf" : "Roo.Component",
 686       "example" : "",
 687       "deprecated" : "",
 688       "since" : "",
 689       "see" : "",
 690       "params" : [
 691         {
 692           "name" : "disabled",
 693           "type" : "Boolean",
 694           "desc" : "",
 695           "isOptional" : false
 696         }
 697       ],
 698       "returns" : [
 699       ]
 700     },
 701     {
 702       "name" : "focus",
 703       "desc" : "Try to focus this component.",
 704       "isStatic" : false,
 705       "isConstructor" : false,
 706       "isPrivate" : false,
 707       "memberOf" : "Roo.Component",
 708       "example" : "",
 709       "deprecated" : "",
 710       "since" : "",
 711       "see" : "",
 712       "params" : [
 713         {
 714           "name" : "selectText",
 715           "type" : "Boolean",
 716           "desc" : "True to also select the text in this component (if applicable)",
 717           "isOptional" : false
 718         }
 719       ],
 720       "returns" : [
 721         {
 722           "name" : "",
 723           "type" : "Roo.Component",
 724           "desc" : "this"
 725         }
 726       ]
 727     },
 728     {
 729       "name" : "enable",
 730       "desc" : "Enable this component.",
 731       "isStatic" : false,
 732       "isConstructor" : false,
 733       "isPrivate" : false,
 734       "memberOf" : "Roo.Component",
 735       "example" : "",
 736       "deprecated" : "",
 737       "since" : "",
 738       "see" : "",
 739       "params" : [
 740       ],
 741       "returns" : [
 742         {
 743           "name" : "",
 744           "type" : "Roo.Component",
 745           "desc" : "this"
 746         }
 747       ]
 748     },
 749     {
 750       "name" : "setVisible",
 751       "desc" : "Convenience function to hide or show this component by boolean.",
 752       "isStatic" : false,
 753       "isConstructor" : false,
 754       "isPrivate" : false,
 755       "memberOf" : "Roo.Component",
 756       "example" : "",
 757       "deprecated" : "",
 758       "since" : "",
 759       "see" : "",
 760       "params" : [
 761         {
 762           "name" : "visible",
 763           "type" : "Boolean",
 764           "desc" : "True to show, false to hide",
 765           "isOptional" : false
 766         }
 767       ],
 768       "returns" : [
 769         {
 770           "name" : "",
 771           "type" : "Roo.Component",
 772           "desc" : "this"
 773         }
 774       ]
 775     },
 776     {
 777       "name" : "disable",
 778       "desc" : "Disable this component.",
 779       "isStatic" : false,
 780       "isConstructor" : false,
 781       "isPrivate" : false,
 782       "memberOf" : "Roo.Component",
 783       "example" : "",
 784       "deprecated" : "",
 785       "since" : "",
 786       "see" : "",
 787       "params" : [
 788       ],
 789       "returns" : [
 790         {
 791           "name" : "",
 792           "type" : "Roo.Component",
 793           "desc" : "this"
 794         }
 795       ]
 796     },
 797     {
 798       "name" : "getEl",
 799       "desc" : "Returns the underlying {@link Roo.Element}.",
 800       "isStatic" : false,
 801       "isConstructor" : false,
 802       "isPrivate" : false,
 803       "memberOf" : "Roo.Component",
 804       "example" : "",
 805       "deprecated" : "",
 806       "since" : "",
 807       "see" : "",
 808       "params" : [
 809       ],
 810       "returns" : [
 811         {
 812           "name" : "",
 813           "type" : "Roo.Element",
 814           "desc" : "The element"
 815         }
 816       ]
 817     },
 818     {
 819       "name" : "purgeListeners",
 820       "desc" : "Removes all listeners for this object",
 821       "isStatic" : false,
 822       "isConstructor" : false,
 823       "isPrivate" : false,
 824       "memberOf" : "Roo.util.Observable",
 825       "example" : "",
 826       "deprecated" : "",
 827       "since" : "",
 828       "see" : "",
 829       "params" : [
 830       ],
 831       "returns" : [
 832       ]
 833     },
 834     {
 835       "name" : "on",
 836       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 837       "isStatic" : false,
 838       "isConstructor" : false,
 839       "isPrivate" : false,
 840       "memberOf" : "Roo.util.Observable",
 841       "example" : "",
 842       "deprecated" : "",
 843       "since" : "",
 844       "see" : "",
 845       "params" : [
 846         {
 847           "name" : "eventName",
 848           "type" : "String",
 849           "desc" : "The type of event to listen for",
 850           "isOptional" : false
 851         },
 852         {
 853           "name" : "handler",
 854           "type" : "Function",
 855           "desc" : "The method the event invokes",
 856           "isOptional" : false
 857         },
 858         {
 859           "name" : "scope",
 860           "type" : "Object",
 861           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 862           "isOptional" : false
 863         },
 864         {
 865           "name" : "options",
 866           "type" : "Object",
 867           "desc" : "(optional)",
 868           "isOptional" : false
 869         }
 870       ],
 871       "returns" : [
 872       ]
 873     },
 874     {
 875       "name" : "un",
 876       "desc" : "Removes a listener (shorthand for removeListener)",
 877       "isStatic" : false,
 878       "isConstructor" : false,
 879       "isPrivate" : false,
 880       "memberOf" : "Roo.util.Observable",
 881       "example" : "",
 882       "deprecated" : "",
 883       "since" : "",
 884       "see" : "",
 885       "params" : [
 886         {
 887           "name" : "eventName",
 888           "type" : "String",
 889           "desc" : "The type of event to listen for",
 890           "isOptional" : false
 891         },
 892         {
 893           "name" : "handler",
 894           "type" : "Function",
 895           "desc" : "The handler to remove",
 896           "isOptional" : false
 897         },
 898         {
 899           "name" : "scope",
 900           "type" : "Object",
 901           "desc" : "(optional) The scope (this object) for the handler",
 902           "isOptional" : false
 903         }
 904       ],
 905       "returns" : [
 906       ]
 907     },
 908     {
 909       "name" : "addEvents",
 910       "desc" : "Used to define events on this Observable",
 911       "isStatic" : false,
 912       "isConstructor" : false,
 913       "isPrivate" : false,
 914       "memberOf" : "Roo.util.Observable",
 915       "example" : "",
 916       "deprecated" : "",
 917       "since" : "",
 918       "see" : "",
 919       "params" : [
 920         {
 921           "name" : "object",
 922           "type" : "Object",
 923           "desc" : "The object with the events defined",
 924           "isOptional" : false
 925         }
 926       ],
 927       "returns" : [
 928       ]
 929     },
 930     {
 931       "name" : "releaseCapture",
 932       "desc" : "Removes <b>all</b> added captures from the Observable.",
 933       "isStatic" : true,
 934       "isConstructor" : false,
 935       "isPrivate" : false,
 936       "memberOf" : "Roo.util.Observable",
 937       "example" : "",
 938       "deprecated" : "",
 939       "since" : "",
 940       "see" : "",
 941       "params" : [
 942         {
 943           "name" : "o",
 944           "type" : "Observable",
 945           "desc" : "The Observable to release",
 946           "isOptional" : false
 947         }
 948       ],
 949       "returns" : [
 950       ]
 951     },
 952     {
 953       "name" : "removeListener",
 954       "desc" : "Removes a listener",
 955       "isStatic" : false,
 956       "isConstructor" : false,
 957       "isPrivate" : false,
 958       "memberOf" : "Roo.util.Observable",
 959       "example" : "",
 960       "deprecated" : "",
 961       "since" : "",
 962       "see" : "",
 963       "params" : [
 964         {
 965           "name" : "eventName",
 966           "type" : "String",
 967           "desc" : "The type of event to listen for",
 968           "isOptional" : false
 969         },
 970         {
 971           "name" : "handler",
 972           "type" : "Function",
 973           "desc" : "The handler to remove",
 974           "isOptional" : false
 975         },
 976         {
 977           "name" : "scope",
 978           "type" : "Object",
 979           "desc" : "(optional) The scope (this object) for the handler",
 980           "isOptional" : false
 981         }
 982       ],
 983       "returns" : [
 984       ]
 985     },
 986     {
 987       "name" : "fireEvent",
 988       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 989       "isStatic" : false,
 990       "isConstructor" : false,
 991       "isPrivate" : false,
 992       "memberOf" : "Roo.util.Observable",
 993       "example" : "",
 994       "deprecated" : "",
 995       "since" : "",
 996       "see" : "",
 997       "params" : [
 998         {
 999           "name" : "eventName",
1000           "type" : "String",
1001           "desc" : "",
1002           "isOptional" : false
1003         },
1004         {
1005           "name" : "args",
1006           "type" : "Object...",
1007           "desc" : "Variable number of parameters are passed to handlers",
1008           "isOptional" : false
1009         }
1010       ],
1011       "returns" : [
1012         {
1013           "name" : "",
1014           "type" : "Boolean",
1015           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1016         }
1017       ]
1018     },
1019     {
1020       "name" : "hasListener",
1021       "desc" : "Checks to see if this object has any listeners for a specified event",
1022       "isStatic" : false,
1023       "isConstructor" : false,
1024       "isPrivate" : false,
1025       "memberOf" : "Roo.util.Observable",
1026       "example" : "",
1027       "deprecated" : "",
1028       "since" : "",
1029       "see" : "",
1030       "params" : [
1031         {
1032           "name" : "eventName",
1033           "type" : "String",
1034           "desc" : "The name of the event to check for",
1035           "isOptional" : false
1036         }
1037       ],
1038       "returns" : [
1039         {
1040           "name" : "",
1041           "type" : "Boolean",
1042           "desc" : "True if the event is being listened for, else false"
1043         }
1044       ]
1045     },
1046     {
1047       "name" : "capture",
1048       "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
1049       "isStatic" : true,
1050       "isConstructor" : false,
1051       "isPrivate" : false,
1052       "memberOf" : "Roo.util.Observable",
1053       "example" : "",
1054       "deprecated" : "",
1055       "since" : "",
1056       "see" : "",
1057       "params" : [
1058         {
1059           "name" : "o",
1060           "type" : "Observable",
1061           "desc" : "The Observable to capture",
1062           "isOptional" : false
1063         },
1064         {
1065           "name" : "fn",
1066           "type" : "Function",
1067           "desc" : "The function to call",
1068           "isOptional" : false
1069         },
1070         {
1071           "name" : "scope",
1072           "type" : "Object",
1073           "desc" : "(optional) The scope (this object) for the fn",
1074           "isOptional" : false
1075         }
1076       ],
1077       "returns" : [
1078       ]
1079     },
1080     {
1081       "name" : "addListener",
1082       "desc" : "Appends an event handler to this component",
1083       "isStatic" : false,
1084       "isConstructor" : false,
1085       "isPrivate" : false,
1086       "memberOf" : "Roo.util.Observable",
1087       "example" : "",
1088       "deprecated" : "",
1089       "since" : "",
1090       "see" : "",
1091       "params" : [
1092         {
1093           "name" : "eventName",
1094           "type" : "String",
1095           "desc" : "The type of event to listen for",
1096           "isOptional" : false
1097         },
1098         {
1099           "name" : "handler",
1100           "type" : "Function",
1101           "desc" : "The method the event invokes",
1102           "isOptional" : false
1103         },
1104         {
1105           "name" : "scope",
1106           "type" : "Object",
1107           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1108           "isOptional" : false
1109         },
1110         {
1111           "name" : "options",
1112           "type" : "Object",
1113           "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n     \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t</code></pre>",
1114           "isOptional" : false
1115         }
1116       ],
1117       "returns" : [
1118       ]
1119     }
1120   ],
1121   "events" : [
1122     {
1123       "name" : "actionfailed",
1124       "desc" : "Fires when an action fails.",
1125       "memberOf" : "Roo.bootstrap.Form",
1126       "example" : "",
1127       "deprecated" : "",
1128       "since" : "",
1129       "see" : "",
1130       "params" : [
1131         {
1132           "name" : "this",
1133           "type" : "Form",
1134           "desc" : "",
1135           "isOptional" : false
1136         },
1137         {
1138           "name" : "action",
1139           "type" : "Action",
1140           "desc" : "The action that failed",
1141           "isOptional" : false
1142         }
1143       ],
1144       "returns" : [
1145       ]
1146     },
1147     {
1148       "name" : "actioncomplete",
1149       "desc" : "Fires when an action is completed.",
1150       "memberOf" : "Roo.bootstrap.Form",
1151       "example" : "",
1152       "deprecated" : "",
1153       "since" : "",
1154       "see" : "",
1155       "params" : [
1156         {
1157           "name" : "this",
1158           "type" : "Form",
1159           "desc" : "",
1160           "isOptional" : false
1161         },
1162         {
1163           "name" : "action",
1164           "type" : "Action",
1165           "desc" : "The action that completed",
1166           "isOptional" : false
1167         }
1168       ],
1169       "returns" : [
1170       ]
1171     },
1172     {
1173       "name" : "beforeaction",
1174       "desc" : "Fires before any action is performed. Return false to cancel the action.",
1175       "memberOf" : "Roo.bootstrap.Form",
1176       "example" : "",
1177       "deprecated" : "",
1178       "since" : "",
1179       "see" : "",
1180       "params" : [
1181         {
1182           "name" : "this",
1183           "type" : "Form",
1184           "desc" : "",
1185           "isOptional" : false
1186         },
1187         {
1188           "name" : "action",
1189           "type" : "Action",
1190           "desc" : "The action to be performed",
1191           "isOptional" : false
1192         }
1193       ],
1194       "returns" : [
1195       ]
1196     },
1197     {
1198       "name" : "clientvalidation",
1199       "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
1200       "memberOf" : "Roo.bootstrap.Form",
1201       "example" : "",
1202       "deprecated" : "",
1203       "since" : "",
1204       "see" : "",
1205       "params" : [
1206         {
1207           "name" : "this",
1208           "type" : "Form",
1209           "desc" : "",
1210           "isOptional" : false
1211         },
1212         {
1213           "name" : "valid",
1214           "type" : "Boolean",
1215           "desc" : "true if the form has passed client-side validation",
1216           "isOptional" : false
1217         }
1218       ],
1219       "returns" : [
1220       ]
1221     },
1222     {
1223       "name" : "childrenrendered",
1224       "desc" : "Fires when the children have been rendered..",
1225       "memberOf" : "Roo.bootstrap.Component",
1226       "example" : "",
1227       "deprecated" : "",
1228       "since" : "",
1229       "see" : "",
1230       "params" : [
1231         {
1232           "name" : "this",
1233           "type" : "Roo.bootstrap.Component",
1234           "desc" : "",
1235           "isOptional" : false
1236         }
1237       ],
1238       "returns" : [
1239       ]
1240     },
1241     {
1242       "name" : "beforerender",
1243       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1244       "memberOf" : "Roo.Component",
1245       "example" : "",
1246       "deprecated" : "",
1247       "since" : "",
1248       "see" : "",
1249       "params" : [
1250         {
1251           "name" : "this",
1252           "type" : "Roo.Component",
1253           "desc" : "",
1254           "isOptional" : false
1255         }
1256       ],
1257       "returns" : [
1258       ]
1259     },
1260     {
1261       "name" : "disable",
1262       "desc" : "Fires after the component is disabled.",
1263       "memberOf" : "Roo.Component",
1264       "example" : "",
1265       "deprecated" : "",
1266       "since" : "",
1267       "see" : "",
1268       "params" : [
1269         {
1270           "name" : "this",
1271           "type" : "Roo.Component",
1272           "desc" : "",
1273           "isOptional" : false
1274         }
1275       ],
1276       "returns" : [
1277       ]
1278     },
1279     {
1280       "name" : "render",
1281       "desc" : "Fires after the component is rendered.",
1282       "memberOf" : "Roo.Component",
1283       "example" : "",
1284       "deprecated" : "",
1285       "since" : "",
1286       "see" : "",
1287       "params" : [
1288         {
1289           "name" : "this",
1290           "type" : "Roo.Component",
1291           "desc" : "",
1292           "isOptional" : false
1293         }
1294       ],
1295       "returns" : [
1296       ]
1297     },
1298     {
1299       "name" : "destroy",
1300       "desc" : "Fires after the component is destroyed.",
1301       "memberOf" : "Roo.Component",
1302       "example" : "",
1303       "deprecated" : "",
1304       "since" : "",
1305       "see" : "",
1306       "params" : [
1307         {
1308           "name" : "this",
1309           "type" : "Roo.Component",
1310           "desc" : "",
1311           "isOptional" : false
1312         }
1313       ],
1314       "returns" : [
1315       ]
1316     },
1317     {
1318       "name" : "hide",
1319       "desc" : "Fires after the component is hidden.",
1320       "memberOf" : "Roo.Component",
1321       "example" : "",
1322       "deprecated" : "",
1323       "since" : "",
1324       "see" : "",
1325       "params" : [
1326         {
1327           "name" : "this",
1328           "type" : "Roo.Component",
1329           "desc" : "",
1330           "isOptional" : false
1331         }
1332       ],
1333       "returns" : [
1334       ]
1335     },
1336     {
1337       "name" : "beforehide",
1338       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1339       "memberOf" : "Roo.Component",
1340       "example" : "",
1341       "deprecated" : "",
1342       "since" : "",
1343       "see" : "",
1344       "params" : [
1345         {
1346           "name" : "this",
1347           "type" : "Roo.Component",
1348           "desc" : "",
1349           "isOptional" : false
1350         }
1351       ],
1352       "returns" : [
1353       ]
1354     },
1355     {
1356       "name" : "show",
1357       "desc" : "Fires after the component is shown.",
1358       "memberOf" : "Roo.Component",
1359       "example" : "",
1360       "deprecated" : "",
1361       "since" : "",
1362       "see" : "",
1363       "params" : [
1364         {
1365           "name" : "this",
1366           "type" : "Roo.Component",
1367           "desc" : "",
1368           "isOptional" : false
1369         }
1370       ],
1371       "returns" : [
1372       ]
1373     },
1374     {
1375       "name" : "beforeshow",
1376       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1377       "memberOf" : "Roo.Component",
1378       "example" : "",
1379       "deprecated" : "",
1380       "since" : "",
1381       "see" : "",
1382       "params" : [
1383         {
1384           "name" : "this",
1385           "type" : "Roo.Component",
1386           "desc" : "",
1387           "isOptional" : false
1388         }
1389       ],
1390       "returns" : [
1391       ]
1392     },
1393     {
1394       "name" : "enable",
1395       "desc" : "Fires after the component is enabled.",
1396       "memberOf" : "Roo.Component",
1397       "example" : "",
1398       "deprecated" : "",
1399       "since" : "",
1400       "see" : "",
1401       "params" : [
1402         {
1403           "name" : "this",
1404           "type" : "Roo.Component",
1405           "desc" : "",
1406           "isOptional" : false
1407         }
1408       ],
1409       "returns" : [
1410       ]
1411     },
1412     {
1413       "name" : "beforedestroy",
1414       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1415       "memberOf" : "Roo.Component",
1416       "example" : "",
1417       "deprecated" : "",
1418       "since" : "",
1419       "see" : "",
1420       "params" : [
1421         {
1422           "name" : "this",
1423           "type" : "Roo.Component",
1424           "desc" : "",
1425           "isOptional" : false
1426         }
1427       ],
1428       "returns" : [
1429       ]
1430     }
1431   ]
1432 }