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

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