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