git.roojs.org Git - roojs1/blob - docs/symbols/Roo.form.BasicForm.json

   1 {
   2   "name" : "Roo.form.BasicForm",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "childClasses" : {
   7     "Roo.form.BasicForm" : [
   8       "Roo.form.Form"
   9     ]
  10   },
  11   "tree_children" : [],
  12   "tree_parent" : [],
  13   "desc" : "Supplies the functionality to do \"actions\" on forms and initialize Roo.form.Field types on existing markup.",
  14   "isSingleton" : false,
  15   "isStatic" : false,
  16   "isBuiltin" : false,
  17   "isAbstract" : false,
  18   "isBuilderTop" : false,
  19   "memberOf" : "BasicForm",
  20   "example" : "",
  21   "deprecated" : "",
  22   "since" : "",
  23   "see" : "",
  24   "params" : [
  25     {
  26       "name" : "el",
  27       "type" : "String/HTMLElement/Roo.Element",
  28       "desc" : "The form element or its id",
  29       "isOptional" : false
  30     },
  31     {
  32       "name" : "config",
  33       "type" : "Object",
  34       "desc" : "Configuration options",
  35       "isOptional" : false
  36     }
  37   ],
  38   "returns" : [],
  39   "throws" : "",
  40   "requires" : "",
  41   "config" : [
  42     {
  43       "name" : "listeners",
  44       "type" : "Object",
  45       "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>",
  46       "memberOf" : "Roo.util.Observable",
  47       "isOptional" : false,
  48       "optvals" : []
  49     },
  50     {
  51       "name" : "fileUpload",
  52       "type" : "Boolean",
  53       "desc" : "Set to true if this form is a file upload.",
  54       "memberOf" : "",
  55       "isOptional" : false,
  56       "optvals" : []
  57     },
  58     {
  59       "name" : "method",
  60       "type" : "String",
  61       "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
  62       "memberOf" : "",
  63       "isOptional" : false,
  64       "optvals" : []
  65     },
  66     {
  67       "name" : "errorMask",
  68       "type" : "Boolean",
  69       "desc" : "Should the form be masked (and the active element highlighted on error - default false",
  70       "memberOf" : "",
  71       "isOptional" : false,
  72       "optvals" : []
  73     },
  74     {
  75       "name" : "timeout",
  76       "type" : "Number",
  77       "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
  78       "memberOf" : "",
  79       "isOptional" : false,
  80       "optvals" : []
  81     },
  82     {
  83       "name" : "baseParams",
  84       "type" : "Object",
  85       "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
  86       "memberOf" : "",
  87       "isOptional" : false,
  88       "optvals" : []
  89     },
  90     {
  91       "name" : "trackResetOnLoad",
  92       "type" : "Boolean",
  93       "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
  94       "memberOf" : "",
  95       "isOptional" : false,
  96       "optvals" : []
  97     },
  98     {
  99       "name" : "reader",
 100       "type" : "DataReader",
 101       "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
 102       "memberOf" : "",
 103       "isOptional" : false,
 104       "optvals" : []
 105     },
 106     {
 107       "name" : "errorReader",
 108       "type" : "DataReader",
 109       "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
 110       "memberOf" : "",
 111       "isOptional" : false,
 112       "optvals" : []
 113     },
 114     {
 115       "name" : "url",
 116       "type" : "String",
 117       "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
 118       "memberOf" : "",
 119       "isOptional" : false,
 120       "optvals" : []
 121     },
 122     {
 123       "name" : "maskOffset",
 124       "type" : "Number",
 125       "desc" : "space around form element to mask if there is an error Default 100",
 126       "memberOf" : "",
 127       "isOptional" : false,
 128       "optvals" : []
 129     }
 130   ],
 131   "methods" : [
 132     {
 133       "name" : "remove",
 134       "type" : "function",
 135       "desc" : "Removes a field from the items collection (does NOT remove its markup).",
 136       "sig" : "(field)",
 137       "static" : false,
 138       "memberOf" : "",
 139       "isStatic" : false,
 140       "isConstructor" : false,
 141       "isPrivate" : false,
 142       "example" : "",
 143       "deprecated" : "",
 144       "since" : "",
 145       "see" : "",
 146       "exceptions" : "",
 147       "requires" : "",
 148       "params" : [
 149         {
 150           "name" : "field",
 151           "type" : "Field",
 152           "desc" : "",
 153           "isOptional" : false
 154         }
 155       ],
 156       "returns" : [
 157         {
 158           "name" : "",
 159           "type" : "BasicForm",
 160           "desc" : "this"
 161         }
 162       ]
 163     },
 164     {
 165       "name" : "loadRecord",
 166       "type" : "function",
 167       "desc" : "Loads an Roo.data.Record into this form.",
 168       "sig" : "(record)",
 169       "static" : false,
 170       "memberOf" : "",
 171       "isStatic" : false,
 172       "isConstructor" : false,
 173       "isPrivate" : false,
 174       "example" : "",
 175       "deprecated" : "",
 176       "since" : "",
 177       "see" : "",
 178       "exceptions" : "",
 179       "requires" : "",
 180       "params" : [
 181         {
 182           "name" : "record",
 183           "type" : "Record",
 184           "desc" : "The record to load",
 185           "isOptional" : false
 186         }
 187       ],
 188       "returns" : [
 189         {
 190           "name" : "",
 191           "type" : "BasicForm",
 192           "desc" : "this"
 193         }
 194       ]
 195     },
 196     {
 197       "name" : "load",
 198       "type" : "function",
 199       "desc" : "Shortcut to do a load action.",
 200       "sig" : "(options)",
 201       "static" : false,
 202       "memberOf" : "",
 203       "isStatic" : false,
 204       "isConstructor" : false,
 205       "isPrivate" : false,
 206       "example" : "",
 207       "deprecated" : "",
 208       "since" : "",
 209       "see" : "",
 210       "exceptions" : "",
 211       "requires" : "",
 212       "params" : [
 213         {
 214           "name" : "options",
 215           "type" : "Object",
 216           "desc" : "The options to pass to the action (see {@link #doAction} for details)",
 217           "isOptional" : false
 218         }
 219       ],
 220       "returns" : [
 221         {
 222           "name" : "",
 223           "type" : "BasicForm",
 224           "desc" : "this"
 225         }
 226       ]
 227     },
 228     {
 229       "name" : "doAction",
 230       "type" : "function",
 231       "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
 232       "sig" : "(actionName, options)",
 233       "static" : false,
 234       "memberOf" : "",
 235       "isStatic" : false,
 236       "isConstructor" : false,
 237       "isPrivate" : false,
 238       "example" : "",
 239       "deprecated" : "",
 240       "since" : "",
 241       "see" : "",
 242       "exceptions" : "",
 243       "requires" : "",
 244       "params" : [
 245         {
 246           "name" : "actionName",
 247           "type" : "String",
 248           "desc" : "The name of the action type",
 249           "isOptional" : false
 250         },
 251         {
 252           "name" : "options",
 253           "type" : "Object",
 254           "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>",
 255           "isOptional" : false
 256         }
 257       ],
 258       "returns" : [
 259         {
 260           "name" : "",
 261           "type" : "BasicForm",
 262           "desc" : "this"
 263         }
 264       ]
 265     },
 266     {
 267       "name" : "getValues",
 268       "type" : "function",
 269       "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.",
 270       "sig" : "(asString)",
 271       "static" : false,
 272       "memberOf" : "",
 273       "isStatic" : false,
 274       "isConstructor" : false,
 275       "isPrivate" : false,
 276       "example" : "",
 277       "deprecated" : "",
 278       "since" : "",
 279       "see" : "",
 280       "exceptions" : "",
 281       "requires" : "",
 282       "params" : [
 283         {
 284           "name" : "asString",
 285           "type" : "Boolean",
 286           "desc" : "(def)",
 287           "isOptional" : false
 288         }
 289       ],
 290       "returns" : [
 291         {
 292           "name" : "",
 293           "type" : "Object",
 294           "desc" : ""
 295         }
 296       ]
 297     },
 298     {
 299       "name" : "resetHasChanged",
 300       "type" : "function",
 301       "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose",
 302       "sig" : "()\n{\n\n}",
 303       "static" : false,
 304       "memberOf" : "",
 305       "isStatic" : false,
 306       "isConstructor" : false,
 307       "isPrivate" : false,
 308       "example" : "",
 309       "deprecated" : "",
 310       "since" : "",
 311       "see" : "",
 312       "exceptions" : "",
 313       "requires" : "",
 314       "params" : [],
 315       "returns" : [
 316         {
 317           "name" : "",
 318           "type" : "",
 319           "desc" : "Boolean"
 320         }
 321       ]
 322     },
 323     {
 324       "name" : "clearInvalid",
 325       "type" : "function",
 326       "desc" : "Clears all invalid messages in this form.",
 327       "sig" : "()\n{\n\n}",
 328       "static" : false,
 329       "memberOf" : "",
 330       "isStatic" : false,
 331       "isConstructor" : false,
 332       "isPrivate" : false,
 333       "example" : "",
 334       "deprecated" : "",
 335       "since" : "",
 336       "see" : "",
 337       "exceptions" : "",
 338       "requires" : "",
 339       "params" : [],
 340       "returns" : [
 341         {
 342           "name" : "",
 343           "type" : "BasicForm",
 344           "desc" : "this"
 345         }
 346       ]
 347     },
 348     {
 349       "name" : "isDirty",
 350       "type" : "function",
 351       "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
 352       "sig" : "()\n{\n\n}",
 353       "static" : false,
 354       "memberOf" : "",
 355       "isStatic" : false,
 356       "isConstructor" : false,
 357       "isPrivate" : false,
 358       "example" : "",
 359       "deprecated" : "",
 360       "since" : "",
 361       "see" : "",
 362       "exceptions" : "",
 363       "requires" : "",
 364       "params" : [],
 365       "returns" : [
 366         {
 367           "name" : "",
 368           "type" : "",
 369           "desc" : "Boolean"
 370         }
 371       ]
 372     },
 373     {
 374       "name" : "updateRecord",
 375       "type" : "function",
 376       "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
 377       "sig" : "(record)",
 378       "static" : false,
 379       "memberOf" : "",
 380       "isStatic" : false,
 381       "isConstructor" : false,
 382       "isPrivate" : false,
 383       "example" : "",
 384       "deprecated" : "",
 385       "since" : "",
 386       "see" : "",
 387       "exceptions" : "",
 388       "requires" : "",
 389       "params" : [
 390         {
 391           "name" : "record",
 392           "type" : "Record",
 393           "desc" : "The record to edit",
 394           "isOptional" : false
 395         }
 396       ],
 397       "returns" : [
 398         {
 399           "name" : "",
 400           "type" : "BasicForm",
 401           "desc" : "this"
 402         }
 403       ]
 404     },
 405     {
 406       "name" : "hasChanged",
 407       "type" : "function",
 408       "desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
 409       "sig" : "()\n{\n\n}",
 410       "static" : false,
 411       "memberOf" : "",
 412       "isStatic" : false,
 413       "isConstructor" : false,
 414       "isPrivate" : false,
 415       "example" : "",
 416       "deprecated" : "",
 417       "since" : "",
 418       "see" : "",
 419       "exceptions" : "",
 420       "requires" : "",
 421       "params" : [],
 422       "returns" : [
 423         {
 424           "name" : "",
 425           "type" : "",
 426           "desc" : "Boolean"
 427         }
 428       ]
 429     },
 430     {
 431       "name" : "applyToFields",
 432       "type" : "function",
 433       "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
 434       "sig" : "(values)",
 435       "static" : false,
 436       "memberOf" : "",
 437       "isStatic" : false,
 438       "isConstructor" : false,
 439       "isPrivate" : false,
 440       "example" : "",
 441       "deprecated" : "",
 442       "since" : "",
 443       "see" : "",
 444       "exceptions" : "",
 445       "requires" : "",
 446       "params" : [
 447         {
 448           "name" : "values",
 449           "type" : "Object",
 450           "desc" : "",
 451           "isOptional" : false
 452         }
 453       ],
 454       "returns" : [
 455         {
 456           "name" : "",
 457           "type" : "BasicForm",
 458           "desc" : "this"
 459         }
 460       ]
 461     },
 462     {
 463       "name" : "getFieldValues",
 464       "type" : "function",
 465       "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.\nNormally this will not return readOnly data",
 466       "sig" : "(with_readonly)",
 467       "static" : false,
 468       "memberOf" : "",
 469       "isStatic" : false,
 470       "isConstructor" : false,
 471       "isPrivate" : false,
 472       "example" : "",
 473       "deprecated" : "",
 474       "since" : "",
 475       "see" : "",
 476       "exceptions" : "",
 477       "requires" : "",
 478       "params" : [
 479         {
 480           "name" : "with_readonly",
 481           "type" : "Boolean",
 482           "desc" : "return readonly field data.",
 483           "isOptional" : false
 484         }
 485       ],
 486       "returns" : [
 487         {
 488           "name" : "",
 489           "type" : "Object",
 490           "desc" : ""
 491         }
 492       ]
 493     },
 494     {
 495       "name" : "submit",
 496       "type" : "function",
 497       "desc" : "Shortcut to do a submit action.",
 498       "sig" : "(options)",
 499       "static" : false,
 500       "memberOf" : "",
 501       "isStatic" : false,
 502       "isConstructor" : false,
 503       "isPrivate" : false,
 504       "example" : "",
 505       "deprecated" : "",
 506       "since" : "",
 507       "see" : "",
 508       "exceptions" : "",
 509       "requires" : "",
 510       "params" : [
 511         {
 512           "name" : "options",
 513           "type" : "Object",
 514           "desc" : "The options to pass to the action (see {@link #doAction} for details)",
 515           "isOptional" : false
 516         }
 517       ],
 518       "returns" : [
 519         {
 520           "name" : "",
 521           "type" : "BasicForm",
 522           "desc" : "this"
 523         }
 524       ]
 525     },
 526     {
 527       "name" : "markInvalid",
 528       "type" : "function",
 529       "desc" : "Mark fields in this form invalid in bulk.",
 530       "sig" : "(errors)",
 531       "static" : false,
 532       "memberOf" : "",
 533       "isStatic" : false,
 534       "isConstructor" : false,
 535       "isPrivate" : false,
 536       "example" : "",
 537       "deprecated" : "",
 538       "since" : "",
 539       "see" : "",
 540       "exceptions" : "",
 541       "requires" : "",
 542       "params" : [
 543         {
 544           "name" : "errors",
 545           "type" : "Array/Object",
 546           "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
 547           "isOptional" : false
 548         }
 549       ],
 550       "returns" : [
 551         {
 552           "name" : "",
 553           "type" : "BasicForm",
 554           "desc" : "this"
 555         }
 556       ]
 557     },
 558     {
 559       "name" : "setValues",
 560       "type" : "function",
 561       "desc" : "Set values for fields in this form in bulk.",
 562       "sig" : "(values)",
 563       "static" : false,
 564       "memberOf" : "",
 565       "isStatic" : false,
 566       "isConstructor" : false,
 567       "isPrivate" : false,
 568       "example" : "",
 569       "deprecated" : "",
 570       "since" : "",
 571       "see" : "",
 572       "exceptions" : "",
 573       "requires" : "",
 574       "params" : [
 575         {
 576           "name" : "values",
 577           "type" : "Array/Object",
 578           "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
 579           "isOptional" : false
 580         }
 581       ],
 582       "returns" : [
 583         {
 584           "name" : "",
 585           "type" : "BasicForm",
 586           "desc" : "this"
 587         }
 588       ]
 589     },
 590     {
 591       "name" : "isValid",
 592       "type" : "function",
 593       "desc" : "Returns true if client-side validation on the form is successful.",
 594       "sig" : "()\n{\n\n}",
 595       "static" : false,
 596       "memberOf" : "",
 597       "isStatic" : false,
 598       "isConstructor" : false,
 599       "isPrivate" : false,
 600       "example" : "",
 601       "deprecated" : "",
 602       "since" : "",
 603       "see" : "",
 604       "exceptions" : "",
 605       "requires" : "",
 606       "params" : [],
 607       "returns" : [
 608         {
 609           "name" : "",
 610           "type" : "",
 611           "desc" : "Boolean"
 612         }
 613       ]
 614     },
 615     {
 616       "name" : "invalidFields",
 617       "type" : "function",
 618       "desc" : "Returns array of invalid form fields.",
 619       "sig" : "()\n{\n\n}",
 620       "static" : false,
 621       "memberOf" : "",
 622       "isStatic" : false,
 623       "isConstructor" : false,
 624       "isPrivate" : false,
 625       "example" : "",
 626       "deprecated" : "",
 627       "since" : "",
 628       "see" : "",
 629       "exceptions" : "",
 630       "requires" : "",
 631       "params" : [],
 632       "returns" : [
 633         {
 634           "name" : "",
 635           "type" : "",
 636           "desc" : "Array"
 637         }
 638       ]
 639     },
 640     {
 641       "name" : "render",
 642       "type" : "function",
 643       "desc" : "Looks at the fields in this form, checks them for an id attribute,\nand calls applyTo on the existing dom element with that id.",
 644       "sig" : "()\n{\n\n}",
 645       "static" : false,
 646       "memberOf" : "",
 647       "isStatic" : false,
 648       "isConstructor" : false,
 649       "isPrivate" : false,
 650       "example" : "",
 651       "deprecated" : "",
 652       "since" : "",
 653       "see" : "",
 654       "exceptions" : "",
 655       "requires" : "",
 656       "params" : [],
 657       "returns" : [
 658         {
 659           "name" : "",
 660           "type" : "BasicForm",
 661           "desc" : "this"
 662         }
 663       ]
 664     },
 665     {
 666       "name" : "add",
 667       "type" : "function",
 668       "desc" : "Add Roo.form components to this form.",
 669       "sig" : "(field1, field2, etc)",
 670       "static" : false,
 671       "memberOf" : "",
 672       "isStatic" : false,
 673       "isConstructor" : false,
 674       "isPrivate" : false,
 675       "example" : "",
 676       "deprecated" : "",
 677       "since" : "",
 678       "see" : "",
 679       "exceptions" : "",
 680       "requires" : "",
 681       "params" : [
 682         {
 683           "name" : "field1",
 684           "type" : "Field",
 685           "desc" : "",
 686           "isOptional" : false
 687         },
 688         {
 689           "name" : "field2",
 690           "type" : "Field",
 691           "desc" : "(optional)",
 692           "isOptional" : false
 693         },
 694         {
 695           "name" : "etc",
 696           "type" : "Field",
 697           "desc" : "(optional)",
 698           "isOptional" : false
 699         }
 700       ],
 701       "returns" : [
 702         {
 703           "name" : "",
 704           "type" : "BasicForm",
 705           "desc" : "this"
 706         }
 707       ]
 708     },
 709     {
 710       "name" : "applyIfToFields",
 711       "type" : "function",
 712       "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
 713       "sig" : "(values)",
 714       "static" : false,
 715       "memberOf" : "",
 716       "isStatic" : false,
 717       "isConstructor" : false,
 718       "isPrivate" : false,
 719       "example" : "",
 720       "deprecated" : "",
 721       "since" : "",
 722       "see" : "",
 723       "exceptions" : "",
 724       "requires" : "",
 725       "params" : [
 726         {
 727           "name" : "values",
 728           "type" : "Object",
 729           "desc" : "",
 730           "isOptional" : false
 731         }
 732       ],
 733       "returns" : [
 734         {
 735           "name" : "",
 736           "type" : "BasicForm",
 737           "desc" : "this"
 738         }
 739       ]
 740     },
 741     {
 742       "name" : "findField",
 743       "type" : "function",
 744       "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
 745       "sig" : "(id)",
 746       "static" : false,
 747       "memberOf" : "",
 748       "isStatic" : false,
 749       "isConstructor" : false,
 750       "isPrivate" : false,
 751       "example" : "",
 752       "deprecated" : "",
 753       "since" : "",
 754       "see" : "",
 755       "exceptions" : "",
 756       "requires" : "",
 757       "params" : [
 758         {
 759           "name" : "id",
 760           "type" : "String",
 761           "desc" : "The value to search for",
 762           "isOptional" : false
 763         }
 764       ],
 765       "returns" : [
 766         {
 767           "name" : "",
 768           "type" : "",
 769           "desc" : "Field"
 770         }
 771       ]
 772     },
 773     {
 774       "name" : "reset",
 775       "type" : "function",
 776       "desc" : "Resets this form.",
 777       "sig" : "()\n{\n\n}",
 778       "static" : false,
 779       "memberOf" : "",
 780       "isStatic" : false,
 781       "isConstructor" : false,
 782       "isPrivate" : false,
 783       "example" : "",
 784       "deprecated" : "",
 785       "since" : "",
 786       "see" : "",
 787       "exceptions" : "",
 788       "requires" : "",
 789       "params" : [],
 790       "returns" : [
 791         {
 792           "name" : "",
 793           "type" : "BasicForm",
 794           "desc" : "this"
 795         }
 796       ]
 797     },
 798     {
 799       "name" : "addForm",
 800       "type" : "function",
 801       "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.",
 802       "sig" : "(form)",
 803       "static" : false,
 804       "memberOf" : "",
 805       "isStatic" : false,
 806       "isConstructor" : false,
 807       "isPrivate" : false,
 808       "example" : "",
 809       "deprecated" : "",
 810       "since" : "",
 811       "see" : "",
 812       "exceptions" : "",
 813       "requires" : "",
 814       "params" : [
 815         {
 816           "name" : "form",
 817           "type" : "Roo.form.Form",
 818           "desc" : "to add.",
 819           "isOptional" : false
 820         }
 821       ],
 822       "returns" : []
 823     },
 824     {
 825       "name" : "purgeListeners",
 826       "type" : "function",
 827       "desc" : "Removes all listeners for this object",
 828       "sig" : "()\n{\n\n}",
 829       "static" : false,
 830       "memberOf" : "Roo.util.Observable",
 831       "isStatic" : false,
 832       "isConstructor" : false,
 833       "isPrivate" : false,
 834       "example" : "",
 835       "deprecated" : "",
 836       "since" : "",
 837       "see" : "",
 838       "exceptions" : "",
 839       "requires" : "",
 840       "params" : [],
 841       "returns" : []
 842     },
 843     {
 844       "name" : "on",
 845       "type" : "function",
 846       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 847       "sig" : "(eventName, handler, scope, options)",
 848       "static" : false,
 849       "memberOf" : "Roo.util.Observable",
 850       "isStatic" : false,
 851       "isConstructor" : false,
 852       "isPrivate" : false,
 853       "example" : "",
 854       "deprecated" : "",
 855       "since" : "",
 856       "see" : "",
 857       "exceptions" : "",
 858       "requires" : "",
 859       "params" : [
 860         {
 861           "name" : "eventName",
 862           "type" : "String",
 863           "desc" : "The type of event to listen for",
 864           "isOptional" : false
 865         },
 866         {
 867           "name" : "handler",
 868           "type" : "Function",
 869           "desc" : "The method the event invokes",
 870           "isOptional" : false
 871         },
 872         {
 873           "name" : "scope",
 874           "type" : "Object",
 875           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 876           "isOptional" : false
 877         },
 878         {
 879           "name" : "options",
 880           "type" : "Object",
 881           "desc" : "(optional)",
 882           "isOptional" : false
 883         }
 884       ],
 885       "returns" : []
 886     },
 887     {
 888       "name" : "un",
 889       "type" : "function",
 890       "desc" : "Removes a listener (shorthand for removeListener)",
 891       "sig" : "(eventName, handler, scope)",
 892       "static" : false,
 893       "memberOf" : "Roo.util.Observable",
 894       "isStatic" : false,
 895       "isConstructor" : false,
 896       "isPrivate" : false,
 897       "example" : "",
 898       "deprecated" : "",
 899       "since" : "",
 900       "see" : "",
 901       "exceptions" : "",
 902       "requires" : "",
 903       "params" : [
 904         {
 905           "name" : "eventName",
 906           "type" : "String",
 907           "desc" : "The type of event to listen for",
 908           "isOptional" : false
 909         },
 910         {
 911           "name" : "handler",
 912           "type" : "Function",
 913           "desc" : "The handler to remove",
 914           "isOptional" : false
 915         },
 916         {
 917           "name" : "scope",
 918           "type" : "Object",
 919           "desc" : "(optional) The scope (this object) for the handler",
 920           "isOptional" : false
 921         }
 922       ],
 923       "returns" : []
 924     },
 925     {
 926       "name" : "addEvents",
 927       "type" : "function",
 928       "desc" : "Used to define events on this Observable",
 929       "sig" : "(object)",
 930       "static" : false,
 931       "memberOf" : "Roo.util.Observable",
 932       "isStatic" : false,
 933       "isConstructor" : false,
 934       "isPrivate" : false,
 935       "example" : "",
 936       "deprecated" : "",
 937       "since" : "",
 938       "see" : "",
 939       "exceptions" : "",
 940       "requires" : "",
 941       "params" : [
 942         {
 943           "name" : "object",
 944           "type" : "Object",
 945           "desc" : "The object with the events defined",
 946           "isOptional" : false
 947         }
 948       ],
 949       "returns" : []
 950     },
 951     {
 952       "name" : "releaseCapture",
 953       "type" : "function",
 954       "desc" : "Removes <b>all</b> added captures from the Observable.",
 955       "sig" : "(o)",
 956       "static" : true,
 957       "memberOf" : "Roo.util.Observable",
 958       "isStatic" : true,
 959       "isConstructor" : false,
 960       "isPrivate" : false,
 961       "example" : "",
 962       "deprecated" : "",
 963       "since" : "",
 964       "see" : "",
 965       "exceptions" : "",
 966       "requires" : "",
 967       "params" : [
 968         {
 969           "name" : "o",
 970           "type" : "Observable",
 971           "desc" : "The Observable to release",
 972           "isOptional" : false
 973         }
 974       ],
 975       "returns" : []
 976     },
 977     {
 978       "name" : "removeListener",
 979       "type" : "function",
 980       "desc" : "Removes a listener",
 981       "sig" : "(eventName, handler, scope)",
 982       "static" : false,
 983       "memberOf" : "Roo.util.Observable",
 984       "isStatic" : false,
 985       "isConstructor" : false,
 986       "isPrivate" : false,
 987       "example" : "",
 988       "deprecated" : "",
 989       "since" : "",
 990       "see" : "",
 991       "exceptions" : "",
 992       "requires" : "",
 993       "params" : [
 994         {
 995           "name" : "eventName",
 996           "type" : "String",
 997           "desc" : "The type of event to listen for",
 998           "isOptional" : false
 999         },
1000         {
1001           "name" : "handler",
1002           "type" : "Function",
1003           "desc" : "The handler to remove",
1004           "isOptional" : false
1005         },
1006         {
1007           "name" : "scope",
1008           "type" : "Object",
1009           "desc" : "(optional) The scope (this object) for the handler",
1010           "isOptional" : false
1011         }
1012       ],
1013       "returns" : []
1014     },
1015     {
1016       "name" : "fireEvent",
1017       "type" : "function",
1018       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1019       "sig" : "(eventName, args)",
1020       "static" : false,
1021       "memberOf" : "Roo.util.Observable",
1022       "isStatic" : false,
1023       "isConstructor" : false,
1024       "isPrivate" : false,
1025       "example" : "",
1026       "deprecated" : "",
1027       "since" : "",
1028       "see" : "",
1029       "exceptions" : "",
1030       "requires" : "",
1031       "params" : [
1032         {
1033           "name" : "eventName",
1034           "type" : "String",
1035           "desc" : "",
1036           "isOptional" : false
1037         },
1038         {
1039           "name" : "args",
1040           "type" : "Object...",
1041           "desc" : "Variable number of parameters are passed to handlers",
1042           "isOptional" : false
1043         }
1044       ],
1045       "returns" : [
1046         {
1047           "name" : "",
1048           "type" : "Boolean",
1049           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1050         }
1051       ]
1052     },
1053     {
1054       "name" : "hasListener",
1055       "type" : "function",
1056       "desc" : "Checks to see if this object has any listeners for a specified event",
1057       "sig" : "(eventName)",
1058       "static" : false,
1059       "memberOf" : "Roo.util.Observable",
1060       "isStatic" : false,
1061       "isConstructor" : false,
1062       "isPrivate" : false,
1063       "example" : "",
1064       "deprecated" : "",
1065       "since" : "",
1066       "see" : "",
1067       "exceptions" : "",
1068       "requires" : "",
1069       "params" : [
1070         {
1071           "name" : "eventName",
1072           "type" : "String",
1073           "desc" : "The name of the event to check for",
1074           "isOptional" : false
1075         }
1076       ],
1077       "returns" : [
1078         {
1079           "name" : "",
1080           "type" : "Boolean",
1081           "desc" : "True if the event is being listened for, else false"
1082         }
1083       ]
1084     },
1085     {
1086       "name" : "capture",
1087       "type" : "function",
1088       "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.",
1089       "sig" : "(o, fn, scope)",
1090       "static" : true,
1091       "memberOf" : "Roo.util.Observable",
1092       "isStatic" : true,
1093       "isConstructor" : false,
1094       "isPrivate" : false,
1095       "example" : "",
1096       "deprecated" : "",
1097       "since" : "",
1098       "see" : "",
1099       "exceptions" : "",
1100       "requires" : "",
1101       "params" : [
1102         {
1103           "name" : "o",
1104           "type" : "Observable",
1105           "desc" : "The Observable to capture",
1106           "isOptional" : false
1107         },
1108         {
1109           "name" : "fn",
1110           "type" : "Function",
1111           "desc" : "The function to call",
1112           "isOptional" : false
1113         },
1114         {
1115           "name" : "scope",
1116           "type" : "Object",
1117           "desc" : "(optional) The scope (this object) for the fn",
1118           "isOptional" : false
1119         }
1120       ],
1121       "returns" : []
1122     },
1123     {
1124       "name" : "addListener",
1125       "type" : "function",
1126       "desc" : "Appends an event handler to this component",
1127       "sig" : "(eventName, handler, scope, options)",
1128       "static" : false,
1129       "memberOf" : "Roo.util.Observable",
1130       "isStatic" : false,
1131       "isConstructor" : false,
1132       "isPrivate" : false,
1133       "example" : "",
1134       "deprecated" : "",
1135       "since" : "",
1136       "see" : "",
1137       "exceptions" : "",
1138       "requires" : "",
1139       "params" : [
1140         {
1141           "name" : "eventName",
1142           "type" : "String",
1143           "desc" : "The type of event to listen for",
1144           "isOptional" : false
1145         },
1146         {
1147           "name" : "handler",
1148           "type" : "Function",
1149           "desc" : "The method the event invokes",
1150           "isOptional" : false
1151         },
1152         {
1153           "name" : "scope",
1154           "type" : "Object",
1155           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1156           "isOptional" : false
1157         },
1158         {
1159           "name" : "options",
1160           "type" : "Object",
1161           "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>",
1162           "isOptional" : false
1163         }
1164       ],
1165       "returns" : []
1166     }
1167   ],
1168   "events" : [
1169     {
1170       "name" : "beforeaction",
1171       "type" : "function",
1172       "desc" : "Fires before any action is performed. Return false to cancel the action.",
1173       "sig" : "function (_self, action)\n{\n\n}",
1174       "memberOf" : "",
1175       "example" : "",
1176       "deprecated" : "",
1177       "since" : "",
1178       "see" : "",
1179       "params" : [
1180         {
1181           "name" : "this",
1182           "type" : "Form",
1183           "desc" : "",
1184           "isOptional" : false
1185         },
1186         {
1187           "name" : "action",
1188           "type" : "Action",
1189           "desc" : "The action to be performed",
1190           "isOptional" : false
1191         }
1192       ],
1193       "returns" : []
1194     },
1195     {
1196       "name" : "actioncomplete",
1197       "type" : "function",
1198       "desc" : "Fires when an action is completed.",
1199       "sig" : "function (_self, action)\n{\n\n}",
1200       "memberOf" : "",
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" : "action",
1214           "type" : "Action",
1215           "desc" : "The action that completed",
1216           "isOptional" : false
1217         }
1218       ],
1219       "returns" : []
1220     },
1221     {
1222       "name" : "actionfailed",
1223       "type" : "function",
1224       "desc" : "Fires when an action fails.",
1225       "sig" : "function (_self, action)\n{\n\n}",
1226       "memberOf" : "",
1227       "example" : "",
1228       "deprecated" : "",
1229       "since" : "",
1230       "see" : "",
1231       "params" : [
1232         {
1233           "name" : "this",
1234           "type" : "Form",
1235           "desc" : "",
1236           "isOptional" : false
1237         },
1238         {
1239           "name" : "action",
1240           "type" : "Action",
1241           "desc" : "The action that failed",
1242           "isOptional" : false
1243         }
1244       ],
1245       "returns" : []
1246     }
1247   ]
1248 }