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