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