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