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

   1 {
   2   "name" : "Roo.bootstrap.layout.Basic",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "desc" : "This class represents a lightweight region in a layout manager. This region does not move dom nodes\nand does not have a titlebar, tabs or any other features. All it does is size and position \npanels. To create a BasicLayoutRegion, add lightweight:true or basic:true to your regions config.",
   7   "isSingleton" : false,
   8   "isStatic" : false,
   9   "isBuiltin" : false,
  10   "memberOf" : "Basic",
  11   "example" : "",
  12   "deprecated" : "",
  13   "since" : "",
  14   "see" : "",
  15   "params" : [],
  16   "returns" : [],
  17   "throws" : "",
  18   "requires" : "",
  19   "config" : [
  20     {
  21       "name" : "listeners",
  22       "type" : "Object",
  23       "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>",
  24       "memberOf" : "Roo.util.Observable"
  25     },
  26     {
  27       "name" : "skipConfig",
  28       "type" : "bool",
  29       "desc" : "skip config?",
  30       "memberOf" : ""
  31     },
  32     {
  33       "name" : "region",
  34       "type" : "string",
  35       "desc" : "the region that it inhabits..",
  36       "memberOf" : ""
  37     },
  38     {
  39       "name" : "mgr",
  40       "type" : "Roo.bootstrap.layout.Manager",
  41       "desc" : "The manager",
  42       "memberOf" : ""
  43     }
  44   ],
  45   "methods" : [
  46     {
  47       "name" : "remove",
  48       "type" : "function",
  49       "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
  50       "sig" : "(panel, preservePanel)",
  51       "static" : false,
  52       "memberOf" : "",
  53       "isStatic" : false,
  54       "isConstructor" : false,
  55       "isPrivate" : false,
  56       "example" : "",
  57       "deprecated" : "",
  58       "since" : "",
  59       "see" : "",
  60       "exceptions" : "",
  61       "requires" : "",
  62       "params" : [
  63         {
  64           "name" : "panel",
  65           "type" : "Number/String/ContentPanel",
  66           "desc" : "The panels index, id or the panel itself",
  67           "isOptional" : false
  68         },
  69         {
  70           "name" : "preservePanel",
  71           "type" : "Boolean",
  72           "desc" : "Overrides the config preservePanel option",
  73           "isOptional" : false
  74         }
  75       ],
  76       "returns" : [
  77         {
  78           "name" : "",
  79           "type" : "Roo.ContentPanel",
  80           "desc" : "The panel that was removed"
  81         }
  82       ]
  83     },
  84     {
  85       "name" : "getEl",
  86       "type" : "function",
  87       "desc" : "Returns the container element for this region.",
  88       "sig" : "()\n{\n\n}",
  89       "static" : false,
  90       "memberOf" : "",
  91       "isStatic" : false,
  92       "isConstructor" : false,
  93       "isPrivate" : false,
  94       "example" : "",
  95       "deprecated" : "",
  96       "since" : "",
  97       "see" : "",
  98       "exceptions" : "",
  99       "requires" : "",
 100       "params" : [],
 101       "returns" : [
 102         {
 103           "name" : "",
 104           "type" : "Roo.Element",
 105           "desc" : ""
 106         }
 107       ]
 108     },
 109     {
 110       "name" : "showPanel",
 111       "type" : "function",
 112       "desc" : "Show the specified panel.",
 113       "sig" : "(panelId)",
 114       "static" : false,
 115       "memberOf" : "",
 116       "isStatic" : false,
 117       "isConstructor" : false,
 118       "isPrivate" : false,
 119       "example" : "",
 120       "deprecated" : "",
 121       "since" : "",
 122       "see" : "",
 123       "exceptions" : "",
 124       "requires" : "",
 125       "params" : [
 126         {
 127           "name" : "panelId",
 128           "type" : "Number/String/ContentPanel",
 129           "desc" : "The panels index, id or the panel itself",
 130           "isOptional" : false
 131         }
 132       ],
 133       "returns" : [
 134         {
 135           "name" : "",
 136           "type" : "Roo.ContentPanel",
 137           "desc" : "The shown panel or null"
 138         }
 139       ]
 140     },
 141     {
 142       "name" : "getPanel",
 143       "type" : "function",
 144       "desc" : "Returns the panel specified or null if it's not in this region.",
 145       "sig" : "(panel)",
 146       "static" : false,
 147       "memberOf" : "",
 148       "isStatic" : false,
 149       "isConstructor" : false,
 150       "isPrivate" : false,
 151       "example" : "",
 152       "deprecated" : "",
 153       "since" : "",
 154       "see" : "",
 155       "exceptions" : "",
 156       "requires" : "",
 157       "params" : [
 158         {
 159           "name" : "panel",
 160           "type" : "Number/String/ContentPanel",
 161           "desc" : "The panels index, id or the panel itself",
 162           "isOptional" : false
 163         }
 164       ],
 165       "returns" : [
 166         {
 167           "name" : "",
 168           "type" : "Roo.ContentPanel",
 169           "desc" : ""
 170         }
 171       ]
 172     },
 173     {
 174       "name" : "hasPanel",
 175       "type" : "function",
 176       "desc" : "Returns true if the panel is in this region.",
 177       "sig" : "(panel)",
 178       "static" : false,
 179       "memberOf" : "",
 180       "isStatic" : false,
 181       "isConstructor" : false,
 182       "isPrivate" : false,
 183       "example" : "",
 184       "deprecated" : "",
 185       "since" : "",
 186       "see" : "",
 187       "exceptions" : "",
 188       "requires" : "",
 189       "params" : [
 190         {
 191           "name" : "panel",
 192           "type" : "Number/String/ContentPanel",
 193           "desc" : "The panels index, id or the panel itself",
 194           "isOptional" : false
 195         }
 196       ],
 197       "returns" : [
 198         {
 199           "name" : "",
 200           "type" : "Boolean",
 201           "desc" : ""
 202         }
 203       ]
 204     },
 205     {
 206       "name" : "resizeTo",
 207       "type" : "function",
 208       "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
 209       "sig" : "(newSize)",
 210       "static" : false,
 211       "memberOf" : "",
 212       "isStatic" : false,
 213       "isConstructor" : false,
 214       "isPrivate" : false,
 215       "example" : "",
 216       "deprecated" : "",
 217       "since" : "",
 218       "see" : "",
 219       "exceptions" : "",
 220       "requires" : "",
 221       "params" : [
 222         {
 223           "name" : "newSize",
 224           "type" : "Number",
 225           "desc" : "The new width or height",
 226           "isOptional" : false
 227         }
 228       ],
 229       "returns" : []
 230     },
 231     {
 232       "name" : "getPosition",
 233       "type" : "function",
 234       "desc" : "Returns this regions position (north/south/east/west/center).",
 235       "sig" : "()\n{\n\n}",
 236       "static" : false,
 237       "memberOf" : "",
 238       "isStatic" : false,
 239       "isConstructor" : false,
 240       "isPrivate" : false,
 241       "example" : "",
 242       "deprecated" : "",
 243       "since" : "",
 244       "see" : "",
 245       "exceptions" : "",
 246       "requires" : "",
 247       "params" : [],
 248       "returns" : [
 249         {
 250           "name" : "",
 251           "type" : "String",
 252           "desc" : ""
 253         }
 254       ]
 255     },
 256     {
 257       "name" : "getActivePanel",
 258       "type" : "function",
 259       "desc" : "Get the active panel for this region.",
 260       "sig" : "()\n{\n\n}",
 261       "static" : false,
 262       "memberOf" : "",
 263       "isStatic" : false,
 264       "isConstructor" : false,
 265       "isPrivate" : false,
 266       "example" : "",
 267       "deprecated" : "",
 268       "since" : "",
 269       "see" : "",
 270       "exceptions" : "",
 271       "requires" : "",
 272       "params" : [],
 273       "returns" : [
 274         {
 275           "name" : "",
 276           "type" : "Roo.ContentPanel",
 277           "desc" : "The active panel or null"
 278         }
 279       ]
 280     },
 281     {
 282       "name" : "isVisible",
 283       "type" : "function",
 284       "desc" : "Returns true if this region is currently visible.",
 285       "sig" : "()\n{\n\n}",
 286       "static" : false,
 287       "memberOf" : "",
 288       "isStatic" : false,
 289       "isConstructor" : false,
 290       "isPrivate" : false,
 291       "example" : "",
 292       "deprecated" : "",
 293       "since" : "",
 294       "see" : "",
 295       "exceptions" : "",
 296       "requires" : "",
 297       "params" : [],
 298       "returns" : [
 299         {
 300           "name" : "",
 301           "type" : "Boolean",
 302           "desc" : ""
 303         }
 304       ]
 305     },
 306     {
 307       "name" : "add",
 308       "type" : "function",
 309       "desc" : "Add the passed ContentPanel(s)",
 310       "sig" : "(panel)",
 311       "static" : false,
 312       "memberOf" : "",
 313       "isStatic" : false,
 314       "isConstructor" : false,
 315       "isPrivate" : false,
 316       "example" : "",
 317       "deprecated" : "",
 318       "since" : "",
 319       "see" : "",
 320       "exceptions" : "",
 321       "requires" : "",
 322       "params" : [
 323         {
 324           "name" : "panel",
 325           "type" : "ContentPanel...",
 326           "desc" : "The ContentPanel(s) to add (you can pass more than one)",
 327           "isOptional" : false
 328         }
 329       ],
 330       "returns" : [
 331         {
 332           "name" : "",
 333           "type" : "Roo.ContentPanel",
 334           "desc" : "The panel added (if only one was added)"
 335         }
 336       ]
 337     },
 338     {
 339       "name" : "purgeListeners",
 340       "type" : "function",
 341       "desc" : "Removes all listeners for this object",
 342       "sig" : "()\n{\n\n}",
 343       "static" : false,
 344       "memberOf" : "Roo.util.Observable",
 345       "isStatic" : false,
 346       "isConstructor" : false,
 347       "isPrivate" : false,
 348       "example" : "",
 349       "deprecated" : "",
 350       "since" : "",
 351       "see" : "",
 352       "exceptions" : "",
 353       "requires" : "",
 354       "params" : [],
 355       "returns" : []
 356     },
 357     {
 358       "name" : "on",
 359       "type" : "function",
 360       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 361       "sig" : "(eventName, handler, scope, options)",
 362       "static" : false,
 363       "memberOf" : "Roo.util.Observable",
 364       "isStatic" : false,
 365       "isConstructor" : false,
 366       "isPrivate" : false,
 367       "example" : "",
 368       "deprecated" : "",
 369       "since" : "",
 370       "see" : "",
 371       "exceptions" : "",
 372       "requires" : "",
 373       "params" : [
 374         {
 375           "name" : "eventName",
 376           "type" : "String",
 377           "desc" : "The type of event to listen for",
 378           "isOptional" : false
 379         },
 380         {
 381           "name" : "handler",
 382           "type" : "Function",
 383           "desc" : "The method the event invokes",
 384           "isOptional" : false
 385         },
 386         {
 387           "name" : "scope",
 388           "type" : "Object",
 389           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 390           "isOptional" : false
 391         },
 392         {
 393           "name" : "options",
 394           "type" : "Object",
 395           "desc" : "(optional)",
 396           "isOptional" : false
 397         }
 398       ],
 399       "returns" : []
 400     },
 401     {
 402       "name" : "un",
 403       "type" : "function",
 404       "desc" : "Removes a listener (shorthand for removeListener)",
 405       "sig" : "(eventName, handler, scope)",
 406       "static" : false,
 407       "memberOf" : "Roo.util.Observable",
 408       "isStatic" : false,
 409       "isConstructor" : false,
 410       "isPrivate" : false,
 411       "example" : "",
 412       "deprecated" : "",
 413       "since" : "",
 414       "see" : "",
 415       "exceptions" : "",
 416       "requires" : "",
 417       "params" : [
 418         {
 419           "name" : "eventName",
 420           "type" : "String",
 421           "desc" : "The type of event to listen for",
 422           "isOptional" : false
 423         },
 424         {
 425           "name" : "handler",
 426           "type" : "Function",
 427           "desc" : "The handler to remove",
 428           "isOptional" : false
 429         },
 430         {
 431           "name" : "scope",
 432           "type" : "Object",
 433           "desc" : "(optional) The scope (this object) for the handler",
 434           "isOptional" : false
 435         }
 436       ],
 437       "returns" : []
 438     },
 439     {
 440       "name" : "addEvents",
 441       "type" : "function",
 442       "desc" : "Used to define events on this Observable",
 443       "sig" : "(object)",
 444       "static" : false,
 445       "memberOf" : "Roo.util.Observable",
 446       "isStatic" : false,
 447       "isConstructor" : false,
 448       "isPrivate" : false,
 449       "example" : "",
 450       "deprecated" : "",
 451       "since" : "",
 452       "see" : "",
 453       "exceptions" : "",
 454       "requires" : "",
 455       "params" : [
 456         {
 457           "name" : "object",
 458           "type" : "Object",
 459           "desc" : "The object with the events defined",
 460           "isOptional" : false
 461         }
 462       ],
 463       "returns" : []
 464     },
 465     {
 466       "name" : "releaseCapture",
 467       "type" : "function",
 468       "desc" : "Removes <b>all</b> added captures from the Observable.",
 469       "sig" : "(o)",
 470       "static" : true,
 471       "memberOf" : "Roo.util.Observable",
 472       "isStatic" : true,
 473       "isConstructor" : false,
 474       "isPrivate" : false,
 475       "example" : "",
 476       "deprecated" : "",
 477       "since" : "",
 478       "see" : "",
 479       "exceptions" : "",
 480       "requires" : "",
 481       "params" : [
 482         {
 483           "name" : "o",
 484           "type" : "Observable",
 485           "desc" : "The Observable to release",
 486           "isOptional" : false
 487         }
 488       ],
 489       "returns" : []
 490     },
 491     {
 492       "name" : "removeListener",
 493       "type" : "function",
 494       "desc" : "Removes a listener",
 495       "sig" : "(eventName, handler, scope)",
 496       "static" : false,
 497       "memberOf" : "Roo.util.Observable",
 498       "isStatic" : false,
 499       "isConstructor" : false,
 500       "isPrivate" : false,
 501       "example" : "",
 502       "deprecated" : "",
 503       "since" : "",
 504       "see" : "",
 505       "exceptions" : "",
 506       "requires" : "",
 507       "params" : [
 508         {
 509           "name" : "eventName",
 510           "type" : "String",
 511           "desc" : "The type of event to listen for",
 512           "isOptional" : false
 513         },
 514         {
 515           "name" : "handler",
 516           "type" : "Function",
 517           "desc" : "The handler to remove",
 518           "isOptional" : false
 519         },
 520         {
 521           "name" : "scope",
 522           "type" : "Object",
 523           "desc" : "(optional) The scope (this object) for the handler",
 524           "isOptional" : false
 525         }
 526       ],
 527       "returns" : []
 528     },
 529     {
 530       "name" : "fireEvent",
 531       "type" : "function",
 532       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 533       "sig" : "(eventName, args)",
 534       "static" : false,
 535       "memberOf" : "Roo.util.Observable",
 536       "isStatic" : false,
 537       "isConstructor" : false,
 538       "isPrivate" : false,
 539       "example" : "",
 540       "deprecated" : "",
 541       "since" : "",
 542       "see" : "",
 543       "exceptions" : "",
 544       "requires" : "",
 545       "params" : [
 546         {
 547           "name" : "eventName",
 548           "type" : "String",
 549           "desc" : "",
 550           "isOptional" : false
 551         },
 552         {
 553           "name" : "args",
 554           "type" : "Object...",
 555           "desc" : "Variable number of parameters are passed to handlers",
 556           "isOptional" : false
 557         }
 558       ],
 559       "returns" : [
 560         {
 561           "name" : "",
 562           "type" : "Boolean",
 563           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 564         }
 565       ]
 566     },
 567     {
 568       "name" : "hasListener",
 569       "type" : "function",
 570       "desc" : "Checks to see if this object has any listeners for a specified event",
 571       "sig" : "(eventName)",
 572       "static" : false,
 573       "memberOf" : "Roo.util.Observable",
 574       "isStatic" : false,
 575       "isConstructor" : false,
 576       "isPrivate" : false,
 577       "example" : "",
 578       "deprecated" : "",
 579       "since" : "",
 580       "see" : "",
 581       "exceptions" : "",
 582       "requires" : "",
 583       "params" : [
 584         {
 585           "name" : "eventName",
 586           "type" : "String",
 587           "desc" : "The name of the event to check for",
 588           "isOptional" : false
 589         }
 590       ],
 591       "returns" : [
 592         {
 593           "name" : "",
 594           "type" : "Boolean",
 595           "desc" : "True if the event is being listened for, else false"
 596         }
 597       ]
 598     },
 599     {
 600       "name" : "capture",
 601       "type" : "function",
 602       "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.",
 603       "sig" : "(o, fn, scope)",
 604       "static" : true,
 605       "memberOf" : "Roo.util.Observable",
 606       "isStatic" : true,
 607       "isConstructor" : false,
 608       "isPrivate" : false,
 609       "example" : "",
 610       "deprecated" : "",
 611       "since" : "",
 612       "see" : "",
 613       "exceptions" : "",
 614       "requires" : "",
 615       "params" : [
 616         {
 617           "name" : "o",
 618           "type" : "Observable",
 619           "desc" : "The Observable to capture",
 620           "isOptional" : false
 621         },
 622         {
 623           "name" : "fn",
 624           "type" : "Function",
 625           "desc" : "The function to call",
 626           "isOptional" : false
 627         },
 628         {
 629           "name" : "scope",
 630           "type" : "Object",
 631           "desc" : "(optional) The scope (this object) for the fn",
 632           "isOptional" : false
 633         }
 634       ],
 635       "returns" : []
 636     },
 637     {
 638       "name" : "addListener",
 639       "type" : "function",
 640       "desc" : "Appends an event handler to this component",
 641       "sig" : "(eventName, handler, scope, options)",
 642       "static" : false,
 643       "memberOf" : "Roo.util.Observable",
 644       "isStatic" : false,
 645       "isConstructor" : false,
 646       "isPrivate" : false,
 647       "example" : "",
 648       "deprecated" : "",
 649       "since" : "",
 650       "see" : "",
 651       "exceptions" : "",
 652       "requires" : "",
 653       "params" : [
 654         {
 655           "name" : "eventName",
 656           "type" : "String",
 657           "desc" : "The type of event to listen for",
 658           "isOptional" : false
 659         },
 660         {
 661           "name" : "handler",
 662           "type" : "Function",
 663           "desc" : "The method the event invokes",
 664           "isOptional" : false
 665         },
 666         {
 667           "name" : "scope",
 668           "type" : "Object",
 669           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 670           "isOptional" : false
 671         },
 672         {
 673           "name" : "options",
 674           "type" : "Object",
 675           "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>",
 676           "isOptional" : false
 677         }
 678       ],
 679       "returns" : []
 680     }
 681   ],
 682   "events" : []
 683 }