git.roojs.org Git - roojs1/blob - docs/symbols/Roo.SplitBar.json

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