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