git.roojs.org Git - roojs1/blob - docs/symbols/Roo.BorderLayout.json

   1 {
   2   "name" : "Roo.BorderLayout",
   3   "augments" : [
   4     "Roo.LayoutManager",
   5     "Roo.util.Observable"
   6   ],
   7   "childClasses" : {
   8     "Roo.BorderLayout" : [
   9       "Roo.ReaderLayout"
  10     ]
  11   },
  12   "tree_children" : [
  13     "Roo.ContentPanel",
  14     "Roo.GridPanel",
  15     "Roo.NestedLayoutPanel",
  16     "Roo.TreePanel"
  17   ],
  18   "tree_parent" : [],
  19   "desc" : "This class represents a common layout manager used in desktop applications. For screenshots and more details,\nplease see: <br><br>\n<a href=\"http://www.jackslocum.com/yui/2006/10/19/cross-browser-web-20-layouts-with-yahoo-ui/\">Cross Browser Layouts - Part 1</a><br>\n<a href=\"http://www.jackslocum.com/yui/2006/10/28/cross-browser-web-20-layouts-part-2-ajax-feed-viewer-20/\">Cross Browser Layouts - Part 2</a><br><br>\nExample:\n <pre><code>\n var layout = new Roo.BorderLayout(document.body, {\n    north: {\n        initialSize: 25,\n        titlebar: false\n    },\n    west: {\n        split:true,\n        initialSize: 200,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true\n    },\n    east: {\n        split:true,\n        initialSize: 202,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true\n    },\n    south: {\n        split:true,\n        initialSize: 100,\n        minSize: 100,\n        maxSize: 200,\n        titlebar: true,\n        collapsible: true\n    },\n    center: {\n        titlebar: true,\n        autoScroll:true,\n        resizeTabs: true,\n        minTabWidth: 50,\n        preferredTabWidth: 150\n    }\n});\n\n// shorthand\nvar CP = Roo.ContentPanel;\n\nlayout.beginUpdate();\nlayout.add(\"north\", new CP(\"north\", \"North\"));\nlayout.add(\"south\", new CP(\"south\", {title: \"South\", closable: true}));\nlayout.add(\"west\", new CP(\"west\", {title: \"West\"}));\nlayout.add(\"east\", new CP(\"autoTabs\", {title: \"Auto Tabs\", closable: true}));\nlayout.add(\"center\", new CP(\"center1\", {title: \"Close Me\", closable: true}));\nlayout.add(\"center\", new CP(\"center2\", {title: \"Center Panel\", closable: false}));\nlayout.getRegion(\"center\").showPanel(\"center1\");\nlayout.endUpdate();\n</code></pre>\n\n<b>The container the layout is rendered into can be either the body element or any other element.\nIf it is not the body element, the container needs to either be an absolute positioned element,\nor you will need to add \"position:relative\" to the css of the container.  You will also need to specify\nthe container size if it is not the body element.</b>",
  20   "isSingleton" : false,
  21   "isStatic" : false,
  22   "isBuiltin" : false,
  23   "isAbstract" : false,
  24   "isBuilderTop" : false,
  25   "memberOf" : "BorderLayout",
  26   "example" : "",
  27   "deprecated" : "",
  28   "since" : "",
  29   "see" : "",
  30   "params" : [
  31     {
  32       "name" : "container",
  33       "type" : "String/HTMLElement/Element",
  34       "desc" : "The container this layout is bound to",
  35       "isOptional" : false
  36     },
  37     {
  38       "name" : "config",
  39       "type" : "Object",
  40       "desc" : "Configuration options",
  41       "isOptional" : false
  42     }
  43   ],
  44   "returns" : [],
  45   "throws" : "",
  46   "requires" : "",
  47   "config" : [
  48     {
  49       "name" : "center",
  50       "type" : "Roo.LayoutRegion",
  51       "desc" : "",
  52       "memberOf" : "Roo.BorderLayout"
  53     },
  54     {
  55       "name" : "listeners",
  56       "type" : "Object",
  57       "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>",
  58       "memberOf" : "Roo.util.Observable"
  59     },
  60     {
  61       "name" : "east",
  62       "type" : "Roo.LayoutRegion",
  63       "desc" : "",
  64       "memberOf" : "Roo.BorderLayout"
  65     },
  66     {
  67       "name" : "west",
  68       "type" : "Roo.LayoutRegion",
  69       "desc" : "",
  70       "memberOf" : "Roo.BorderLayout"
  71     },
  72     {
  73       "name" : "north",
  74       "type" : "Roo.LayoutRegion",
  75       "desc" : "",
  76       "memberOf" : "Roo.BorderLayout"
  77     },
  78     {
  79       "name" : "south",
  80       "type" : "Roo.LayoutRegion",
  81       "desc" : "",
  82       "memberOf" : "Roo.BorderLayout"
  83     }
  84   ],
  85   "methods" : [
  86     {
  87       "name" : "create",
  88       "type" : "function",
  89       "desc" : "Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling\nthe beginUpdate and endUpdate calls internally.  The key to this method is the <b>panels</b> property that can be\nprovided with each region config, which allows you to add ContentPanel configs in addition to the region configs\nduring creation.  The following code is equivalent to the constructor-based example at the beginning of this class:\n<pre><code>\n// shorthand\nvar CP = Roo.ContentPanel;\n\nvar layout = Roo.BorderLayout.create({\n    north: {\n        initialSize: 25,\n        titlebar: false,\n        panels: [new CP(\"north\", \"North\")]\n    },\n    west: {\n        split:true,\n        initialSize: 200,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"west\", {title: \"West\"})]\n    },\n    east: {\n        split:true,\n        initialSize: 202,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"autoTabs\", {title: \"Auto Tabs\", closable: true})]\n    },\n    south: {\n        split:true,\n        initialSize: 100,\n        minSize: 100,\n        maxSize: 200,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"south\", {title: \"South\", closable: true})]\n    },\n    center: {\n        titlebar: true,\n        autoScroll:true,\n        resizeTabs: true,\n        minTabWidth: 50,\n        preferredTabWidth: 150,\n        panels: [\n            new CP(\"center1\", {title: \"Close Me\", closable: true}),\n            new CP(\"center2\", {title: \"Center Panel\", closable: false})\n        ]\n    }\n}, document.body);\n\nlayout.getRegion(\"center\").showPanel(\"center1\");\n</code></pre>",
  90       "sig" : "(config, targetEl)",
  91       "static" : true,
  92       "memberOf" : "",
  93       "isStatic" : true,
  94       "isConstructor" : false,
  95       "isPrivate" : false,
  96       "example" : "",
  97       "deprecated" : "",
  98       "since" : "",
  99       "see" : "",
 100       "exceptions" : "",
 101       "requires" : "",
 102       "params" : [
 103         {
 104           "name" : "config",
 105           "type" : "",
 106           "desc" : "",
 107           "isOptional" : false
 108         },
 109         {
 110           "name" : "targetEl",
 111           "type" : "",
 112           "desc" : "",
 113           "isOptional" : false
 114         }
 115       ],
 116       "returns" : []
 117     },
 118     {
 119       "name" : "restoreState",
 120       "type" : "function",
 121       "desc" : "Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.",
 122       "sig" : "(provider)",
 123       "static" : false,
 124       "memberOf" : "",
 125       "isStatic" : false,
 126       "isConstructor" : false,
 127       "isPrivate" : false,
 128       "example" : "",
 129       "deprecated" : "",
 130       "since" : "",
 131       "see" : "",
 132       "exceptions" : "",
 133       "requires" : "",
 134       "params" : [
 135         {
 136           "name" : "provider",
 137           "type" : "Roo.state.Provider",
 138           "desc" : "(optional) An alternate state provider",
 139           "isOptional" : false
 140         }
 141       ],
 142       "returns" : []
 143     },
 144     {
 145       "name" : "addRegion",
 146       "type" : "function",
 147       "desc" : "Creates and adds a new region if it doesn't already exist.",
 148       "sig" : "(target, config)",
 149       "static" : false,
 150       "memberOf" : "",
 151       "isStatic" : false,
 152       "isConstructor" : false,
 153       "isPrivate" : false,
 154       "example" : "",
 155       "deprecated" : "",
 156       "since" : "",
 157       "see" : "",
 158       "exceptions" : "",
 159       "requires" : "",
 160       "params" : [
 161         {
 162           "name" : "target",
 163           "type" : "String",
 164           "desc" : "The target region key (north, south, east, west or center).",
 165           "isOptional" : false
 166         },
 167         {
 168           "name" : "config",
 169           "type" : "Object",
 170           "desc" : "The regions config object",
 171           "isOptional" : false
 172         }
 173       ],
 174       "returns" : [
 175         {
 176           "name" : "",
 177           "type" : "BorderLayoutRegion",
 178           "desc" : "The new region"
 179         }
 180       ]
 181     },
 182     {
 183       "name" : "showPanel",
 184       "type" : "function",
 185       "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
 186       "sig" : "(panelId)",
 187       "static" : false,
 188       "memberOf" : "",
 189       "isStatic" : false,
 190       "isConstructor" : false,
 191       "isPrivate" : false,
 192       "example" : "",
 193       "deprecated" : "",
 194       "since" : "",
 195       "see" : "",
 196       "exceptions" : "",
 197       "requires" : "",
 198       "params" : [
 199         {
 200           "name" : "panelId",
 201           "type" : "String/ContentPanel",
 202           "desc" : "The panels id or the panel itself",
 203           "isOptional" : false
 204         }
 205       ],
 206       "returns" : [
 207         {
 208           "name" : "",
 209           "type" : "Roo.ContentPanel",
 210           "desc" : "The shown panel or null"
 211         }
 212       ]
 213     },
 214     {
 215       "name" : "batchAdd",
 216       "type" : "function",
 217       "desc" : "Adds a batch of multiple ContentPanels dynamically by passing a special regions config object.  This config\nobject should contain properties for each region to add ContentPanels to, and each property's value should be\na valid ContentPanel config object.  Example:\n<pre><code>\n// Create the main layout\nvar layout = new Roo.BorderLayout('main-ct', {\n    west: {\n        split:true,\n        minSize: 175,\n        titlebar: true\n    },\n    center: {\n        title:'Components'\n    }\n}, 'main-ct');\n\n// Create and add multiple ContentPanels at once via configs\nlayout.batchAdd({\n   west: {\n       id: 'source-files',\n       autoCreate:true,\n       title:'Ext Source Files',\n       autoScroll:true,\n       fitToFrame:true\n   },\n   center : {\n       el: cview,\n       autoScroll:true,\n       fitToFrame:true,\n       toolbar: tb,\n       resizeEl:'cbody'\n   }\n});\n</code></pre>",
 218       "sig" : "(regions)",
 219       "static" : false,
 220       "memberOf" : "",
 221       "isStatic" : false,
 222       "isConstructor" : false,
 223       "isPrivate" : false,
 224       "example" : "",
 225       "deprecated" : "",
 226       "since" : "",
 227       "see" : "",
 228       "exceptions" : "",
 229       "requires" : "",
 230       "params" : [
 231         {
 232           "name" : "regions",
 233           "type" : "Object",
 234           "desc" : "An object containing ContentPanel configs by region name",
 235           "isOptional" : false
 236         }
 237       ],
 238       "returns" : []
 239     },
 240     {
 241       "name" : "remove",
 242       "type" : "function",
 243       "desc" : "Remove a ContentPanel (or subclass) to this layout.",
 244       "sig" : "(target, panel)",
 245       "static" : false,
 246       "memberOf" : "",
 247       "isStatic" : false,
 248       "isConstructor" : false,
 249       "isPrivate" : false,
 250       "example" : "",
 251       "deprecated" : "",
 252       "since" : "",
 253       "see" : "",
 254       "exceptions" : "",
 255       "requires" : "",
 256       "params" : [
 257         {
 258           "name" : "target",
 259           "type" : "String",
 260           "desc" : "The target region key (north, south, east, west or center).",
 261           "isOptional" : false
 262         },
 263         {
 264           "name" : "panel",
 265           "type" : "Number/String/Roo.ContentPanel",
 266           "desc" : "The index, id or panel to remove",
 267           "isOptional" : false
 268         }
 269       ],
 270       "returns" : [
 271         {
 272           "name" : "",
 273           "type" : "Roo.ContentPanel",
 274           "desc" : "The removed panel"
 275         }
 276       ]
 277     },
 278     {
 279       "name" : "findPanel",
 280       "type" : "function",
 281       "desc" : "Searches all regions for a panel with the specified id",
 282       "sig" : "(panelId)",
 283       "static" : false,
 284       "memberOf" : "",
 285       "isStatic" : false,
 286       "isConstructor" : false,
 287       "isPrivate" : false,
 288       "example" : "",
 289       "deprecated" : "",
 290       "since" : "",
 291       "see" : "",
 292       "exceptions" : "",
 293       "requires" : "",
 294       "params" : [
 295         {
 296           "name" : "panelId",
 297           "type" : "String",
 298           "desc" : "",
 299           "isOptional" : false
 300         }
 301       ],
 302       "returns" : [
 303         {
 304           "name" : "",
 305           "type" : "Roo.ContentPanel",
 306           "desc" : "The panel or null if it wasn't found"
 307         }
 308       ]
 309     },
 310     {
 311       "name" : "layout",
 312       "type" : "function",
 313       "desc" : "Performs a layout update.",
 314       "sig" : "()\n{\n\n}",
 315       "static" : false,
 316       "memberOf" : "",
 317       "isStatic" : false,
 318       "isConstructor" : false,
 319       "isPrivate" : false,
 320       "example" : "",
 321       "deprecated" : "",
 322       "since" : "",
 323       "see" : "",
 324       "exceptions" : "",
 325       "requires" : "",
 326       "params" : [],
 327       "returns" : []
 328     },
 329     {
 330       "name" : "addxtype",
 331       "type" : "function",
 332       "desc" : "Adds a xtype elements to the layout.\n<pre><code>\n\nlayout.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\nlayout.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n</code></pre>",
 333       "sig" : "(cfg)",
 334       "static" : false,
 335       "memberOf" : "",
 336       "isStatic" : false,
 337       "isConstructor" : false,
 338       "isPrivate" : false,
 339       "example" : "",
 340       "deprecated" : "",
 341       "since" : "",
 342       "see" : "",
 343       "exceptions" : "",
 344       "requires" : "",
 345       "params" : [
 346         {
 347           "name" : "cfg",
 348           "type" : "Object",
 349           "desc" : "Xtype definition of item to add.",
 350           "isOptional" : false
 351         }
 352       ],
 353       "returns" : []
 354     },
 355     {
 356       "name" : "add",
 357       "type" : "function",
 358       "desc" : "Adds a ContentPanel (or subclass) to this layout.",
 359       "sig" : "(target, panel)",
 360       "static" : false,
 361       "memberOf" : "",
 362       "isStatic" : false,
 363       "isConstructor" : false,
 364       "isPrivate" : false,
 365       "example" : "",
 366       "deprecated" : "",
 367       "since" : "",
 368       "see" : "",
 369       "exceptions" : "",
 370       "requires" : "",
 371       "params" : [
 372         {
 373           "name" : "target",
 374           "type" : "String",
 375           "desc" : "The target region key (north, south, east, west or center).",
 376           "isOptional" : false
 377         },
 378         {
 379           "name" : "panel",
 380           "type" : "Roo.ContentPanel",
 381           "desc" : "The panel to add",
 382           "isOptional" : false
 383         }
 384       ],
 385       "returns" : [
 386         {
 387           "name" : "",
 388           "type" : "Roo.ContentPanel",
 389           "desc" : "The added panel"
 390         }
 391       ]
 392     },
 393     {
 394       "name" : "getRegion",
 395       "type" : "function",
 396       "desc" : "Returns the specified region.",
 397       "sig" : "(target)",
 398       "static" : false,
 399       "memberOf" : "Roo.LayoutManager",
 400       "isStatic" : false,
 401       "isConstructor" : false,
 402       "isPrivate" : false,
 403       "example" : "",
 404       "deprecated" : "",
 405       "since" : "",
 406       "see" : "",
 407       "exceptions" : "",
 408       "requires" : "",
 409       "params" : [
 410         {
 411           "name" : "target",
 412           "type" : "String",
 413           "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
 414           "isOptional" : false
 415         }
 416       ],
 417       "returns" : [
 418         {
 419           "name" : "",
 420           "type" : "Roo.LayoutRegion",
 421           "desc" : ""
 422         }
 423       ]
 424     },
 425     {
 426       "name" : "beginUpdate",
 427       "type" : "function",
 428       "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
 429       "sig" : "()\n{\n\n}",
 430       "static" : false,
 431       "memberOf" : "Roo.LayoutManager",
 432       "isStatic" : false,
 433       "isConstructor" : false,
 434       "isPrivate" : false,
 435       "example" : "",
 436       "deprecated" : "",
 437       "since" : "",
 438       "see" : "",
 439       "exceptions" : "",
 440       "requires" : "",
 441       "params" : [],
 442       "returns" : []
 443     },
 444     {
 445       "name" : "isUpdating",
 446       "type" : "function",
 447       "desc" : "Returns true if this layout is currently being updated",
 448       "sig" : "()\n{\n\n}",
 449       "static" : false,
 450       "memberOf" : "Roo.LayoutManager",
 451       "isStatic" : false,
 452       "isConstructor" : false,
 453       "isPrivate" : false,
 454       "example" : "",
 455       "deprecated" : "",
 456       "since" : "",
 457       "see" : "",
 458       "exceptions" : "",
 459       "requires" : "",
 460       "params" : [],
 461       "returns" : [
 462         {
 463           "name" : "",
 464           "type" : "Boolean",
 465           "desc" : ""
 466         }
 467       ]
 468     },
 469     {
 470       "name" : "getViewSize",
 471       "type" : "function",
 472       "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
 473       "sig" : "()\n{\n\n}",
 474       "static" : false,
 475       "memberOf" : "Roo.LayoutManager",
 476       "isStatic" : false,
 477       "isConstructor" : false,
 478       "isPrivate" : false,
 479       "example" : "",
 480       "deprecated" : "",
 481       "since" : "",
 482       "see" : "",
 483       "exceptions" : "",
 484       "requires" : "",
 485       "params" : [],
 486       "returns" : [
 487         {
 488           "name" : "",
 489           "type" : "Object",
 490           "desc" : "The size as an object {width: (the width), height: (the height)}"
 491         }
 492       ]
 493     },
 494     {
 495       "name" : "endUpdate",
 496       "type" : "function",
 497       "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
 498       "sig" : "(noLayout)",
 499       "static" : false,
 500       "memberOf" : "Roo.LayoutManager",
 501       "isStatic" : false,
 502       "isConstructor" : false,
 503       "isPrivate" : false,
 504       "example" : "",
 505       "deprecated" : "",
 506       "since" : "",
 507       "see" : "",
 508       "exceptions" : "",
 509       "requires" : "",
 510       "params" : [
 511         {
 512           "name" : "noLayout",
 513           "type" : "Boolean",
 514           "desc" : "true to disable a layout update",
 515           "isOptional" : false
 516         }
 517       ],
 518       "returns" : []
 519     },
 520     {
 521       "name" : "getEl",
 522       "type" : "function",
 523       "desc" : "Returns the Element this layout is bound to.",
 524       "sig" : "()\n{\n\n}",
 525       "static" : false,
 526       "memberOf" : "Roo.LayoutManager",
 527       "isStatic" : false,
 528       "isConstructor" : false,
 529       "isPrivate" : false,
 530       "example" : "",
 531       "deprecated" : "",
 532       "since" : "",
 533       "see" : "",
 534       "exceptions" : "",
 535       "requires" : "",
 536       "params" : [],
 537       "returns" : [
 538         {
 539           "name" : "",
 540           "type" : "Roo.Element",
 541           "desc" : ""
 542         }
 543       ]
 544     },
 545     {
 546       "name" : "purgeListeners",
 547       "type" : "function",
 548       "desc" : "Removes all listeners for this object",
 549       "sig" : "()\n{\n\n}",
 550       "static" : false,
 551       "memberOf" : "Roo.util.Observable",
 552       "isStatic" : false,
 553       "isConstructor" : false,
 554       "isPrivate" : false,
 555       "example" : "",
 556       "deprecated" : "",
 557       "since" : "",
 558       "see" : "",
 559       "exceptions" : "",
 560       "requires" : "",
 561       "params" : [],
 562       "returns" : []
 563     },
 564     {
 565       "name" : "on",
 566       "type" : "function",
 567       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 568       "sig" : "(eventName, handler, scope, options)",
 569       "static" : false,
 570       "memberOf" : "Roo.util.Observable",
 571       "isStatic" : false,
 572       "isConstructor" : false,
 573       "isPrivate" : false,
 574       "example" : "",
 575       "deprecated" : "",
 576       "since" : "",
 577       "see" : "",
 578       "exceptions" : "",
 579       "requires" : "",
 580       "params" : [
 581         {
 582           "name" : "eventName",
 583           "type" : "String",
 584           "desc" : "The type of event to listen for",
 585           "isOptional" : false
 586         },
 587         {
 588           "name" : "handler",
 589           "type" : "Function",
 590           "desc" : "The method the event invokes",
 591           "isOptional" : false
 592         },
 593         {
 594           "name" : "scope",
 595           "type" : "Object",
 596           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 597           "isOptional" : false
 598         },
 599         {
 600           "name" : "options",
 601           "type" : "Object",
 602           "desc" : "(optional)",
 603           "isOptional" : false
 604         }
 605       ],
 606       "returns" : []
 607     },
 608     {
 609       "name" : "un",
 610       "type" : "function",
 611       "desc" : "Removes a listener (shorthand for removeListener)",
 612       "sig" : "(eventName, handler, scope)",
 613       "static" : false,
 614       "memberOf" : "Roo.util.Observable",
 615       "isStatic" : false,
 616       "isConstructor" : false,
 617       "isPrivate" : false,
 618       "example" : "",
 619       "deprecated" : "",
 620       "since" : "",
 621       "see" : "",
 622       "exceptions" : "",
 623       "requires" : "",
 624       "params" : [
 625         {
 626           "name" : "eventName",
 627           "type" : "String",
 628           "desc" : "The type of event to listen for",
 629           "isOptional" : false
 630         },
 631         {
 632           "name" : "handler",
 633           "type" : "Function",
 634           "desc" : "The handler to remove",
 635           "isOptional" : false
 636         },
 637         {
 638           "name" : "scope",
 639           "type" : "Object",
 640           "desc" : "(optional) The scope (this object) for the handler",
 641           "isOptional" : false
 642         }
 643       ],
 644       "returns" : []
 645     },
 646     {
 647       "name" : "addEvents",
 648       "type" : "function",
 649       "desc" : "Used to define events on this Observable",
 650       "sig" : "(object)",
 651       "static" : false,
 652       "memberOf" : "Roo.util.Observable",
 653       "isStatic" : false,
 654       "isConstructor" : false,
 655       "isPrivate" : false,
 656       "example" : "",
 657       "deprecated" : "",
 658       "since" : "",
 659       "see" : "",
 660       "exceptions" : "",
 661       "requires" : "",
 662       "params" : [
 663         {
 664           "name" : "object",
 665           "type" : "Object",
 666           "desc" : "The object with the events defined",
 667           "isOptional" : false
 668         }
 669       ],
 670       "returns" : []
 671     },
 672     {
 673       "name" : "releaseCapture",
 674       "type" : "function",
 675       "desc" : "Removes <b>all</b> added captures from the Observable.",
 676       "sig" : "(o)",
 677       "static" : true,
 678       "memberOf" : "Roo.util.Observable",
 679       "isStatic" : true,
 680       "isConstructor" : false,
 681       "isPrivate" : false,
 682       "example" : "",
 683       "deprecated" : "",
 684       "since" : "",
 685       "see" : "",
 686       "exceptions" : "",
 687       "requires" : "",
 688       "params" : [
 689         {
 690           "name" : "o",
 691           "type" : "Observable",
 692           "desc" : "The Observable to release",
 693           "isOptional" : false
 694         }
 695       ],
 696       "returns" : []
 697     },
 698     {
 699       "name" : "removeListener",
 700       "type" : "function",
 701       "desc" : "Removes a listener",
 702       "sig" : "(eventName, handler, scope)",
 703       "static" : false,
 704       "memberOf" : "Roo.util.Observable",
 705       "isStatic" : false,
 706       "isConstructor" : false,
 707       "isPrivate" : false,
 708       "example" : "",
 709       "deprecated" : "",
 710       "since" : "",
 711       "see" : "",
 712       "exceptions" : "",
 713       "requires" : "",
 714       "params" : [
 715         {
 716           "name" : "eventName",
 717           "type" : "String",
 718           "desc" : "The type of event to listen for",
 719           "isOptional" : false
 720         },
 721         {
 722           "name" : "handler",
 723           "type" : "Function",
 724           "desc" : "The handler to remove",
 725           "isOptional" : false
 726         },
 727         {
 728           "name" : "scope",
 729           "type" : "Object",
 730           "desc" : "(optional) The scope (this object) for the handler",
 731           "isOptional" : false
 732         }
 733       ],
 734       "returns" : []
 735     },
 736     {
 737       "name" : "fireEvent",
 738       "type" : "function",
 739       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 740       "sig" : "(eventName, args)",
 741       "static" : false,
 742       "memberOf" : "Roo.util.Observable",
 743       "isStatic" : false,
 744       "isConstructor" : false,
 745       "isPrivate" : false,
 746       "example" : "",
 747       "deprecated" : "",
 748       "since" : "",
 749       "see" : "",
 750       "exceptions" : "",
 751       "requires" : "",
 752       "params" : [
 753         {
 754           "name" : "eventName",
 755           "type" : "String",
 756           "desc" : "",
 757           "isOptional" : false
 758         },
 759         {
 760           "name" : "args",
 761           "type" : "Object...",
 762           "desc" : "Variable number of parameters are passed to handlers",
 763           "isOptional" : false
 764         }
 765       ],
 766       "returns" : [
 767         {
 768           "name" : "",
 769           "type" : "Boolean",
 770           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 771         }
 772       ]
 773     },
 774     {
 775       "name" : "hasListener",
 776       "type" : "function",
 777       "desc" : "Checks to see if this object has any listeners for a specified event",
 778       "sig" : "(eventName)",
 779       "static" : false,
 780       "memberOf" : "Roo.util.Observable",
 781       "isStatic" : false,
 782       "isConstructor" : false,
 783       "isPrivate" : false,
 784       "example" : "",
 785       "deprecated" : "",
 786       "since" : "",
 787       "see" : "",
 788       "exceptions" : "",
 789       "requires" : "",
 790       "params" : [
 791         {
 792           "name" : "eventName",
 793           "type" : "String",
 794           "desc" : "The name of the event to check for",
 795           "isOptional" : false
 796         }
 797       ],
 798       "returns" : [
 799         {
 800           "name" : "",
 801           "type" : "Boolean",
 802           "desc" : "True if the event is being listened for, else false"
 803         }
 804       ]
 805     },
 806     {
 807       "name" : "capture",
 808       "type" : "function",
 809       "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.",
 810       "sig" : "(o, fn, scope)",
 811       "static" : true,
 812       "memberOf" : "Roo.util.Observable",
 813       "isStatic" : true,
 814       "isConstructor" : false,
 815       "isPrivate" : false,
 816       "example" : "",
 817       "deprecated" : "",
 818       "since" : "",
 819       "see" : "",
 820       "exceptions" : "",
 821       "requires" : "",
 822       "params" : [
 823         {
 824           "name" : "o",
 825           "type" : "Observable",
 826           "desc" : "The Observable to capture",
 827           "isOptional" : false
 828         },
 829         {
 830           "name" : "fn",
 831           "type" : "Function",
 832           "desc" : "The function to call",
 833           "isOptional" : false
 834         },
 835         {
 836           "name" : "scope",
 837           "type" : "Object",
 838           "desc" : "(optional) The scope (this object) for the fn",
 839           "isOptional" : false
 840         }
 841       ],
 842       "returns" : []
 843     },
 844     {
 845       "name" : "addListener",
 846       "type" : "function",
 847       "desc" : "Appends an event handler to this component",
 848       "sig" : "(eventName, handler, scope, options)",
 849       "static" : false,
 850       "memberOf" : "Roo.util.Observable",
 851       "isStatic" : false,
 852       "isConstructor" : false,
 853       "isPrivate" : false,
 854       "example" : "",
 855       "deprecated" : "",
 856       "since" : "",
 857       "see" : "",
 858       "exceptions" : "",
 859       "requires" : "",
 860       "params" : [
 861         {
 862           "name" : "eventName",
 863           "type" : "String",
 864           "desc" : "The type of event to listen for",
 865           "isOptional" : false
 866         },
 867         {
 868           "name" : "handler",
 869           "type" : "Function",
 870           "desc" : "The method the event invokes",
 871           "isOptional" : false
 872         },
 873         {
 874           "name" : "scope",
 875           "type" : "Object",
 876           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 877           "isOptional" : false
 878         },
 879         {
 880           "name" : "options",
 881           "type" : "Object",
 882           "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>",
 883           "isOptional" : false
 884         }
 885       ],
 886       "returns" : []
 887     }
 888   ],
 889   "events" : [
 890     {
 891       "name" : "layout",
 892       "type" : "function",
 893       "desc" : "Fires when a layout is performed.",
 894       "sig" : "function (_self)\n{\n\n}",
 895       "memberOf" : "Roo.LayoutManager",
 896       "example" : "",
 897       "deprecated" : "",
 898       "since" : "",
 899       "see" : "",
 900       "params" : [
 901         {
 902           "name" : "this",
 903           "type" : "Roo.LayoutManager",
 904           "desc" : "",
 905           "isOptional" : false
 906         }
 907       ],
 908       "returns" : []
 909     },
 910     {
 911       "name" : "regionexpanded",
 912       "type" : "function",
 913       "desc" : "Fires when a region is expanded.",
 914       "sig" : "function (region)\n{\n\n}",
 915       "memberOf" : "Roo.LayoutManager",
 916       "example" : "",
 917       "deprecated" : "",
 918       "since" : "",
 919       "see" : "",
 920       "params" : [
 921         {
 922           "name" : "region",
 923           "type" : "Roo.LayoutRegion",
 924           "desc" : "The expanded region",
 925           "isOptional" : false
 926         }
 927       ],
 928       "returns" : []
 929     },
 930     {
 931       "name" : "regionresized",
 932       "type" : "function",
 933       "desc" : "Fires when the user resizes a region.",
 934       "sig" : "function (region, newSize)\n{\n\n}",
 935       "memberOf" : "Roo.LayoutManager",
 936       "example" : "",
 937       "deprecated" : "",
 938       "since" : "",
 939       "see" : "",
 940       "params" : [
 941         {
 942           "name" : "region",
 943           "type" : "Roo.LayoutRegion",
 944           "desc" : "The resized region",
 945           "isOptional" : false
 946         },
 947         {
 948           "name" : "newSize",
 949           "type" : "Number",
 950           "desc" : "The new size (width for east/west, height for north/south)",
 951           "isOptional" : false
 952         }
 953       ],
 954       "returns" : []
 955     },
 956     {
 957       "name" : "regioncollapsed",
 958       "type" : "function",
 959       "desc" : "Fires when a region is collapsed.",
 960       "sig" : "function (region)\n{\n\n}",
 961       "memberOf" : "Roo.LayoutManager",
 962       "example" : "",
 963       "deprecated" : "",
 964       "since" : "",
 965       "see" : "",
 966       "params" : [
 967         {
 968           "name" : "region",
 969           "type" : "Roo.LayoutRegion",
 970           "desc" : "The collapsed region",
 971           "isOptional" : false
 972         }
 973       ],
 974       "returns" : []
 975     }
 976   ]
 977 }