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