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

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