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