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