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