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