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

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