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