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