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

   1 {
   2   "name" : "Roo.util.Observable",
   3   "augments" : [],
   4   "childClasses" : {
   5     "Roo.bootstrap.nav.Item" : [
   6       "Roo.bootstrap.nav.SidebarItem"
   7     ],
   8     "Roo.ContentPanel" : [
   9       "Roo.GridPanel",
  10       "Roo.NestedLayoutPanel",
  11       "Roo.TreePanel"
  12     ],
  13     "Roo.LayoutRegion" : [
  14       "Roo.SplitLayoutRegion",
  15       "Roo.bootstrap.layout.Split"
  16     ],
  17     "Roo.form.Layout" : [
  18       "Roo.form.Column",
  19       "Roo.form.FieldSet",
  20       "Roo.form.Row"
  21     ],
  22     "Roo.bootstrap.Column" : [
  23       "Roo.bootstrap.TabGroup"
  24     ],
  25     "Roo.grid.EditorGrid" : [
  26       "Roo.grid.PropertyGrid"
  27     ],
  28     "Roo.LayoutManager" : [
  29       "Roo.BorderLayout"
  30     ],
  31     "Roo.dd.DropTarget" : [
  32       "Roo.dd.DropZone"
  33     ],
  34     "Roo.bootstrap.Element" : [
  35       "Roo.bootstrap.CardFooter",
  36       "Roo.bootstrap.CardHeader",
  37       "Roo.bootstrap.CardImageTop",
  38       "Roo.bootstrap.DropTarget"
  39     ],
  40     "Roo.form.TriggerField" : [
  41       "Roo.form.ComboBox",
  42       "Roo.form.DateField",
  43       "Roo.form.MonthField",
  44       "Roo.form.Select"
  45     ],
  46     "Roo.form.ComboBox" : [
  47       "Roo.form.ComboCheck",
  48       "Roo.form.ComboNested"
  49     ],
  50     "Roo.View" : [
  51       "Roo.JsonView"
  52     ],
  53     "Roo.data.DataProxy" : [
  54       "Roo.data.HttpProxy",
  55       "Roo.data.MemoryProxy"
  56     ],
  57     "Roo.menu.Menu" : [
  58       "Roo.menu.ColorMenu",
  59       "Roo.menu.DateMenu"
  60     ],
  61     "Roo.bootstrap.form.TriggerField" : [
  62       "Roo.bootstrap.form.ComboBox",
  63       "Roo.bootstrap.form.PhoneInput"
  64     ],
  65     "Roo.dd.DragDrop" : [
  66       "Roo.dd.DD",
  67       "Roo.dd.DDTarget"
  68     ],
  69     "Roo.tree.TreeNode" : [
  70       "Roo.tree.AsyncTreeNode"
  71     ],
  72     "Roo.Button" : [
  73       "Roo.SplitButton",
  74       "Roo.Toolbar.Button"
  75     ],
  76     "Roo.util.Observable" : [
  77       "Roo.BasicDialog",
  78       "Roo.BasicLayoutRegion",
  79       "Roo.Button",
  80       "Roo.Component",
  81       "Roo.ContentPanel",
  82       "Roo.Document",
  83       "Roo.LayoutManager",
  84       "Roo.Resizable",
  85       "Roo.SplitBar",
  86       "Roo.TabPanel",
  87       "Roo.TabPanelItem",
  88       "Roo.UpdateManager",
  89       "Roo.View",
  90       "Roo.XComponent",
  91       "Roo.bootstrap.SplitBar",
  92       "Roo.bootstrap.layout.Basic",
  93       "Roo.bootstrap.panel.Content",
  94       "Roo.bootstrap.panel.TabItem",
  95       "Roo.bootstrap.panel.Tabs",
  96       "Roo.data.Connection",
  97       "Roo.data.DataProxy",
  98       "Roo.data.Node",
  99       "Roo.data.Store",
 100       "Roo.data.Tree",
 101       "Roo.dd.DragDrop",
 102       "Roo.form.BasicForm",
 103       "Roo.grid.AbstractGridView",
 104       "Roo.grid.AbstractSelectionModel",
 105       "Roo.grid.ColumnModel",
 106       "Roo.grid.Grid",
 107       "Roo.grid.GridView",
 108       "Roo.menu.Menu",
 109       "Roo.tree.DefaultSelectionModel",
 110       "Roo.tree.MultiSelectionModel",
 111       "Roo.tree.TreeLoader",
 112       "Roo.util.ClickRepeater",
 113       "Roo.util.MixedCollection"
 114     ],
 115     "Roo.bootstrap.layout.Manager" : [
 116       "Roo.bootstrap.layout.Border"
 117     ],
 118     "Roo.Component" : [
 119       "Roo.BoxComponent",
 120       "Roo.CalendarPanel",
 121       "Roo.ColorPalette",
 122       "Roo.DatePicker",
 123       "Roo.Editor",
 124       "Roo.HtmlEditorCore",
 125       "Roo.bootstrap.Component",
 126       "Roo.form.Layout",
 127       "Roo.menu.BaseItem"
 128     ],
 129     "Roo.BorderLayout" : [
 130       "Roo.ReaderLayout"
 131     ],
 132     "Roo.menu.Item" : [
 133       "Roo.menu.CheckItem"
 134     ],
 135     "Roo.bootstrap.form.TextArea" : [
 136       "Roo.bootstrap.form.HtmlEditor",
 137       "Roo.bootstrap.form.Markdown"
 138     ],
 139     "Roo.form.Field" : [
 140       "Roo.form.Checkbox",
 141       "Roo.form.DayPicker",
 142       "Roo.form.DisplayField",
 143       "Roo.form.GridField",
 144       "Roo.form.HtmlEditor",
 145       "Roo.form.Signature",
 146       "Roo.form.TextField"
 147     ],
 148     "Roo.form.BasicForm" : [
 149       "Roo.form.Form"
 150     ],
 151     "Roo.SplitButton" : [
 152       "Roo.Toolbar.SplitButton"
 153     ],
 154     "Roo.bootstrap.panel.Content" : [
 155       "Roo.bootstrap.panel.Grid",
 156       "Roo.bootstrap.panel.Nest"
 157     ],
 158     "Roo.BasicDialog" : [
 159       "Roo.LayoutDialog"
 160     ],
 161     "Roo.menu.BaseItem" : [
 162       "Roo.menu.Adapter",
 163       "Roo.menu.Item",
 164       "Roo.menu.Separator",
 165       "Roo.menu.TextItem"
 166     ],
 167     "Roo.BoxComponent" : [
 168       "Roo.dialog.UploadCropbox",
 169       "Roo.form.ComboBoxArray.Item",
 170       "Roo.form.Field",
 171       "Roo.form.TextItem"
 172     ],
 173     "Roo.data.Store" : [
 174       "Roo.data.JsonStore",
 175       "Roo.data.SimpleStore"
 176     ],
 177     "Roo.dd.DDProxy" : [
 178       "Roo.dd.DragSource",
 179       "Roo.grid.SplitDragZone"
 180     ],
 181     "Roo.menu.Adapter" : [
 182       "Roo.menu.ColorItem",
 183       "Roo.menu.DateItem"
 184     ],
 185     "Roo.tree.TreePanel" : [
 186       "Roo.tree.ColumnTree"
 187     ],
 188     "Roo.bootstrap.layout.Basic" : [
 189       "Roo.bootstrap.layout.Region"
 190     ],
 191     "Roo.form.TextField" : [
 192       "Roo.form.ComboBoxArray",
 193       "Roo.form.Hidden",
 194       "Roo.form.NumberField",
 195       "Roo.form.TextArea",
 196       "Roo.form.TriggerField"
 197     ],
 198     "Roo.form.Checkbox" : [
 199       "Roo.form.Radio"
 200     ],
 201     "Roo.bootstrap.form.Input" : [
 202       "Roo.bootstrap.form.CheckBox",
 203       "Roo.bootstrap.form.DateField",
 204       "Roo.bootstrap.form.MonthField",
 205       "Roo.bootstrap.form.NumberField",
 206       "Roo.bootstrap.form.RadioSet",
 207       "Roo.bootstrap.form.SecurePass",
 208       "Roo.bootstrap.form.TextArea",
 209       "Roo.bootstrap.form.TimeField",
 210       "Roo.bootstrap.form.TriggerField"
 211     ],
 212     "Roo.grid.AbstractSelectionModel" : [
 213       "Roo.grid.CellSelectionModel",
 214       "Roo.grid.RowSelectionModel"
 215     ],
 216     "Roo.bootstrap.form.ComboBox" : [
 217       "Roo.bootstrap.form.MoneyField"
 218     ],
 219     "Roo.dd.DDTarget" : [
 220       "Roo.dd.DropTarget"
 221     ],
 222     "Roo.bootstrap.Button" : [
 223       "Roo.bootstrap.ButtonUploader",
 224       "Roo.bootstrap.form.CardUploader"
 225     ],
 226     "Roo.bootstrap.Component" : [
 227       "Roo.bootstrap.Alert",
 228       "Roo.bootstrap.BezierSignature",
 229       "Roo.bootstrap.Body",
 230       "Roo.bootstrap.Brick",
 231       "Roo.bootstrap.Button",
 232       "Roo.bootstrap.ButtonGroup",
 233       "Roo.bootstrap.Calendar",
 234       "Roo.bootstrap.Card",
 235       "Roo.bootstrap.Column",
 236       "Roo.bootstrap.Container",
 237       "Roo.bootstrap.DocumentManager",
 238       "Roo.bootstrap.DocumentSlider",
 239       "Roo.bootstrap.DocumentViewer",
 240       "Roo.bootstrap.Element",
 241       "Roo.bootstrap.Graph",
 242       "Roo.bootstrap.Header",
 243       "Roo.bootstrap.Img",
 244       "Roo.bootstrap.LayoutMasonry",
 245       "Roo.bootstrap.LayoutMasonryAuto",
 246       "Roo.bootstrap.Link",
 247       "Roo.bootstrap.LocationPicker",
 248       "Roo.bootstrap.MasonryBrick",
 249       "Roo.bootstrap.MessageBar",
 250       "Roo.bootstrap.Modal",
 251       "Roo.bootstrap.Pagination",
 252       "Roo.bootstrap.PaginationItem",
 253       "Roo.bootstrap.Popover",
 254       "Roo.bootstrap.Progress",
 255       "Roo.bootstrap.ProgressBar",
 256       "Roo.bootstrap.Row",
 257       "Roo.bootstrap.Slider",
 258       "Roo.bootstrap.TabPanel",
 259       "Roo.bootstrap.Table",
 260       "Roo.bootstrap.TableBody",
 261       "Roo.bootstrap.TableCell",
 262       "Roo.bootstrap.TableRow",
 263       "Roo.bootstrap.UploadCropbox",
 264       "Roo.bootstrap.breadcrumb.Item",
 265       "Roo.bootstrap.breadcrumb.Nav",
 266       "Roo.bootstrap.dash.NumberBox",
 267       "Roo.bootstrap.dash.TabBox",
 268       "Roo.bootstrap.dash.TabPane",
 269       "Roo.bootstrap.form.DateSplitField",
 270       "Roo.bootstrap.form.FieldLabel",
 271       "Roo.bootstrap.form.Form",
 272       "Roo.bootstrap.form.Input",
 273       "Roo.bootstrap.form.Radio",
 274       "Roo.bootstrap.layout.Manager",
 275       "Roo.bootstrap.menu.Item",
 276       "Roo.bootstrap.menu.Menu",
 277       "Roo.bootstrap.menu.Separator",
 278       "Roo.bootstrap.nav.Bar",
 279       "Roo.bootstrap.nav.Group",
 280       "Roo.bootstrap.nav.Item",
 281       "Roo.bootstrap.nav.ProgressBar",
 282       "Roo.bootstrap.nav.ProgressBarItem"
 283     ],
 284     "Roo.data.Tree" : [
 285       "Roo.tree.TreePanel"
 286     ],
 287     "Roo.dd.DD" : [
 288       "Roo.dd.DDProxy"
 289     ],
 290     "Roo.form.TextArea" : [
 291       "Roo.form.FCKeditor"
 292     ],
 293     "Roo.grid.Grid" : [
 294       "Roo.grid.Calendar",
 295       "Roo.grid.EditorGrid"
 296     ],
 297     "Roo.Editor" : [
 298       "Roo.grid.GridEditor",
 299       "Roo.tree.TreeEditor"
 300     ],
 301     "Roo.bootstrap.nav.Simplebar" : [
 302       "Roo.bootstrap.PagingToolbar",
 303       "Roo.bootstrap.PopoverNav",
 304       "Roo.bootstrap.form.HtmlEditorToolbarStandard",
 305       "Roo.bootstrap.nav.Headerbar"
 306     ],
 307     "Roo.data.Connection" : [
 308       "Roo.Ajax"
 309     ],
 310     "Roo.dd.DragSource" : [
 311       "Roo.dd.DragZone"
 312     ],
 313     "Roo.bootstrap.nav.Bar" : [
 314       "Roo.bootstrap.nav.Sidebar",
 315       "Roo.bootstrap.nav.Simplebar"
 316     ],
 317     "Roo.BasicLayoutRegion" : [
 318       "Roo.LayoutRegion"
 319     ],
 320     "Roo.data.Node" : [
 321       "Roo.tree.TreeNode"
 322     ]
 323   },
 324   "tree_children" : [],
 325   "tree_parent" : [],
 326   "desc" : "Base class that provides a common interface for publishing events. Subclasses are expected to\nto have a property \"events\" with all the events defined.<br>\nFor example:\n<pre><code>\n Employee = function(name){\n    this.name = name;\n    this.addEvents({\n        \"fired\" : true,\n        \"quit\" : true\n    });\n }\n Roo.extend(Employee, Roo.util.Observable);\n</code></pre>",
 327   "isSingleton" : false,
 328   "isStatic" : false,
 329   "isBuiltin" : false,
 330   "isAbstract" : false,
 331   "isBuilderTop" : false,
 332   "memberOf" : "Observable",
 333   "example" : "",
 334   "deprecated" : "",
 335   "since" : "",
 336   "see" : "",
 337   "params" : [
 338     {
 339       "name" : "config",
 340       "type" : "Object",
 341       "desc" : "properties to use (incuding events / listeners)",
 342       "isOptional" : false
 343     }
 344   ],
 345   "returns" : [],
 346   "throws" : "",
 347   "requires" : "",
 348   "config" : [
 349     {
 350       "name" : "listeners",
 351       "type" : "Object",
 352       "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>",
 353       "memberOf" : "",
 354       "isOptional" : false,
 355       "optvals" : []
 356     }
 357   ],
 358   "methods" : [
 359     {
 360       "name" : "purgeListeners",
 361       "type" : "function",
 362       "desc" : "Removes all listeners for this object",
 363       "sig" : "()\n{\n\n}",
 364       "static" : false,
 365       "memberOf" : "",
 366       "isStatic" : false,
 367       "isConstructor" : false,
 368       "isPrivate" : false,
 369       "example" : "",
 370       "deprecated" : "",
 371       "since" : "",
 372       "see" : "",
 373       "exceptions" : "",
 374       "requires" : "",
 375       "params" : [],
 376       "returns" : []
 377     },
 378     {
 379       "name" : "on",
 380       "type" : "function",
 381       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 382       "sig" : "(eventName, handler, scope, options)",
 383       "static" : false,
 384       "memberOf" : "",
 385       "isStatic" : false,
 386       "isConstructor" : false,
 387       "isPrivate" : false,
 388       "example" : "",
 389       "deprecated" : "",
 390       "since" : "",
 391       "see" : "",
 392       "exceptions" : "",
 393       "requires" : "",
 394       "params" : [
 395         {
 396           "name" : "eventName",
 397           "type" : "String",
 398           "desc" : "The type of event to listen for",
 399           "isOptional" : false
 400         },
 401         {
 402           "name" : "handler",
 403           "type" : "Function",
 404           "desc" : "The method the event invokes",
 405           "isOptional" : false
 406         },
 407         {
 408           "name" : "scope",
 409           "type" : "Object",
 410           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 411           "isOptional" : false
 412         },
 413         {
 414           "name" : "options",
 415           "type" : "Object",
 416           "desc" : "(optional)",
 417           "isOptional" : false
 418         }
 419       ],
 420       "returns" : []
 421     },
 422     {
 423       "name" : "un",
 424       "type" : "function",
 425       "desc" : "Removes a listener (shorthand for removeListener)",
 426       "sig" : "(eventName, handler, scope)",
 427       "static" : false,
 428       "memberOf" : "",
 429       "isStatic" : false,
 430       "isConstructor" : false,
 431       "isPrivate" : false,
 432       "example" : "",
 433       "deprecated" : "",
 434       "since" : "",
 435       "see" : "",
 436       "exceptions" : "",
 437       "requires" : "",
 438       "params" : [
 439         {
 440           "name" : "eventName",
 441           "type" : "String",
 442           "desc" : "The type of event to listen for",
 443           "isOptional" : false
 444         },
 445         {
 446           "name" : "handler",
 447           "type" : "Function",
 448           "desc" : "The handler to remove",
 449           "isOptional" : false
 450         },
 451         {
 452           "name" : "scope",
 453           "type" : "Object",
 454           "desc" : "(optional) The scope (this object) for the handler",
 455           "isOptional" : false
 456         }
 457       ],
 458       "returns" : []
 459     },
 460     {
 461       "name" : "addEvents",
 462       "type" : "function",
 463       "desc" : "Used to define events on this Observable",
 464       "sig" : "(object)",
 465       "static" : false,
 466       "memberOf" : "",
 467       "isStatic" : false,
 468       "isConstructor" : false,
 469       "isPrivate" : false,
 470       "example" : "",
 471       "deprecated" : "",
 472       "since" : "",
 473       "see" : "",
 474       "exceptions" : "",
 475       "requires" : "",
 476       "params" : [
 477         {
 478           "name" : "object",
 479           "type" : "Object",
 480           "desc" : "The object with the events defined",
 481           "isOptional" : false
 482         }
 483       ],
 484       "returns" : []
 485     },
 486     {
 487       "name" : "releaseCapture",
 488       "type" : "function",
 489       "desc" : "Removes <b>all</b> added captures from the Observable.",
 490       "sig" : "(o)",
 491       "static" : true,
 492       "memberOf" : "",
 493       "isStatic" : true,
 494       "isConstructor" : false,
 495       "isPrivate" : false,
 496       "example" : "",
 497       "deprecated" : "",
 498       "since" : "",
 499       "see" : "",
 500       "exceptions" : "",
 501       "requires" : "",
 502       "params" : [
 503         {
 504           "name" : "o",
 505           "type" : "Observable",
 506           "desc" : "The Observable to release",
 507           "isOptional" : false
 508         }
 509       ],
 510       "returns" : []
 511     },
 512     {
 513       "name" : "removeListener",
 514       "type" : "function",
 515       "desc" : "Removes a listener",
 516       "sig" : "(eventName, handler, scope)",
 517       "static" : false,
 518       "memberOf" : "",
 519       "isStatic" : false,
 520       "isConstructor" : false,
 521       "isPrivate" : false,
 522       "example" : "",
 523       "deprecated" : "",
 524       "since" : "",
 525       "see" : "",
 526       "exceptions" : "",
 527       "requires" : "",
 528       "params" : [
 529         {
 530           "name" : "eventName",
 531           "type" : "String",
 532           "desc" : "The type of event to listen for",
 533           "isOptional" : false
 534         },
 535         {
 536           "name" : "handler",
 537           "type" : "Function",
 538           "desc" : "The handler to remove",
 539           "isOptional" : false
 540         },
 541         {
 542           "name" : "scope",
 543           "type" : "Object",
 544           "desc" : "(optional) The scope (this object) for the handler",
 545           "isOptional" : false
 546         }
 547       ],
 548       "returns" : []
 549     },
 550     {
 551       "name" : "fireEvent",
 552       "type" : "function",
 553       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 554       "sig" : "(eventName, args)",
 555       "static" : false,
 556       "memberOf" : "",
 557       "isStatic" : false,
 558       "isConstructor" : false,
 559       "isPrivate" : false,
 560       "example" : "",
 561       "deprecated" : "",
 562       "since" : "",
 563       "see" : "",
 564       "exceptions" : "",
 565       "requires" : "",
 566       "params" : [
 567         {
 568           "name" : "eventName",
 569           "type" : "String",
 570           "desc" : "",
 571           "isOptional" : false
 572         },
 573         {
 574           "name" : "args",
 575           "type" : "Object...",
 576           "desc" : "Variable number of parameters are passed to handlers",
 577           "isOptional" : false
 578         }
 579       ],
 580       "returns" : [
 581         {
 582           "name" : "",
 583           "type" : "Boolean",
 584           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 585         }
 586       ]
 587     },
 588     {
 589       "name" : "hasListener",
 590       "type" : "function",
 591       "desc" : "Checks to see if this object has any listeners for a specified event",
 592       "sig" : "(eventName)",
 593       "static" : false,
 594       "memberOf" : "",
 595       "isStatic" : false,
 596       "isConstructor" : false,
 597       "isPrivate" : false,
 598       "example" : "",
 599       "deprecated" : "",
 600       "since" : "",
 601       "see" : "",
 602       "exceptions" : "",
 603       "requires" : "",
 604       "params" : [
 605         {
 606           "name" : "eventName",
 607           "type" : "String",
 608           "desc" : "The name of the event to check for",
 609           "isOptional" : false
 610         }
 611       ],
 612       "returns" : [
 613         {
 614           "name" : "",
 615           "type" : "Boolean",
 616           "desc" : "True if the event is being listened for, else false"
 617         }
 618       ]
 619     },
 620     {
 621       "name" : "capture",
 622       "type" : "function",
 623       "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.",
 624       "sig" : "(o, fn, scope)",
 625       "static" : true,
 626       "memberOf" : "",
 627       "isStatic" : true,
 628       "isConstructor" : false,
 629       "isPrivate" : false,
 630       "example" : "",
 631       "deprecated" : "",
 632       "since" : "",
 633       "see" : "",
 634       "exceptions" : "",
 635       "requires" : "",
 636       "params" : [
 637         {
 638           "name" : "o",
 639           "type" : "Observable",
 640           "desc" : "The Observable to capture",
 641           "isOptional" : false
 642         },
 643         {
 644           "name" : "fn",
 645           "type" : "Function",
 646           "desc" : "The function to call",
 647           "isOptional" : false
 648         },
 649         {
 650           "name" : "scope",
 651           "type" : "Object",
 652           "desc" : "(optional) The scope (this object) for the fn",
 653           "isOptional" : false
 654         }
 655       ],
 656       "returns" : []
 657     },
 658     {
 659       "name" : "addListener",
 660       "type" : "function",
 661       "desc" : "Appends an event handler to this component",
 662       "sig" : "(eventName, handler, scope, options)",
 663       "static" : false,
 664       "memberOf" : "",
 665       "isStatic" : false,
 666       "isConstructor" : false,
 667       "isPrivate" : false,
 668       "example" : "",
 669       "deprecated" : "",
 670       "since" : "",
 671       "see" : "",
 672       "exceptions" : "",
 673       "requires" : "",
 674       "params" : [
 675         {
 676           "name" : "eventName",
 677           "type" : "String",
 678           "desc" : "The type of event to listen for",
 679           "isOptional" : false
 680         },
 681         {
 682           "name" : "handler",
 683           "type" : "Function",
 684           "desc" : "The method the event invokes",
 685           "isOptional" : false
 686         },
 687         {
 688           "name" : "scope",
 689           "type" : "Object",
 690           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 691           "isOptional" : false
 692         },
 693         {
 694           "name" : "options",
 695           "type" : "Object",
 696           "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>",
 697           "isOptional" : false
 698         }
 699       ],
 700       "returns" : []
 701     }
 702   ],
 703   "events" : []
 704 }