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

   1 {
   2   "name" : "Roo.bootstrap.DropTarget",
   3   "augments" : [
   4     "Roo.bootstrap.Element",
   5     "Roo.bootstrap.Component",
   6     "Roo.Component",
   7     "Roo.util.Observable"
   8   ],
   9   "childClasses" : {  },
  10   "tree_children" : [],
  11   "tree_parent" : [],
  12   "desc" : "Bootstrap DropTarget class",
  13   "isSingleton" : false,
  14   "isStatic" : false,
  15   "isBuiltin" : false,
  16   "isAbstract" : false,
  17   "isBuilderTop" : false,
  18   "memberOf" : "DropTarget",
  19   "example" : "",
  20   "deprecated" : "",
  21   "since" : "",
  22   "see" : "",
  23   "params" : [
  24     {
  25       "name" : "config",
  26       "type" : "Object",
  27       "desc" : "The config object",
  28       "isOptional" : false
  29     }
  30   ],
  31   "returns" : [],
  32   "throws" : "",
  33   "requires" : "",
  34   "config" : [
  35     {
  36       "name" : "listeners",
  37       "type" : "Object",
  38       "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>",
  39       "memberOf" : "Roo.util.Observable"
  40     },
  41     {
  42       "name" : "tooltip",
  43       "type" : "string",
  44       "desc" : "Text for the tooltip",
  45       "memberOf" : "Roo.bootstrap.Component"
  46     },
  47     {
  48       "name" : "container_method",
  49       "type" : "string",
  50       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
  51       "memberOf" : "Roo.bootstrap.Component"
  52     },
  53     {
  54       "name" : "visibilityEl",
  55       "type" : "string|object",
  56       "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
  57       "memberOf" : "Roo.bootstrap.Component"
  58     },
  59     {
  60       "name" : "can_build_overlaid",
  61       "type" : "Boolean",
  62       "desc" : "True if element can be rebuild from a HTML page",
  63       "memberOf" : "Roo.bootstrap.Component"
  64     },
  65     {
  66       "name" : "hideMode",
  67       "type" : "String",
  68       "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
  69       "memberOf" : "Roo.Component"
  70     },
  71     {
  72       "name" : "tag",
  73       "type" : "String",
  74       "desc" : "tag of the element",
  75       "memberOf" : "Roo.bootstrap.Element"
  76     },
  77     {
  78       "name" : "style",
  79       "type" : "String",
  80       "desc" : "any extra css",
  81       "memberOf" : "Roo.bootstrap.Component"
  82     },
  83     {
  84       "name" : "allowDomMove",
  85       "type" : "Boolean",
  86       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
  87       "memberOf" : "Roo.Component"
  88     },
  89     {
  90       "name" : "cls",
  91       "type" : "String",
  92       "desc" : "class of the element",
  93       "memberOf" : "Roo.bootstrap.Element"
  94     },
  95     {
  96       "name" : "html",
  97       "type" : "String",
  98       "desc" : "contents of the element",
  99       "memberOf" : "Roo.bootstrap.Element"
 100     },
 101     {
 102       "name" : "preventDefault",
 103       "type" : "Boolean",
 104       "desc" : "e) default false",
 105       "memberOf" : "Roo.bootstrap.Element"
 106     },
 107     {
 108       "name" : "clickable",
 109       "type" : "Boolean",
 110       "desc" : "e) default false",
 111       "memberOf" : "Roo.bootstrap.Element"
 112     },
 113     {
 114       "name" : "xattr",
 115       "type" : "Object",
 116       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
 117       "memberOf" : "Roo.bootstrap.Component"
 118     },
 119     {
 120       "name" : "actionMode",
 121       "type" : "String",
 122       "desc" : "which property holds the element that used for  hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
 123       "memberOf" : "Roo.Component"
 124     },
 125     {
 126       "name" : "dataId",
 127       "type" : "string",
 128       "desc" : "cutomer id",
 129       "memberOf" : "Roo.bootstrap.Component"
 130     },
 131     {
 132       "name" : "name",
 133       "type" : "string",
 134       "desc" : "dropable name",
 135       "memberOf" : "Roo.bootstrap.DropTarget"
 136     },
 137     {
 138       "name" : "role",
 139       "type" : "String",
 140       "desc" : "default blank - set to button to force cursor pointer",
 141       "memberOf" : "Roo.bootstrap.Element"
 142     },
 143     {
 144       "name" : "disableClass",
 145       "type" : "String",
 146       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 147       "memberOf" : "Roo.Component"
 148     }
 149   ],
 150   "methods" : [
 151     {
 152       "name" : "tooltipEl",
 153       "type" : "function",
 154       "desc" : "Fetch the element to display the tooltip on.",
 155       "sig" : "()\n{\n\n}",
 156       "static" : false,
 157       "memberOf" : "Roo.bootstrap.Component",
 158       "isStatic" : false,
 159       "isConstructor" : false,
 160       "isPrivate" : false,
 161       "example" : "",
 162       "deprecated" : "",
 163       "since" : "",
 164       "see" : "",
 165       "exceptions" : "",
 166       "requires" : "",
 167       "params" : [],
 168       "returns" : [
 169         {
 170           "name" : "",
 171           "type" : "Roo.Element",
 172           "desc" : "defaults to this.el"
 173         }
 174       ]
 175     },
 176     {
 177       "name" : "hide",
 178       "type" : "function",
 179       "desc" : "Hide a component - adds 'hidden' class",
 180       "sig" : "()\n{\n\n}",
 181       "static" : false,
 182       "memberOf" : "Roo.bootstrap.Component",
 183       "isStatic" : false,
 184       "isConstructor" : false,
 185       "isPrivate" : false,
 186       "example" : "",
 187       "deprecated" : "",
 188       "since" : "",
 189       "see" : "",
 190       "exceptions" : "",
 191       "requires" : "",
 192       "params" : [],
 193       "returns" : []
 194     },
 195     {
 196       "name" : "show",
 197       "type" : "function",
 198       "desc" : "Show a component - removes 'hidden' class",
 199       "sig" : "()\n{\n\n}",
 200       "static" : false,
 201       "memberOf" : "Roo.bootstrap.Component",
 202       "isStatic" : false,
 203       "isConstructor" : false,
 204       "isPrivate" : false,
 205       "example" : "",
 206       "deprecated" : "",
 207       "since" : "",
 208       "see" : "",
 209       "exceptions" : "",
 210       "requires" : "",
 211       "params" : [],
 212       "returns" : []
 213     },
 214     {
 215       "name" : "setVisibilityEl",
 216       "type" : "function",
 217       "desc" : "Set the element that will be used to show or hide",
 218       "sig" : "()\n{\n\n}",
 219       "static" : false,
 220       "memberOf" : "Roo.bootstrap.Component",
 221       "isStatic" : false,
 222       "isConstructor" : false,
 223       "isPrivate" : false,
 224       "example" : "",
 225       "deprecated" : "",
 226       "since" : "",
 227       "see" : "",
 228       "exceptions" : "",
 229       "requires" : "",
 230       "params" : [],
 231       "returns" : []
 232     },
 233     {
 234       "name" : "getVisibilityEl",
 235       "type" : "function",
 236       "desc" : "Get the element that will be used to show or hide",
 237       "sig" : "()\n{\n\n}",
 238       "static" : false,
 239       "memberOf" : "Roo.bootstrap.Component",
 240       "isStatic" : false,
 241       "isConstructor" : false,
 242       "isPrivate" : false,
 243       "example" : "",
 244       "deprecated" : "",
 245       "since" : "",
 246       "see" : "",
 247       "exceptions" : "",
 248       "requires" : "",
 249       "params" : [],
 250       "returns" : []
 251     },
 252     {
 253       "name" : "initEvents",
 254       "type" : "function",
 255       "desc" : "Initialize Events for the element",
 256       "sig" : "()\n{\n\n}",
 257       "static" : false,
 258       "memberOf" : "Roo.bootstrap.Component",
 259       "isStatic" : false,
 260       "isConstructor" : false,
 261       "isPrivate" : false,
 262       "example" : "",
 263       "deprecated" : "",
 264       "since" : "",
 265       "see" : "",
 266       "exceptions" : "",
 267       "requires" : "",
 268       "params" : [],
 269       "returns" : []
 270     },
 271     {
 272       "name" : "getChildContainer",
 273       "type" : "function",
 274       "desc" : "Fetch the element to add children to",
 275       "sig" : "()\n{\n\n}",
 276       "static" : false,
 277       "memberOf" : "Roo.bootstrap.Component",
 278       "isStatic" : false,
 279       "isConstructor" : false,
 280       "isPrivate" : false,
 281       "example" : "",
 282       "deprecated" : "",
 283       "since" : "",
 284       "see" : "",
 285       "exceptions" : "",
 286       "requires" : "",
 287       "params" : [],
 288       "returns" : [
 289         {
 290           "name" : "",
 291           "type" : "Roo.Element",
 292           "desc" : "defaults to this.el"
 293         }
 294       ]
 295     },
 296     {
 297       "name" : "getId",
 298       "type" : "function",
 299       "desc" : "Returns the id of this component.",
 300       "sig" : "()\n{\n\n}",
 301       "static" : false,
 302       "memberOf" : "Roo.Component",
 303       "isStatic" : false,
 304       "isConstructor" : false,
 305       "isPrivate" : false,
 306       "example" : "",
 307       "deprecated" : "",
 308       "since" : "",
 309       "see" : "",
 310       "exceptions" : "",
 311       "requires" : "",
 312       "params" : [],
 313       "returns" : [
 314         {
 315           "name" : "",
 316           "type" : "String",
 317           "desc" : ""
 318         }
 319       ]
 320     },
 321     {
 322       "name" : "render",
 323       "type" : "function",
 324       "desc" : "If this is a lazy rendering component, render it to its container element.",
 325       "sig" : "(container)",
 326       "static" : false,
 327       "memberOf" : "Roo.Component",
 328       "isStatic" : false,
 329       "isConstructor" : false,
 330       "isPrivate" : false,
 331       "example" : "",
 332       "deprecated" : "",
 333       "since" : "",
 334       "see" : "",
 335       "exceptions" : "",
 336       "requires" : "",
 337       "params" : [
 338         {
 339           "name" : "container",
 340           "type" : "String/HTMLElement/Element",
 341           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 342           "isOptional" : false
 343         }
 344       ],
 345       "returns" : []
 346     },
 347     {
 348       "name" : "destroy",
 349       "type" : "function",
 350       "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
 351       "sig" : "()\n{\n\n}",
 352       "static" : false,
 353       "memberOf" : "Roo.Component",
 354       "isStatic" : false,
 355       "isConstructor" : false,
 356       "isPrivate" : false,
 357       "example" : "",
 358       "deprecated" : "",
 359       "since" : "",
 360       "see" : "",
 361       "exceptions" : "",
 362       "requires" : "",
 363       "params" : [],
 364       "returns" : []
 365     },
 366     {
 367       "name" : "isVisible",
 368       "type" : "function",
 369       "desc" : "Returns true if this component is visible.",
 370       "sig" : "()\n{\n\n}",
 371       "static" : false,
 372       "memberOf" : "Roo.Component",
 373       "isStatic" : false,
 374       "isConstructor" : false,
 375       "isPrivate" : false,
 376       "example" : "",
 377       "deprecated" : "",
 378       "since" : "",
 379       "see" : "",
 380       "exceptions" : "",
 381       "requires" : "",
 382       "params" : [],
 383       "returns" : []
 384     },
 385     {
 386       "name" : "setDisabled",
 387       "type" : "function",
 388       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 389       "sig" : "(disabled)",
 390       "static" : false,
 391       "memberOf" : "Roo.Component",
 392       "isStatic" : false,
 393       "isConstructor" : false,
 394       "isPrivate" : false,
 395       "example" : "",
 396       "deprecated" : "",
 397       "since" : "",
 398       "see" : "",
 399       "exceptions" : "",
 400       "requires" : "",
 401       "params" : [
 402         {
 403           "name" : "disabled",
 404           "type" : "Boolean",
 405           "desc" : "",
 406           "isOptional" : false
 407         }
 408       ],
 409       "returns" : []
 410     },
 411     {
 412       "name" : "focus",
 413       "type" : "function",
 414       "desc" : "Try to focus this component.",
 415       "sig" : "(selectText)",
 416       "static" : false,
 417       "memberOf" : "Roo.Component",
 418       "isStatic" : false,
 419       "isConstructor" : false,
 420       "isPrivate" : false,
 421       "example" : "",
 422       "deprecated" : "",
 423       "since" : "",
 424       "see" : "",
 425       "exceptions" : "",
 426       "requires" : "",
 427       "params" : [
 428         {
 429           "name" : "selectText",
 430           "type" : "Boolean",
 431           "desc" : "True to also select the text in this component (if applicable)",
 432           "isOptional" : false
 433         }
 434       ],
 435       "returns" : [
 436         {
 437           "name" : "",
 438           "type" : "Roo.Component",
 439           "desc" : "this"
 440         }
 441       ]
 442     },
 443     {
 444       "name" : "enable",
 445       "type" : "function",
 446       "desc" : "Enable this component.",
 447       "sig" : "()\n{\n\n}",
 448       "static" : false,
 449       "memberOf" : "Roo.Component",
 450       "isStatic" : false,
 451       "isConstructor" : false,
 452       "isPrivate" : false,
 453       "example" : "",
 454       "deprecated" : "",
 455       "since" : "",
 456       "see" : "",
 457       "exceptions" : "",
 458       "requires" : "",
 459       "params" : [],
 460       "returns" : [
 461         {
 462           "name" : "",
 463           "type" : "Roo.Component",
 464           "desc" : "this"
 465         }
 466       ]
 467     },
 468     {
 469       "name" : "setVisible",
 470       "type" : "function",
 471       "desc" : "Convenience function to hide or show this component by boolean.",
 472       "sig" : "(visible)",
 473       "static" : false,
 474       "memberOf" : "Roo.Component",
 475       "isStatic" : false,
 476       "isConstructor" : false,
 477       "isPrivate" : false,
 478       "example" : "",
 479       "deprecated" : "",
 480       "since" : "",
 481       "see" : "",
 482       "exceptions" : "",
 483       "requires" : "",
 484       "params" : [
 485         {
 486           "name" : "visible",
 487           "type" : "Boolean",
 488           "desc" : "True to show, false to hide",
 489           "isOptional" : false
 490         }
 491       ],
 492       "returns" : [
 493         {
 494           "name" : "",
 495           "type" : "Roo.Component",
 496           "desc" : "this"
 497         }
 498       ]
 499     },
 500     {
 501       "name" : "disable",
 502       "type" : "function",
 503       "desc" : "Disable this component.",
 504       "sig" : "()\n{\n\n}",
 505       "static" : false,
 506       "memberOf" : "Roo.Component",
 507       "isStatic" : false,
 508       "isConstructor" : false,
 509       "isPrivate" : false,
 510       "example" : "",
 511       "deprecated" : "",
 512       "since" : "",
 513       "see" : "",
 514       "exceptions" : "",
 515       "requires" : "",
 516       "params" : [],
 517       "returns" : [
 518         {
 519           "name" : "",
 520           "type" : "Roo.Component",
 521           "desc" : "this"
 522         }
 523       ]
 524     },
 525     {
 526       "name" : "getEl",
 527       "type" : "function",
 528       "desc" : "Returns the underlying {@link Roo.Element}.",
 529       "sig" : "()\n{\n\n}",
 530       "static" : false,
 531       "memberOf" : "Roo.Component",
 532       "isStatic" : false,
 533       "isConstructor" : false,
 534       "isPrivate" : false,
 535       "example" : "",
 536       "deprecated" : "",
 537       "since" : "",
 538       "see" : "",
 539       "exceptions" : "",
 540       "requires" : "",
 541       "params" : [],
 542       "returns" : [
 543         {
 544           "name" : "",
 545           "type" : "Roo.Element",
 546           "desc" : "The element"
 547         }
 548       ]
 549     },
 550     {
 551       "name" : "purgeListeners",
 552       "type" : "function",
 553       "desc" : "Removes all listeners for this object",
 554       "sig" : "()\n{\n\n}",
 555       "static" : false,
 556       "memberOf" : "Roo.util.Observable",
 557       "isStatic" : false,
 558       "isConstructor" : false,
 559       "isPrivate" : false,
 560       "example" : "",
 561       "deprecated" : "",
 562       "since" : "",
 563       "see" : "",
 564       "exceptions" : "",
 565       "requires" : "",
 566       "params" : [],
 567       "returns" : []
 568     },
 569     {
 570       "name" : "on",
 571       "type" : "function",
 572       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 573       "sig" : "(eventName, handler, scope, options)",
 574       "static" : false,
 575       "memberOf" : "Roo.util.Observable",
 576       "isStatic" : false,
 577       "isConstructor" : false,
 578       "isPrivate" : false,
 579       "example" : "",
 580       "deprecated" : "",
 581       "since" : "",
 582       "see" : "",
 583       "exceptions" : "",
 584       "requires" : "",
 585       "params" : [
 586         {
 587           "name" : "eventName",
 588           "type" : "String",
 589           "desc" : "The type of event to listen for",
 590           "isOptional" : false
 591         },
 592         {
 593           "name" : "handler",
 594           "type" : "Function",
 595           "desc" : "The method the event invokes",
 596           "isOptional" : false
 597         },
 598         {
 599           "name" : "scope",
 600           "type" : "Object",
 601           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 602           "isOptional" : false
 603         },
 604         {
 605           "name" : "options",
 606           "type" : "Object",
 607           "desc" : "(optional)",
 608           "isOptional" : false
 609         }
 610       ],
 611       "returns" : []
 612     },
 613     {
 614       "name" : "un",
 615       "type" : "function",
 616       "desc" : "Removes a listener (shorthand for removeListener)",
 617       "sig" : "(eventName, handler, scope)",
 618       "static" : false,
 619       "memberOf" : "Roo.util.Observable",
 620       "isStatic" : false,
 621       "isConstructor" : false,
 622       "isPrivate" : false,
 623       "example" : "",
 624       "deprecated" : "",
 625       "since" : "",
 626       "see" : "",
 627       "exceptions" : "",
 628       "requires" : "",
 629       "params" : [
 630         {
 631           "name" : "eventName",
 632           "type" : "String",
 633           "desc" : "The type of event to listen for",
 634           "isOptional" : false
 635         },
 636         {
 637           "name" : "handler",
 638           "type" : "Function",
 639           "desc" : "The handler to remove",
 640           "isOptional" : false
 641         },
 642         {
 643           "name" : "scope",
 644           "type" : "Object",
 645           "desc" : "(optional) The scope (this object) for the handler",
 646           "isOptional" : false
 647         }
 648       ],
 649       "returns" : []
 650     },
 651     {
 652       "name" : "addEvents",
 653       "type" : "function",
 654       "desc" : "Used to define events on this Observable",
 655       "sig" : "(object)",
 656       "static" : false,
 657       "memberOf" : "Roo.util.Observable",
 658       "isStatic" : false,
 659       "isConstructor" : false,
 660       "isPrivate" : false,
 661       "example" : "",
 662       "deprecated" : "",
 663       "since" : "",
 664       "see" : "",
 665       "exceptions" : "",
 666       "requires" : "",
 667       "params" : [
 668         {
 669           "name" : "object",
 670           "type" : "Object",
 671           "desc" : "The object with the events defined",
 672           "isOptional" : false
 673         }
 674       ],
 675       "returns" : []
 676     },
 677     {
 678       "name" : "releaseCapture",
 679       "type" : "function",
 680       "desc" : "Removes <b>all</b> added captures from the Observable.",
 681       "sig" : "(o)",
 682       "static" : true,
 683       "memberOf" : "Roo.util.Observable",
 684       "isStatic" : true,
 685       "isConstructor" : false,
 686       "isPrivate" : false,
 687       "example" : "",
 688       "deprecated" : "",
 689       "since" : "",
 690       "see" : "",
 691       "exceptions" : "",
 692       "requires" : "",
 693       "params" : [
 694         {
 695           "name" : "o",
 696           "type" : "Observable",
 697           "desc" : "The Observable to release",
 698           "isOptional" : false
 699         }
 700       ],
 701       "returns" : []
 702     },
 703     {
 704       "name" : "removeListener",
 705       "type" : "function",
 706       "desc" : "Removes a listener",
 707       "sig" : "(eventName, handler, scope)",
 708       "static" : false,
 709       "memberOf" : "Roo.util.Observable",
 710       "isStatic" : false,
 711       "isConstructor" : false,
 712       "isPrivate" : false,
 713       "example" : "",
 714       "deprecated" : "",
 715       "since" : "",
 716       "see" : "",
 717       "exceptions" : "",
 718       "requires" : "",
 719       "params" : [
 720         {
 721           "name" : "eventName",
 722           "type" : "String",
 723           "desc" : "The type of event to listen for",
 724           "isOptional" : false
 725         },
 726         {
 727           "name" : "handler",
 728           "type" : "Function",
 729           "desc" : "The handler to remove",
 730           "isOptional" : false
 731         },
 732         {
 733           "name" : "scope",
 734           "type" : "Object",
 735           "desc" : "(optional) The scope (this object) for the handler",
 736           "isOptional" : false
 737         }
 738       ],
 739       "returns" : []
 740     },
 741     {
 742       "name" : "fireEvent",
 743       "type" : "function",
 744       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 745       "sig" : "(eventName, args)",
 746       "static" : false,
 747       "memberOf" : "Roo.util.Observable",
 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" : "eventName",
 760           "type" : "String",
 761           "desc" : "",
 762           "isOptional" : false
 763         },
 764         {
 765           "name" : "args",
 766           "type" : "Object...",
 767           "desc" : "Variable number of parameters are passed to handlers",
 768           "isOptional" : false
 769         }
 770       ],
 771       "returns" : [
 772         {
 773           "name" : "",
 774           "type" : "Boolean",
 775           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 776         }
 777       ]
 778     },
 779     {
 780       "name" : "hasListener",
 781       "type" : "function",
 782       "desc" : "Checks to see if this object has any listeners for a specified event",
 783       "sig" : "(eventName)",
 784       "static" : false,
 785       "memberOf" : "Roo.util.Observable",
 786       "isStatic" : false,
 787       "isConstructor" : false,
 788       "isPrivate" : false,
 789       "example" : "",
 790       "deprecated" : "",
 791       "since" : "",
 792       "see" : "",
 793       "exceptions" : "",
 794       "requires" : "",
 795       "params" : [
 796         {
 797           "name" : "eventName",
 798           "type" : "String",
 799           "desc" : "The name of the event to check for",
 800           "isOptional" : false
 801         }
 802       ],
 803       "returns" : [
 804         {
 805           "name" : "",
 806           "type" : "Boolean",
 807           "desc" : "True if the event is being listened for, else false"
 808         }
 809       ]
 810     },
 811     {
 812       "name" : "capture",
 813       "type" : "function",
 814       "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.",
 815       "sig" : "(o, fn, scope)",
 816       "static" : true,
 817       "memberOf" : "Roo.util.Observable",
 818       "isStatic" : true,
 819       "isConstructor" : false,
 820       "isPrivate" : false,
 821       "example" : "",
 822       "deprecated" : "",
 823       "since" : "",
 824       "see" : "",
 825       "exceptions" : "",
 826       "requires" : "",
 827       "params" : [
 828         {
 829           "name" : "o",
 830           "type" : "Observable",
 831           "desc" : "The Observable to capture",
 832           "isOptional" : false
 833         },
 834         {
 835           "name" : "fn",
 836           "type" : "Function",
 837           "desc" : "The function to call",
 838           "isOptional" : false
 839         },
 840         {
 841           "name" : "scope",
 842           "type" : "Object",
 843           "desc" : "(optional) The scope (this object) for the fn",
 844           "isOptional" : false
 845         }
 846       ],
 847       "returns" : []
 848     },
 849     {
 850       "name" : "addListener",
 851       "type" : "function",
 852       "desc" : "Appends an event handler to this component",
 853       "sig" : "(eventName, handler, scope, options)",
 854       "static" : false,
 855       "memberOf" : "Roo.util.Observable",
 856       "isStatic" : false,
 857       "isConstructor" : false,
 858       "isPrivate" : false,
 859       "example" : "",
 860       "deprecated" : "",
 861       "since" : "",
 862       "see" : "",
 863       "exceptions" : "",
 864       "requires" : "",
 865       "params" : [
 866         {
 867           "name" : "eventName",
 868           "type" : "String",
 869           "desc" : "The type of event to listen for",
 870           "isOptional" : false
 871         },
 872         {
 873           "name" : "handler",
 874           "type" : "Function",
 875           "desc" : "The method the event invokes",
 876           "isOptional" : false
 877         },
 878         {
 879           "name" : "scope",
 880           "type" : "Object",
 881           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 882           "isOptional" : false
 883         },
 884         {
 885           "name" : "options",
 886           "type" : "Object",
 887           "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>",
 888           "isOptional" : false
 889         }
 890       ],
 891       "returns" : []
 892     }
 893   ],
 894   "events" : [
 895     {
 896       "name" : "click",
 897       "type" : "function",
 898       "desc" : "When a element is chick",
 899       "sig" : "function (_self, e)\n{\n\n}",
 900       "memberOf" : "",
 901       "example" : "",
 902       "deprecated" : "",
 903       "since" : "",
 904       "see" : "",
 905       "params" : [
 906         {
 907           "name" : "this",
 908           "type" : "Roo.bootstrap.Element",
 909           "desc" : "",
 910           "isOptional" : false
 911         },
 912         {
 913           "name" : "e",
 914           "type" : "Roo.EventObject",
 915           "desc" : "",
 916           "isOptional" : false
 917         }
 918       ],
 919       "returns" : []
 920     },
 921     {
 922       "name" : "childrenrendered",
 923       "type" : "function",
 924       "desc" : "Fires when the children have been rendered..",
 925       "sig" : "function (_self)\n{\n\n}",
 926       "memberOf" : "Roo.bootstrap.Component",
 927       "example" : "",
 928       "deprecated" : "",
 929       "since" : "",
 930       "see" : "",
 931       "params" : [
 932         {
 933           "name" : "this",
 934           "type" : "Roo.bootstrap.Component",
 935           "desc" : "",
 936           "isOptional" : false
 937         }
 938       ],
 939       "returns" : []
 940     },
 941     {
 942       "name" : "beforerender",
 943       "type" : "function",
 944       "desc" : "Fires before the component is rendered. Return false to stop the render.",
 945       "sig" : "function (_self)\n{\n\n}",
 946       "memberOf" : "Roo.Component",
 947       "example" : "",
 948       "deprecated" : "",
 949       "since" : "",
 950       "see" : "",
 951       "params" : [
 952         {
 953           "name" : "this",
 954           "type" : "Roo.Component",
 955           "desc" : "",
 956           "isOptional" : false
 957         }
 958       ],
 959       "returns" : []
 960     },
 961     {
 962       "name" : "disable",
 963       "type" : "function",
 964       "desc" : "Fires after the component is disabled.",
 965       "sig" : "function (_self)\n{\n\n}",
 966       "memberOf" : "Roo.Component",
 967       "example" : "",
 968       "deprecated" : "",
 969       "since" : "",
 970       "see" : "",
 971       "params" : [
 972         {
 973           "name" : "this",
 974           "type" : "Roo.Component",
 975           "desc" : "",
 976           "isOptional" : false
 977         }
 978       ],
 979       "returns" : []
 980     },
 981     {
 982       "name" : "render",
 983       "type" : "function",
 984       "desc" : "Fires after the component is rendered.",
 985       "sig" : "function (_self)\n{\n\n}",
 986       "memberOf" : "Roo.Component",
 987       "example" : "",
 988       "deprecated" : "",
 989       "since" : "",
 990       "see" : "",
 991       "params" : [
 992         {
 993           "name" : "this",
 994           "type" : "Roo.Component",
 995           "desc" : "",
 996           "isOptional" : false
 997         }
 998       ],
 999       "returns" : []
1000     },
1001     {
1002       "name" : "destroy",
1003       "type" : "function",
1004       "desc" : "Fires after the component is destroyed.",
1005       "sig" : "function (_self)\n{\n\n}",
1006       "memberOf" : "Roo.Component",
1007       "example" : "",
1008       "deprecated" : "",
1009       "since" : "",
1010       "see" : "",
1011       "params" : [
1012         {
1013           "name" : "this",
1014           "type" : "Roo.Component",
1015           "desc" : "",
1016           "isOptional" : false
1017         }
1018       ],
1019       "returns" : []
1020     },
1021     {
1022       "name" : "hide",
1023       "type" : "function",
1024       "desc" : "Fires after the component is hidden.",
1025       "sig" : "function (_self)\n{\n\n}",
1026       "memberOf" : "Roo.Component",
1027       "example" : "",
1028       "deprecated" : "",
1029       "since" : "",
1030       "see" : "",
1031       "params" : [
1032         {
1033           "name" : "this",
1034           "type" : "Roo.Component",
1035           "desc" : "",
1036           "isOptional" : false
1037         }
1038       ],
1039       "returns" : []
1040     },
1041     {
1042       "name" : "beforehide",
1043       "type" : "function",
1044       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1045       "sig" : "function (_self)\n{\n\n}",
1046       "memberOf" : "Roo.Component",
1047       "example" : "",
1048       "deprecated" : "",
1049       "since" : "",
1050       "see" : "",
1051       "params" : [
1052         {
1053           "name" : "this",
1054           "type" : "Roo.Component",
1055           "desc" : "",
1056           "isOptional" : false
1057         }
1058       ],
1059       "returns" : []
1060     },
1061     {
1062       "name" : "show",
1063       "type" : "function",
1064       "desc" : "Fires after the component is shown.",
1065       "sig" : "function (_self)\n{\n\n}",
1066       "memberOf" : "Roo.Component",
1067       "example" : "",
1068       "deprecated" : "",
1069       "since" : "",
1070       "see" : "",
1071       "params" : [
1072         {
1073           "name" : "this",
1074           "type" : "Roo.Component",
1075           "desc" : "",
1076           "isOptional" : false
1077         }
1078       ],
1079       "returns" : []
1080     },
1081     {
1082       "name" : "beforeshow",
1083       "type" : "function",
1084       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1085       "sig" : "function (_self)\n{\n\n}",
1086       "memberOf" : "Roo.Component",
1087       "example" : "",
1088       "deprecated" : "",
1089       "since" : "",
1090       "see" : "",
1091       "params" : [
1092         {
1093           "name" : "this",
1094           "type" : "Roo.Component",
1095           "desc" : "",
1096           "isOptional" : false
1097         }
1098       ],
1099       "returns" : []
1100     },
1101     {
1102       "name" : "enable",
1103       "type" : "function",
1104       "desc" : "Fires after the component is enabled.",
1105       "sig" : "function (_self)\n{\n\n}",
1106       "memberOf" : "Roo.Component",
1107       "example" : "",
1108       "deprecated" : "",
1109       "since" : "",
1110       "see" : "",
1111       "params" : [
1112         {
1113           "name" : "this",
1114           "type" : "Roo.Component",
1115           "desc" : "",
1116           "isOptional" : false
1117         }
1118       ],
1119       "returns" : []
1120     },
1121     {
1122       "name" : "beforedestroy",
1123       "type" : "function",
1124       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1125       "sig" : "function (_self)\n{\n\n}",
1126       "memberOf" : "Roo.Component",
1127       "example" : "",
1128       "deprecated" : "",
1129       "since" : "",
1130       "see" : "",
1131       "params" : [
1132         {
1133           "name" : "this",
1134           "type" : "Roo.Component",
1135           "desc" : "",
1136           "isOptional" : false
1137         }
1138       ],
1139       "returns" : []
1140     }
1141   ]
1142 }