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