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

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