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

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