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

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