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

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