git.roojs.org Git - roojs1/blob - docs2/symbols/Roo.SplitBar.json

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