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