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