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

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