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