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