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