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