git.roojs.org Git - roojs1/blob - docs/symbols/Roo.LayoutManager.json

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