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