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