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

   1 {
   2   "name" : "Roo.UpdateManager",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "childClasses" : {  },
   7   "tree_children" : [],
   8   "tree_parent" : [],
   9   "desc" : "Provides AJAX-style update for Element object.<br><br>\nUsage:<br>\n<pre><code>\n// Get it from a Roo.Element object\nvar el = Roo.get(\"foo\");\nvar mgr = el.getUpdateManager();\nmgr.update(\"http://myserver.com/index.php\", \"param1=1&amp;param2=2\");\n...\nmgr.formUpdate(\"myFormId\", \"http://myserver.com/index.php\");\n<br>\n// or directly (returns the same UpdateManager instance)\nvar mgr = new Roo.UpdateManager(\"myElementId\");\nmgr.startAutoRefresh(60, \"http://myserver.com/index.php\");\nmgr.on(\"update\", myFcnNeedsToKnow);\n<br>\n   // short handed call directly from the element object\n   Roo.get(\"foo\").load({\n        url: \"bar.php\",\n        scripts:true,\n        params: \"for=bar\",\n        text: \"Loading Foo...\"\n   });\n</code></pre>",
  10   "isSingleton" : false,
  11   "isStatic" : false,
  12   "isBuiltin" : false,
  13   "isAbstract" : false,
  14   "isBuilderTop" : false,
  15   "memberOf" : "UpdateManager",
  16   "example" : "",
  17   "deprecated" : "",
  18   "since" : "",
  19   "see" : "",
  20   "params" : [
  21     {
  22       "name" : "el",
  23       "type" : "String/HTMLElement/Roo.Element",
  24       "desc" : "The element to update",
  25       "isOptional" : false
  26     },
  27     {
  28       "name" : "forceNew",
  29       "type" : "Boolean",
  30       "desc" : "(optional) By default the constructor checks to see if the passed element already has an UpdateManager and if it does it returns the same instance. This will skip that check (useful for extending this class).",
  31       "isOptional" : false
  32     }
  33   ],
  34   "returns" : [],
  35   "throws" : "",
  36   "requires" : "",
  37   "config" : [
  38     {
  39       "name" : "listeners",
  40       "type" : "Object",
  41       "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>",
  42       "memberOf" : "Roo.util.Observable"
  43     }
  44   ],
  45   "methods" : [
  46     {
  47       "name" : "update",
  48       "type" : "function",
  49       "desc" : "Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET.",
  50       "sig" : "(url, params, callback, discardUrl)",
  51       "static" : false,
  52       "memberOf" : "",
  53       "isStatic" : false,
  54       "isConstructor" : false,
  55       "isPrivate" : false,
  56       "example" : "",
  57       "deprecated" : "",
  58       "since" : "",
  59       "see" : "",
  60       "exceptions" : "",
  61       "requires" : "",
  62       "params" : [
  63         {
  64           "name" : "url",
  65           "type" : "Object/String/Function",
  66           "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\num.update({<br/>\n    url: \"your-url.php\",<br/>\n    params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string<br/>\n    callback: yourFunction,<br/>\n    scope: yourObject, //(optional scope)  <br/>\n    discardUrl: false, <br/>\n    nocache: false,<br/>\n    text: \"Loading...\",<br/>\n    timeout: 30,<br/>\n    scripts: false<br/>\n});\n</code></pre>\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this UpdateManager instance.",
  67           "isOptional" : false
  68         },
  69         {
  70           "name" : "params",
  71           "type" : "String/Object",
  72           "desc" : "(optional) The parameters to pass as either a url encoded string \"param1=1&amp;param2=2\" or an object {param1: 1, param2: 2}",
  73           "isOptional" : false
  74         },
  75         {
  76           "name" : "callback",
  77           "type" : "Function",
  78           "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)",
  79           "isOptional" : false
  80         },
  81         {
  82           "name" : "discardUrl",
  83           "type" : "Boolean",
  84           "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.",
  85           "isOptional" : false
  86         }
  87       ],
  88       "returns" : []
  89     },
  90     {
  91       "name" : "showLoading",
  92       "type" : "function",
  93       "desc" : "Called to update the element to \"Loading\" state. Override to perform custom action.",
  94       "sig" : "()\n{\n\n}",
  95       "static" : false,
  96       "memberOf" : "",
  97       "isStatic" : false,
  98       "isConstructor" : false,
  99       "isPrivate" : false,
 100       "example" : "",
 101       "deprecated" : "",
 102       "since" : "",
 103       "see" : "",
 104       "exceptions" : "",
 105       "requires" : "",
 106       "params" : [],
 107       "returns" : []
 108     },
 109     {
 110       "name" : "setDefaultUrl",
 111       "type" : "function",
 112       "desc" : "Set the defaultUrl used for updates",
 113       "sig" : "(defaultUrl)",
 114       "static" : false,
 115       "memberOf" : "",
 116       "isStatic" : false,
 117       "isConstructor" : false,
 118       "isPrivate" : false,
 119       "example" : "",
 120       "deprecated" : "",
 121       "since" : "",
 122       "see" : "",
 123       "exceptions" : "",
 124       "requires" : "",
 125       "params" : [
 126         {
 127           "name" : "defaultUrl",
 128           "type" : "String/Function",
 129           "desc" : "The url or a function to call to get the url",
 130           "isOptional" : false
 131         }
 132       ],
 133       "returns" : []
 134     },
 135     {
 136       "name" : "updateElement",
 137       "type" : "function",
 138       "desc" : "Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ...}).\nUsage:\n<pre><code>Roo.UpdateManager.updateElement(\"my-div\", \"stuff.php\");</code></pre>",
 139       "sig" : "(el, url, params, options)",
 140       "static" : true,
 141       "memberOf" : "",
 142       "isStatic" : true,
 143       "isConstructor" : false,
 144       "isPrivate" : false,
 145       "example" : "",
 146       "deprecated" : "This has been deprecated: ",
 147       "since" : "",
 148       "see" : "",
 149       "exceptions" : "",
 150       "requires" : "",
 151       "params" : [
 152         {
 153           "name" : "el",
 154           "type" : "String/HTMLElement/Roo.Element",
 155           "desc" : "The element to update",
 156           "isOptional" : false
 157         },
 158         {
 159           "name" : "url",
 160           "type" : "String",
 161           "desc" : "The url",
 162           "isOptional" : false
 163         },
 164         {
 165           "name" : "params",
 166           "type" : "String/Object",
 167           "desc" : "(optional) Url encoded param string or an object of name/value pairs",
 168           "isOptional" : false
 169         },
 170         {
 171           "name" : "options",
 172           "type" : "Object",
 173           "desc" : "(optional) A config object with any of the UpdateManager properties you want to set - for example: {disableCaching:true, indicatorText: \"Loading data...\"}",
 174           "isOptional" : false
 175         }
 176       ],
 177       "returns" : []
 178     },
 179     {
 180       "name" : "refresh",
 181       "type" : "function",
 182       "desc" : "Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately",
 183       "sig" : "(callback)",
 184       "static" : false,
 185       "memberOf" : "",
 186       "isStatic" : false,
 187       "isConstructor" : false,
 188       "isPrivate" : false,
 189       "example" : "",
 190       "deprecated" : "",
 191       "since" : "",
 192       "see" : "",
 193       "exceptions" : "",
 194       "requires" : "",
 195       "params" : [
 196         {
 197           "name" : "callback",
 198           "type" : "Function",
 199           "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)",
 200           "isOptional" : false
 201         }
 202       ],
 203       "returns" : []
 204     },
 205     {
 206       "name" : "getEl",
 207       "type" : "function",
 208       "desc" : "Get the Element this UpdateManager is bound to",
 209       "sig" : "()\n{\n\n}",
 210       "static" : false,
 211       "memberOf" : "",
 212       "isStatic" : false,
 213       "isConstructor" : false,
 214       "isPrivate" : false,
 215       "example" : "",
 216       "deprecated" : "",
 217       "since" : "",
 218       "see" : "",
 219       "exceptions" : "",
 220       "requires" : "",
 221       "params" : [],
 222       "returns" : [
 223         {
 224           "name" : "",
 225           "type" : "Roo.Element",
 226           "desc" : "The element"
 227         }
 228       ]
 229     },
 230     {
 231       "name" : "isUpdating",
 232       "type" : "function",
 233       "desc" : "Returns true if an update is in progress",
 234       "sig" : "()\n{\n\n}",
 235       "static" : false,
 236       "memberOf" : "",
 237       "isStatic" : false,
 238       "isConstructor" : false,
 239       "isPrivate" : false,
 240       "example" : "",
 241       "deprecated" : "",
 242       "since" : "",
 243       "see" : "",
 244       "exceptions" : "",
 245       "requires" : "",
 246       "params" : [],
 247       "returns" : [
 248         {
 249           "name" : "",
 250           "type" : "Boolean",
 251           "desc" : ""
 252         }
 253       ]
 254     },
 255     {
 256       "name" : "stopAutoRefresh",
 257       "type" : "function",
 258       "desc" : "Stop auto refresh on this element.",
 259       "sig" : "()\n{\n\n}",
 260       "static" : false,
 261       "memberOf" : "",
 262       "isStatic" : false,
 263       "isConstructor" : false,
 264       "isPrivate" : false,
 265       "example" : "",
 266       "deprecated" : "",
 267       "since" : "",
 268       "see" : "",
 269       "exceptions" : "",
 270       "requires" : "",
 271       "params" : [],
 272       "returns" : []
 273     },
 274     {
 275       "name" : "startAutoRefresh",
 276       "type" : "function",
 277       "desc" : "Set this element to auto refresh.",
 278       "sig" : "(interval, url, params, callback, refreshNow)",
 279       "static" : false,
 280       "memberOf" : "",
 281       "isStatic" : false,
 282       "isConstructor" : false,
 283       "isPrivate" : false,
 284       "example" : "",
 285       "deprecated" : "",
 286       "since" : "",
 287       "see" : "",
 288       "exceptions" : "",
 289       "requires" : "",
 290       "params" : [
 291         {
 292           "name" : "interval",
 293           "type" : "Number",
 294           "desc" : "How often to update (in seconds).",
 295           "isOptional" : false
 296         },
 297         {
 298           "name" : "url",
 299           "type" : "String/Function",
 300           "desc" : "(optional) The url for this request or a function to call to get the url (Defaults to the last used url)",
 301           "isOptional" : false
 302         },
 303         {
 304           "name" : "params",
 305           "type" : "String/Object",
 306           "desc" : "(optional) The parameters to pass as either a url encoded string \"&param1=1&param2=2\" or as an object {param1: 1, param2: 2}",
 307           "isOptional" : false
 308         },
 309         {
 310           "name" : "callback",
 311           "type" : "Function",
 312           "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)",
 313           "isOptional" : false
 314         },
 315         {
 316           "name" : "refreshNow",
 317           "type" : "Boolean",
 318           "desc" : "(optional) Whether to execute the refresh now, or wait the interval",
 319           "isOptional" : false
 320         }
 321       ],
 322       "returns" : []
 323     },
 324     {
 325       "name" : "abort",
 326       "type" : "function",
 327       "desc" : "Aborts the executing transaction",
 328       "sig" : "()\n{\n\n}",
 329       "static" : false,
 330       "memberOf" : "",
 331       "isStatic" : false,
 332       "isConstructor" : false,
 333       "isPrivate" : false,
 334       "example" : "",
 335       "deprecated" : "",
 336       "since" : "",
 337       "see" : "",
 338       "exceptions" : "",
 339       "requires" : "",
 340       "params" : [],
 341       "returns" : []
 342     },
 343     {
 344       "name" : "setRenderer",
 345       "type" : "function",
 346       "desc" : "Set the content renderer for this UpdateManager. See {@link Roo.UpdateManager.BasicRenderer#render} for more details.",
 347       "sig" : "(renderer)",
 348       "static" : false,
 349       "memberOf" : "",
 350       "isStatic" : false,
 351       "isConstructor" : false,
 352       "isPrivate" : false,
 353       "example" : "",
 354       "deprecated" : "",
 355       "since" : "",
 356       "see" : "",
 357       "exceptions" : "",
 358       "requires" : "",
 359       "params" : [
 360         {
 361           "name" : "renderer",
 362           "type" : "Object",
 363           "desc" : "The object implementing the render() method",
 364           "isOptional" : false
 365         }
 366       ],
 367       "returns" : []
 368     },
 369     {
 370       "name" : "formUpdate",
 371       "type" : "function",
 372       "desc" : "Performs an async form post, updating this element with the response. If the form has the attribute enctype=\"multipart/form-data\", it assumes it's a file upload.\nUses this.sslBlankUrl for SSL file uploads to prevent IE security warning.",
 373       "sig" : "(form, url, reset, callback)",
 374       "static" : false,
 375       "memberOf" : "",
 376       "isStatic" : false,
 377       "isConstructor" : false,
 378       "isPrivate" : false,
 379       "example" : "",
 380       "deprecated" : "",
 381       "since" : "",
 382       "see" : "",
 383       "exceptions" : "",
 384       "requires" : "",
 385       "params" : [
 386         {
 387           "name" : "form",
 388           "type" : "String/HTMLElement",
 389           "desc" : "The form Id or form element",
 390           "isOptional" : false
 391         },
 392         {
 393           "name" : "url",
 394           "type" : "String",
 395           "desc" : "(optional) The url to pass the form to. If omitted the action attribute on the form will be used.",
 396           "isOptional" : false
 397         },
 398         {
 399           "name" : "reset",
 400           "type" : "Boolean",
 401           "desc" : "(optional) Whether to try to reset the form after the update",
 402           "isOptional" : false
 403         },
 404         {
 405           "name" : "callback",
 406           "type" : "Function",
 407           "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)",
 408           "isOptional" : false
 409         }
 410       ],
 411       "returns" : []
 412     },
 413     {
 414       "name" : "purgeListeners",
 415       "type" : "function",
 416       "desc" : "Removes all listeners for this object",
 417       "sig" : "()\n{\n\n}",
 418       "static" : false,
 419       "memberOf" : "Roo.util.Observable",
 420       "isStatic" : false,
 421       "isConstructor" : false,
 422       "isPrivate" : false,
 423       "example" : "",
 424       "deprecated" : "",
 425       "since" : "",
 426       "see" : "",
 427       "exceptions" : "",
 428       "requires" : "",
 429       "params" : [],
 430       "returns" : []
 431     },
 432     {
 433       "name" : "on",
 434       "type" : "function",
 435       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 436       "sig" : "(eventName, handler, scope, options)",
 437       "static" : false,
 438       "memberOf" : "Roo.util.Observable",
 439       "isStatic" : false,
 440       "isConstructor" : false,
 441       "isPrivate" : false,
 442       "example" : "",
 443       "deprecated" : "",
 444       "since" : "",
 445       "see" : "",
 446       "exceptions" : "",
 447       "requires" : "",
 448       "params" : [
 449         {
 450           "name" : "eventName",
 451           "type" : "String",
 452           "desc" : "The type of event to listen for",
 453           "isOptional" : false
 454         },
 455         {
 456           "name" : "handler",
 457           "type" : "Function",
 458           "desc" : "The method the event invokes",
 459           "isOptional" : false
 460         },
 461         {
 462           "name" : "scope",
 463           "type" : "Object",
 464           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 465           "isOptional" : false
 466         },
 467         {
 468           "name" : "options",
 469           "type" : "Object",
 470           "desc" : "(optional)",
 471           "isOptional" : false
 472         }
 473       ],
 474       "returns" : []
 475     },
 476     {
 477       "name" : "un",
 478       "type" : "function",
 479       "desc" : "Removes a listener (shorthand for removeListener)",
 480       "sig" : "(eventName, handler, scope)",
 481       "static" : false,
 482       "memberOf" : "Roo.util.Observable",
 483       "isStatic" : false,
 484       "isConstructor" : false,
 485       "isPrivate" : false,
 486       "example" : "",
 487       "deprecated" : "",
 488       "since" : "",
 489       "see" : "",
 490       "exceptions" : "",
 491       "requires" : "",
 492       "params" : [
 493         {
 494           "name" : "eventName",
 495           "type" : "String",
 496           "desc" : "The type of event to listen for",
 497           "isOptional" : false
 498         },
 499         {
 500           "name" : "handler",
 501           "type" : "Function",
 502           "desc" : "The handler to remove",
 503           "isOptional" : false
 504         },
 505         {
 506           "name" : "scope",
 507           "type" : "Object",
 508           "desc" : "(optional) The scope (this object) for the handler",
 509           "isOptional" : false
 510         }
 511       ],
 512       "returns" : []
 513     },
 514     {
 515       "name" : "addEvents",
 516       "type" : "function",
 517       "desc" : "Used to define events on this Observable",
 518       "sig" : "(object)",
 519       "static" : false,
 520       "memberOf" : "Roo.util.Observable",
 521       "isStatic" : false,
 522       "isConstructor" : false,
 523       "isPrivate" : false,
 524       "example" : "",
 525       "deprecated" : "",
 526       "since" : "",
 527       "see" : "",
 528       "exceptions" : "",
 529       "requires" : "",
 530       "params" : [
 531         {
 532           "name" : "object",
 533           "type" : "Object",
 534           "desc" : "The object with the events defined",
 535           "isOptional" : false
 536         }
 537       ],
 538       "returns" : []
 539     },
 540     {
 541       "name" : "releaseCapture",
 542       "type" : "function",
 543       "desc" : "Removes <b>all</b> added captures from the Observable.",
 544       "sig" : "(o)",
 545       "static" : true,
 546       "memberOf" : "Roo.util.Observable",
 547       "isStatic" : true,
 548       "isConstructor" : false,
 549       "isPrivate" : false,
 550       "example" : "",
 551       "deprecated" : "",
 552       "since" : "",
 553       "see" : "",
 554       "exceptions" : "",
 555       "requires" : "",
 556       "params" : [
 557         {
 558           "name" : "o",
 559           "type" : "Observable",
 560           "desc" : "The Observable to release",
 561           "isOptional" : false
 562         }
 563       ],
 564       "returns" : []
 565     },
 566     {
 567       "name" : "removeListener",
 568       "type" : "function",
 569       "desc" : "Removes a listener",
 570       "sig" : "(eventName, handler, scope)",
 571       "static" : false,
 572       "memberOf" : "Roo.util.Observable",
 573       "isStatic" : false,
 574       "isConstructor" : false,
 575       "isPrivate" : false,
 576       "example" : "",
 577       "deprecated" : "",
 578       "since" : "",
 579       "see" : "",
 580       "exceptions" : "",
 581       "requires" : "",
 582       "params" : [
 583         {
 584           "name" : "eventName",
 585           "type" : "String",
 586           "desc" : "The type of event to listen for",
 587           "isOptional" : false
 588         },
 589         {
 590           "name" : "handler",
 591           "type" : "Function",
 592           "desc" : "The handler to remove",
 593           "isOptional" : false
 594         },
 595         {
 596           "name" : "scope",
 597           "type" : "Object",
 598           "desc" : "(optional) The scope (this object) for the handler",
 599           "isOptional" : false
 600         }
 601       ],
 602       "returns" : []
 603     },
 604     {
 605       "name" : "fireEvent",
 606       "type" : "function",
 607       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 608       "sig" : "(eventName, args)",
 609       "static" : false,
 610       "memberOf" : "Roo.util.Observable",
 611       "isStatic" : false,
 612       "isConstructor" : false,
 613       "isPrivate" : false,
 614       "example" : "",
 615       "deprecated" : "",
 616       "since" : "",
 617       "see" : "",
 618       "exceptions" : "",
 619       "requires" : "",
 620       "params" : [
 621         {
 622           "name" : "eventName",
 623           "type" : "String",
 624           "desc" : "",
 625           "isOptional" : false
 626         },
 627         {
 628           "name" : "args",
 629           "type" : "Object...",
 630           "desc" : "Variable number of parameters are passed to handlers",
 631           "isOptional" : false
 632         }
 633       ],
 634       "returns" : [
 635         {
 636           "name" : "",
 637           "type" : "Boolean",
 638           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 639         }
 640       ]
 641     },
 642     {
 643       "name" : "hasListener",
 644       "type" : "function",
 645       "desc" : "Checks to see if this object has any listeners for a specified event",
 646       "sig" : "(eventName)",
 647       "static" : false,
 648       "memberOf" : "Roo.util.Observable",
 649       "isStatic" : false,
 650       "isConstructor" : false,
 651       "isPrivate" : false,
 652       "example" : "",
 653       "deprecated" : "",
 654       "since" : "",
 655       "see" : "",
 656       "exceptions" : "",
 657       "requires" : "",
 658       "params" : [
 659         {
 660           "name" : "eventName",
 661           "type" : "String",
 662           "desc" : "The name of the event to check for",
 663           "isOptional" : false
 664         }
 665       ],
 666       "returns" : [
 667         {
 668           "name" : "",
 669           "type" : "Boolean",
 670           "desc" : "True if the event is being listened for, else false"
 671         }
 672       ]
 673     },
 674     {
 675       "name" : "capture",
 676       "type" : "function",
 677       "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.",
 678       "sig" : "(o, fn, scope)",
 679       "static" : true,
 680       "memberOf" : "Roo.util.Observable",
 681       "isStatic" : true,
 682       "isConstructor" : false,
 683       "isPrivate" : false,
 684       "example" : "",
 685       "deprecated" : "",
 686       "since" : "",
 687       "see" : "",
 688       "exceptions" : "",
 689       "requires" : "",
 690       "params" : [
 691         {
 692           "name" : "o",
 693           "type" : "Observable",
 694           "desc" : "The Observable to capture",
 695           "isOptional" : false
 696         },
 697         {
 698           "name" : "fn",
 699           "type" : "Function",
 700           "desc" : "The function to call",
 701           "isOptional" : false
 702         },
 703         {
 704           "name" : "scope",
 705           "type" : "Object",
 706           "desc" : "(optional) The scope (this object) for the fn",
 707           "isOptional" : false
 708         }
 709       ],
 710       "returns" : []
 711     },
 712     {
 713       "name" : "addListener",
 714       "type" : "function",
 715       "desc" : "Appends an event handler to this component",
 716       "sig" : "(eventName, handler, scope, options)",
 717       "static" : false,
 718       "memberOf" : "Roo.util.Observable",
 719       "isStatic" : false,
 720       "isConstructor" : false,
 721       "isPrivate" : false,
 722       "example" : "",
 723       "deprecated" : "",
 724       "since" : "",
 725       "see" : "",
 726       "exceptions" : "",
 727       "requires" : "",
 728       "params" : [
 729         {
 730           "name" : "eventName",
 731           "type" : "String",
 732           "desc" : "The type of event to listen for",
 733           "isOptional" : false
 734         },
 735         {
 736           "name" : "handler",
 737           "type" : "Function",
 738           "desc" : "The method the event invokes",
 739           "isOptional" : false
 740         },
 741         {
 742           "name" : "scope",
 743           "type" : "Object",
 744           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 745           "isOptional" : false
 746         },
 747         {
 748           "name" : "options",
 749           "type" : "Object",
 750           "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>",
 751           "isOptional" : false
 752         }
 753       ],
 754       "returns" : []
 755     }
 756   ],
 757   "events" : [
 758     {
 759       "name" : "update",
 760       "type" : "function",
 761       "desc" : "Fired after successful update is made.",
 762       "sig" : "function (el, oResponseObject)\n{\n\n}",
 763       "memberOf" : "",
 764       "example" : "",
 765       "deprecated" : "",
 766       "since" : "",
 767       "see" : "",
 768       "params" : [
 769         {
 770           "name" : "el",
 771           "type" : "Roo.Element",
 772           "desc" : "",
 773           "isOptional" : false
 774         },
 775         {
 776           "name" : "oResponseObject",
 777           "type" : "Object",
 778           "desc" : "The response Object",
 779           "isOptional" : false
 780         }
 781       ],
 782       "returns" : []
 783     },
 784     {
 785       "name" : "beforeupdate",
 786       "type" : "function",
 787       "desc" : "Fired before an update is made, return false from your handler and the update is cancelled.",
 788       "sig" : "function (el, url, params)\n{\n\n}",
 789       "memberOf" : "",
 790       "example" : "",
 791       "deprecated" : "",
 792       "since" : "",
 793       "see" : "",
 794       "params" : [
 795         {
 796           "name" : "el",
 797           "type" : "Roo.Element",
 798           "desc" : "",
 799           "isOptional" : false
 800         },
 801         {
 802           "name" : "url",
 803           "type" : "String/Object/Function",
 804           "desc" : "",
 805           "isOptional" : false
 806         },
 807         {
 808           "name" : "params",
 809           "type" : "String/Object",
 810           "desc" : "",
 811           "isOptional" : false
 812         }
 813       ],
 814       "returns" : []
 815     },
 816     {
 817       "name" : "failure",
 818       "type" : "function",
 819       "desc" : "Fired on update failure.",
 820       "sig" : "function (el, oResponseObject)\n{\n\n}",
 821       "memberOf" : "",
 822       "example" : "",
 823       "deprecated" : "",
 824       "since" : "",
 825       "see" : "",
 826       "params" : [
 827         {
 828           "name" : "el",
 829           "type" : "Roo.Element",
 830           "desc" : "",
 831           "isOptional" : false
 832         },
 833         {
 834           "name" : "oResponseObject",
 835           "type" : "Object",
 836           "desc" : "The response Object",
 837           "isOptional" : false
 838         }
 839       ],
 840       "returns" : []
 841     }
 842   ]
 843 }