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