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