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