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

   1 {
   2   "name" : "Roo.SplitBar",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "childClasses" : [],
   7   "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>",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "memberOf" : "SplitBar",
  12   "example" : "",
  13   "deprecated" : "",
  14   "since" : "",
  15   "see" : "",
  16   "params" : [
  17     {
  18       "name" : "dragElement",
  19       "type" : "String/HTMLElement/Roo.Element",
  20       "desc" : "The element to be dragged and act as the SplitBar.",
  21       "isOptional" : false
  22     },
  23     {
  24       "name" : "resizingElement",
  25       "type" : "String/HTMLElement/Roo.Element",
  26       "desc" : "The element to be resized based on where the SplitBar element is dragged",
  27       "isOptional" : false
  28     },
  29     {
  30       "name" : "orientation",
  31       "type" : "Number",
  32       "desc" : "(optional) Either Roo.SplitBar.HORIZONTAL or Roo.SplitBar.VERTICAL. (Defaults to HORIZONTAL)",
  33       "isOptional" : false
  34     },
  35     {
  36       "name" : "placement",
  37       "type" : "Number",
  38       "desc" : "(optional) Either Roo.SplitBar.LEFT or Roo.SplitBar.RIGHT for horizontal or  \n                        Roo.SplitBar.TOP or Roo.SplitBar.BOTTOM for vertical. (By default, this is determined automatically by the initial\n                        position of the SplitBar).",
  39       "isOptional" : false
  40     }
  41   ],
  42   "returns" : [],
  43   "throws" : "",
  44   "requires" : "",
  45   "config" : [
  46     {
  47       "name" : "listeners",
  48       "type" : "Object",
  49       "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>",
  50       "memberOf" : "Roo.util.Observable"
  51     }
  52   ],
  53   "methods" : [
  54     {
  55       "name" : "getAdapter",
  56       "type" : "function",
  57       "desc" : "Get the adapter this SplitBar uses",
  58       "sig" : "()\n{\n\n}",
  59       "static" : false,
  60       "memberOf" : "",
  61       "isStatic" : false,
  62       "isConstructor" : false,
  63       "isPrivate" : false,
  64       "example" : "",
  65       "deprecated" : "",
  66       "since" : "",
  67       "see" : "",
  68       "exceptions" : "",
  69       "requires" : "",
  70       "params" : [],
  71       "returns" : [
  72         {
  73           "name" : "",
  74           "type" : "",
  75           "desc" : "The adapter object"
  76         }
  77       ]
  78     },
  79     {
  80       "name" : "setMaximumSize",
  81       "type" : "function",
  82       "desc" : "Sets the maximum size for the resizing element",
  83       "sig" : "(maxSize)",
  84       "static" : false,
  85       "memberOf" : "",
  86       "isStatic" : false,
  87       "isConstructor" : false,
  88       "isPrivate" : false,
  89       "example" : "",
  90       "deprecated" : "",
  91       "since" : "",
  92       "see" : "",
  93       "exceptions" : "",
  94       "requires" : "",
  95       "params" : [
  96         {
  97           "name" : "maxSize",
  98           "type" : "Number",
  99           "desc" : "The maximum size",
 100           "isOptional" : false
 101         }
 102       ],
 103       "returns" : []
 104     },
 105     {
 106       "name" : "setCurrentSize",
 107       "type" : "function",
 108       "desc" : "Sets the initialize size for the resizing element",
 109       "sig" : "(size)",
 110       "static" : false,
 111       "memberOf" : "",
 112       "isStatic" : false,
 113       "isConstructor" : false,
 114       "isPrivate" : false,
 115       "example" : "",
 116       "deprecated" : "",
 117       "since" : "",
 118       "see" : "",
 119       "exceptions" : "",
 120       "requires" : "",
 121       "params" : [
 122         {
 123           "name" : "size",
 124           "type" : "Number",
 125           "desc" : "The initial size",
 126           "isOptional" : false
 127         }
 128       ],
 129       "returns" : []
 130     },
 131     {
 132       "name" : "destroy",
 133       "type" : "function",
 134       "desc" : "Destroy this splitbar.",
 135       "sig" : "(removeEl)",
 136       "static" : false,
 137       "memberOf" : "",
 138       "isStatic" : false,
 139       "isConstructor" : false,
 140       "isPrivate" : false,
 141       "example" : "",
 142       "deprecated" : "",
 143       "since" : "",
 144       "see" : "",
 145       "exceptions" : "",
 146       "requires" : "",
 147       "params" : [
 148         {
 149           "name" : "removeEl",
 150           "type" : "Boolean",
 151           "desc" : "True to remove the element",
 152           "isOptional" : false
 153         }
 154       ],
 155       "returns" : []
 156     },
 157     {
 158       "name" : "setMinimumSize",
 159       "type" : "function",
 160       "desc" : "Sets the minimum size for the resizing element",
 161       "sig" : "(minSize)",
 162       "static" : false,
 163       "memberOf" : "",
 164       "isStatic" : false,
 165       "isConstructor" : false,
 166       "isPrivate" : false,
 167       "example" : "",
 168       "deprecated" : "",
 169       "since" : "",
 170       "see" : "",
 171       "exceptions" : "",
 172       "requires" : "",
 173       "params" : [
 174         {
 175           "name" : "minSize",
 176           "type" : "Number",
 177           "desc" : "The minimum size",
 178           "isOptional" : false
 179         }
 180       ],
 181       "returns" : []
 182     },
 183     {
 184       "name" : "getMinimumSize",
 185       "type" : "function",
 186       "desc" : "Gets the minimum size for the resizing element",
 187       "sig" : "()\n{\n\n}",
 188       "static" : false,
 189       "memberOf" : "",
 190       "isStatic" : false,
 191       "isConstructor" : false,
 192       "isPrivate" : false,
 193       "example" : "",
 194       "deprecated" : "",
 195       "since" : "",
 196       "see" : "",
 197       "exceptions" : "",
 198       "requires" : "",
 199       "params" : [],
 200       "returns" : [
 201         {
 202           "name" : "",
 203           "type" : "Number",
 204           "desc" : "The minimum size"
 205         }
 206       ]
 207     },
 208     {
 209       "name" : "getMaximumSize",
 210       "type" : "function",
 211       "desc" : "Gets the maximum size for the resizing element",
 212       "sig" : "()\n{\n\n}",
 213       "static" : false,
 214       "memberOf" : "",
 215       "isStatic" : false,
 216       "isConstructor" : false,
 217       "isPrivate" : false,
 218       "example" : "",
 219       "deprecated" : "",
 220       "since" : "",
 221       "see" : "",
 222       "exceptions" : "",
 223       "requires" : "",
 224       "params" : [],
 225       "returns" : [
 226         {
 227           "name" : "",
 228           "type" : "Number",
 229           "desc" : "The maximum size"
 230         }
 231       ]
 232     },
 233     {
 234       "name" : "setAdapter",
 235       "type" : "function",
 236       "desc" : "Set the adapter this SplitBar uses",
 237       "sig" : "(adapter)",
 238       "static" : false,
 239       "memberOf" : "",
 240       "isStatic" : false,
 241       "isConstructor" : false,
 242       "isPrivate" : false,
 243       "example" : "",
 244       "deprecated" : "",
 245       "since" : "",
 246       "see" : "",
 247       "exceptions" : "",
 248       "requires" : "",
 249       "params" : [
 250         {
 251           "name" : "adapter",
 252           "type" : "Object",
 253           "desc" : "A SplitBar adapter object",
 254           "isOptional" : false
 255         }
 256       ],
 257       "returns" : []
 258     },
 259     {
 260       "name" : "purgeListeners",
 261       "type" : "function",
 262       "desc" : "Removes all listeners for this object",
 263       "sig" : "()\n{\n\n}",
 264       "static" : false,
 265       "memberOf" : "Roo.util.Observable",
 266       "isStatic" : false,
 267       "isConstructor" : false,
 268       "isPrivate" : false,
 269       "example" : "",
 270       "deprecated" : "",
 271       "since" : "",
 272       "see" : "",
 273       "exceptions" : "",
 274       "requires" : "",
 275       "params" : [],
 276       "returns" : []
 277     },
 278     {
 279       "name" : "on",
 280       "type" : "function",
 281       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 282       "sig" : "(eventName, handler, scope, options)",
 283       "static" : false,
 284       "memberOf" : "Roo.util.Observable",
 285       "isStatic" : false,
 286       "isConstructor" : false,
 287       "isPrivate" : false,
 288       "example" : "",
 289       "deprecated" : "",
 290       "since" : "",
 291       "see" : "",
 292       "exceptions" : "",
 293       "requires" : "",
 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 method the event invokes",
 305           "isOptional" : false
 306         },
 307         {
 308           "name" : "scope",
 309           "type" : "Object",
 310           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 311           "isOptional" : false
 312         },
 313         {
 314           "name" : "options",
 315           "type" : "Object",
 316           "desc" : "(optional)",
 317           "isOptional" : false
 318         }
 319       ],
 320       "returns" : []
 321     },
 322     {
 323       "name" : "un",
 324       "type" : "function",
 325       "desc" : "Removes a listener (shorthand for removeListener)",
 326       "sig" : "(eventName, handler, scope)",
 327       "static" : false,
 328       "memberOf" : "Roo.util.Observable",
 329       "isStatic" : false,
 330       "isConstructor" : false,
 331       "isPrivate" : false,
 332       "example" : "",
 333       "deprecated" : "",
 334       "since" : "",
 335       "see" : "",
 336       "exceptions" : "",
 337       "requires" : "",
 338       "params" : [
 339         {
 340           "name" : "eventName",
 341           "type" : "String",
 342           "desc" : "The type of event to listen for",
 343           "isOptional" : false
 344         },
 345         {
 346           "name" : "handler",
 347           "type" : "Function",
 348           "desc" : "The handler to remove",
 349           "isOptional" : false
 350         },
 351         {
 352           "name" : "scope",
 353           "type" : "Object",
 354           "desc" : "(optional) The scope (this object) for the handler",
 355           "isOptional" : false
 356         }
 357       ],
 358       "returns" : []
 359     },
 360     {
 361       "name" : "addEvents",
 362       "type" : "function",
 363       "desc" : "Used to define events on this Observable",
 364       "sig" : "(object)",
 365       "static" : false,
 366       "memberOf" : "Roo.util.Observable",
 367       "isStatic" : false,
 368       "isConstructor" : false,
 369       "isPrivate" : false,
 370       "example" : "",
 371       "deprecated" : "",
 372       "since" : "",
 373       "see" : "",
 374       "exceptions" : "",
 375       "requires" : "",
 376       "params" : [
 377         {
 378           "name" : "object",
 379           "type" : "Object",
 380           "desc" : "The object with the events defined",
 381           "isOptional" : false
 382         }
 383       ],
 384       "returns" : []
 385     },
 386     {
 387       "name" : "releaseCapture",
 388       "type" : "function",
 389       "desc" : "Removes <b>all</b> added captures from the Observable.",
 390       "sig" : "(o)",
 391       "static" : true,
 392       "memberOf" : "Roo.util.Observable",
 393       "isStatic" : true,
 394       "isConstructor" : false,
 395       "isPrivate" : false,
 396       "example" : "",
 397       "deprecated" : "",
 398       "since" : "",
 399       "see" : "",
 400       "exceptions" : "",
 401       "requires" : "",
 402       "params" : [
 403         {
 404           "name" : "o",
 405           "type" : "Observable",
 406           "desc" : "The Observable to release",
 407           "isOptional" : false
 408         }
 409       ],
 410       "returns" : []
 411     },
 412     {
 413       "name" : "removeListener",
 414       "type" : "function",
 415       "desc" : "Removes a listener",
 416       "sig" : "(eventName, handler, scope)",
 417       "static" : false,
 418       "memberOf" : "Roo.util.Observable",
 419       "isStatic" : false,
 420       "isConstructor" : false,
 421       "isPrivate" : false,
 422       "example" : "",
 423       "deprecated" : "",
 424       "since" : "",
 425       "see" : "",
 426       "exceptions" : "",
 427       "requires" : "",
 428       "params" : [
 429         {
 430           "name" : "eventName",
 431           "type" : "String",
 432           "desc" : "The type of event to listen for",
 433           "isOptional" : false
 434         },
 435         {
 436           "name" : "handler",
 437           "type" : "Function",
 438           "desc" : "The handler to remove",
 439           "isOptional" : false
 440         },
 441         {
 442           "name" : "scope",
 443           "type" : "Object",
 444           "desc" : "(optional) The scope (this object) for the handler",
 445           "isOptional" : false
 446         }
 447       ],
 448       "returns" : []
 449     },
 450     {
 451       "name" : "fireEvent",
 452       "type" : "function",
 453       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 454       "sig" : "(eventName, args)",
 455       "static" : false,
 456       "memberOf" : "Roo.util.Observable",
 457       "isStatic" : false,
 458       "isConstructor" : false,
 459       "isPrivate" : false,
 460       "example" : "",
 461       "deprecated" : "",
 462       "since" : "",
 463       "see" : "",
 464       "exceptions" : "",
 465       "requires" : "",
 466       "params" : [
 467         {
 468           "name" : "eventName",
 469           "type" : "String",
 470           "desc" : "",
 471           "isOptional" : false
 472         },
 473         {
 474           "name" : "args",
 475           "type" : "Object...",
 476           "desc" : "Variable number of parameters are passed to handlers",
 477           "isOptional" : false
 478         }
 479       ],
 480       "returns" : [
 481         {
 482           "name" : "",
 483           "type" : "Boolean",
 484           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 485         }
 486       ]
 487     },
 488     {
 489       "name" : "hasListener",
 490       "type" : "function",
 491       "desc" : "Checks to see if this object has any listeners for a specified event",
 492       "sig" : "(eventName)",
 493       "static" : false,
 494       "memberOf" : "Roo.util.Observable",
 495       "isStatic" : false,
 496       "isConstructor" : false,
 497       "isPrivate" : false,
 498       "example" : "",
 499       "deprecated" : "",
 500       "since" : "",
 501       "see" : "",
 502       "exceptions" : "",
 503       "requires" : "",
 504       "params" : [
 505         {
 506           "name" : "eventName",
 507           "type" : "String",
 508           "desc" : "The name of the event to check for",
 509           "isOptional" : false
 510         }
 511       ],
 512       "returns" : [
 513         {
 514           "name" : "",
 515           "type" : "Boolean",
 516           "desc" : "True if the event is being listened for, else false"
 517         }
 518       ]
 519     },
 520     {
 521       "name" : "capture",
 522       "type" : "function",
 523       "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.",
 524       "sig" : "(o, fn, scope)",
 525       "static" : true,
 526       "memberOf" : "Roo.util.Observable",
 527       "isStatic" : true,
 528       "isConstructor" : false,
 529       "isPrivate" : false,
 530       "example" : "",
 531       "deprecated" : "",
 532       "since" : "",
 533       "see" : "",
 534       "exceptions" : "",
 535       "requires" : "",
 536       "params" : [
 537         {
 538           "name" : "o",
 539           "type" : "Observable",
 540           "desc" : "The Observable to capture",
 541           "isOptional" : false
 542         },
 543         {
 544           "name" : "fn",
 545           "type" : "Function",
 546           "desc" : "The function to call",
 547           "isOptional" : false
 548         },
 549         {
 550           "name" : "scope",
 551           "type" : "Object",
 552           "desc" : "(optional) The scope (this object) for the fn",
 553           "isOptional" : false
 554         }
 555       ],
 556       "returns" : []
 557     },
 558     {
 559       "name" : "addListener",
 560       "type" : "function",
 561       "desc" : "Appends an event handler to this component",
 562       "sig" : "(eventName, handler, scope, options)",
 563       "static" : false,
 564       "memberOf" : "Roo.util.Observable",
 565       "isStatic" : false,
 566       "isConstructor" : false,
 567       "isPrivate" : false,
 568       "example" : "",
 569       "deprecated" : "",
 570       "since" : "",
 571       "see" : "",
 572       "exceptions" : "",
 573       "requires" : "",
 574       "params" : [
 575         {
 576           "name" : "eventName",
 577           "type" : "String",
 578           "desc" : "The type of event to listen for",
 579           "isOptional" : false
 580         },
 581         {
 582           "name" : "handler",
 583           "type" : "Function",
 584           "desc" : "The method the event invokes",
 585           "isOptional" : false
 586         },
 587         {
 588           "name" : "scope",
 589           "type" : "Object",
 590           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 591           "isOptional" : false
 592         },
 593         {
 594           "name" : "options",
 595           "type" : "Object",
 596           "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>",
 597           "isOptional" : false
 598         }
 599       ],
 600       "returns" : []
 601     }
 602   ],
 603   "events" : [
 604     {
 605       "name" : "resize",
 606       "type" : "function",
 607       "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})",
 608       "sig" : "function (_self, newSize)\n{\n\n}",
 609       "memberOf" : "",
 610       "example" : "",
 611       "deprecated" : "",
 612       "since" : "",
 613       "see" : "",
 614       "params" : [
 615         {
 616           "name" : "this",
 617           "type" : "Roo.SplitBar",
 618           "desc" : "",
 619           "isOptional" : false
 620         },
 621         {
 622           "name" : "newSize",
 623           "type" : "Number",
 624           "desc" : "the new width or height",
 625           "isOptional" : false
 626         }
 627       ],
 628       "returns" : []
 629     },
 630     {
 631       "name" : "beforeresize",
 632       "type" : "function",
 633       "desc" : "Fires before the splitter is dragged",
 634       "sig" : "function (_self)\n{\n\n}",
 635       "memberOf" : "",
 636       "example" : "",
 637       "deprecated" : "",
 638       "since" : "",
 639       "see" : "",
 640       "params" : [
 641         {
 642           "name" : "this",
 643           "type" : "Roo.SplitBar",
 644           "desc" : "",
 645           "isOptional" : false
 646         }
 647       ],
 648       "returns" : []
 649     },
 650     {
 651       "name" : "moved",
 652       "type" : "function",
 653       "desc" : "Fires when the splitter is moved",
 654       "sig" : "function (_self, newSize)\n{\n\n}",
 655       "memberOf" : "",
 656       "example" : "",
 657       "deprecated" : "",
 658       "since" : "",
 659       "see" : "",
 660       "params" : [
 661         {
 662           "name" : "this",
 663           "type" : "Roo.SplitBar",
 664           "desc" : "",
 665           "isOptional" : false
 666         },
 667         {
 668           "name" : "newSize",
 669           "type" : "Number",
 670           "desc" : "the new width or height",
 671           "isOptional" : false
 672         }
 673       ],
 674       "returns" : []
 675     }
 676   ]
 677 }