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