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

   1 {
   2   "name" : "Roo.BoxComponent",
   3   "augments" : [
   4     "Roo.Component",
   5     "Roo.util.Observable"
   6   ],
   7   "desc" : "Base class for any visual {@link Roo.Component} that uses a box container.  BoxComponent provides automatic box\nmodel adjustments for sizing and positioning and will work correctly withnin the Component rendering model.  All\ncontainer classes should subclass BoxComponent so that they will work consistently when nested within other Ext\nlayout containers.",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "memberOf" : "BoxComponent",
  12   "example" : "",
  13   "deprecated" : "",
  14   "since" : "",
  15   "see" : "",
  16   "params" : [
  17     {
  18       "name" : "config",
  19       "type" : "Roo.Element/String/Object",
  20       "desc" : "The configuration options.",
  21       "isOptional" : false
  22     }
  23   ],
  24   "returns" : [],
  25   "config" : [
  26     {
  27       "name" : "listeners",
  28       "type" : "Object",
  29       "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>",
  30       "memberOf" : "Roo.util.Observable",
  31       "optvals" : []
  32     },
  33     {
  34       "name" : "hideMode",
  35       "type" : "String",
  36       "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
  37       "memberOf" : "Roo.Component",
  38       "optvals" : [
  39         "display",
  40         "visibility"
  41       ]
  42     },
  43     {
  44       "name" : "allowDomMove",
  45       "type" : "Boolean",
  46       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
  47       "memberOf" : "Roo.Component",
  48       "optvals" : []
  49     },
  50     {
  51       "name" : "actionMode",
  52       "type" : "String",
  53       "desc" : "which property holds the element that used for  hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
  54       "memberOf" : "Roo.Component",
  55       "optvals" : []
  56     },
  57     {
  58       "name" : "width",
  59       "type" : "Number",
  60       "desc" : "width (optional) size of component",
  61       "memberOf" : "Roo.BoxComponent",
  62       "optvals" : []
  63     },
  64     {
  65       "name" : "height",
  66       "type" : "Number",
  67       "desc" : "height (optional) size of component",
  68       "memberOf" : "Roo.BoxComponent",
  69       "optvals" : []
  70     },
  71     {
  72       "name" : "disableClass",
  73       "type" : "String",
  74       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
  75       "memberOf" : "Roo.Component",
  76       "optvals" : []
  77     }
  78   ],
  79   "methods" : [
  80     {
  81       "name" : "updateBox",
  82       "desc" : "Sets the current box measurements of the component's underlying element.",
  83       "isStatic" : false,
  84       "isConstructor" : false,
  85       "isPrivate" : false,
  86       "memberOf" : "Roo.BoxComponent",
  87       "example" : "",
  88       "deprecated" : "",
  89       "since" : "",
  90       "see" : "",
  91       "params" : [
  92         {
  93           "name" : "box",
  94           "type" : "Object",
  95           "desc" : "An object in the format {x, y, width, height}",
  96           "isOptional" : false
  97         }
  98       ],
  99       "returns" : []
 100     },
 101     {
 102       "name" : "setPagePosition",
 103       "desc" : "Sets the page XY position of the component.  To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
 104       "isStatic" : false,
 105       "isConstructor" : false,
 106       "isPrivate" : false,
 107       "memberOf" : "Roo.BoxComponent",
 108       "example" : "",
 109       "deprecated" : "",
 110       "since" : "",
 111       "see" : "",
 112       "params" : [
 113         {
 114           "name" : "x",
 115           "type" : "Number",
 116           "desc" : "The new x position",
 117           "isOptional" : false
 118         },
 119         {
 120           "name" : "y",
 121           "type" : "Number",
 122           "desc" : "The new y position",
 123           "isOptional" : false
 124         }
 125       ],
 126       "returns" : []
 127     },
 128     {
 129       "name" : "syncSize",
 130       "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
 131       "isStatic" : false,
 132       "isConstructor" : false,
 133       "isPrivate" : false,
 134       "memberOf" : "Roo.BoxComponent",
 135       "example" : "",
 136       "deprecated" : "",
 137       "since" : "",
 138       "see" : "",
 139       "params" : [],
 140       "returns" : []
 141     },
 142     {
 143       "name" : "setSize",
 144       "desc" : "Sets the width and height of the component.  This method fires the resize event.  This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
 145       "isStatic" : false,
 146       "isConstructor" : false,
 147       "isPrivate" : false,
 148       "memberOf" : "Roo.BoxComponent",
 149       "example" : "",
 150       "deprecated" : "",
 151       "since" : "",
 152       "see" : "",
 153       "params" : [
 154         {
 155           "name" : "width",
 156           "type" : "Number/Object",
 157           "desc" : "The new width to set, or a size object in the format {width, height}",
 158           "isOptional" : false
 159         },
 160         {
 161           "name" : "height",
 162           "type" : "Number",
 163           "desc" : "The new height to set (not required if a size object is passed as the first arg)",
 164           "isOptional" : false
 165         }
 166       ],
 167       "returns" : [
 168         {
 169           "name" : "",
 170           "type" : "Roo.BoxComponent",
 171           "desc" : "this"
 172         }
 173       ]
 174     },
 175     {
 176       "name" : "getPosition",
 177       "desc" : "Gets the current XY position of the component's underlying element.",
 178       "isStatic" : false,
 179       "isConstructor" : false,
 180       "isPrivate" : false,
 181       "memberOf" : "Roo.BoxComponent",
 182       "example" : "",
 183       "deprecated" : "",
 184       "since" : "",
 185       "see" : "",
 186       "params" : [
 187         {
 188           "name" : "local",
 189           "type" : "Boolean",
 190           "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
 191           "isOptional" : false
 192         }
 193       ],
 194       "returns" : [
 195         {
 196           "name" : "",
 197           "type" : "Array",
 198           "desc" : "The XY position of the element (e.g., [100, 200])"
 199         }
 200       ]
 201     },
 202     {
 203       "name" : "onResize",
 204       "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
 205       "isStatic" : false,
 206       "isConstructor" : false,
 207       "isPrivate" : false,
 208       "memberOf" : "Roo.BoxComponent",
 209       "example" : "",
 210       "deprecated" : "",
 211       "since" : "",
 212       "see" : "",
 213       "params" : [
 214         {
 215           "name" : "adjWidth",
 216           "type" : "Number",
 217           "desc" : "The box-adjusted width that was set",
 218           "isOptional" : false
 219         },
 220         {
 221           "name" : "adjHeight",
 222           "type" : "Number",
 223           "desc" : "The box-adjusted height that was set",
 224           "isOptional" : false
 225         },
 226         {
 227           "name" : "rawWidth",
 228           "type" : "Number",
 229           "desc" : "The width that was originally specified",
 230           "isOptional" : false
 231         },
 232         {
 233           "name" : "rawHeight",
 234           "type" : "Number",
 235           "desc" : "The height that was originally specified",
 236           "isOptional" : false
 237         }
 238       ],
 239       "returns" : []
 240     },
 241     {
 242       "name" : "getBox",
 243       "desc" : "Gets the current box measurements of the component's underlying element.",
 244       "isStatic" : false,
 245       "isConstructor" : false,
 246       "isPrivate" : false,
 247       "memberOf" : "Roo.BoxComponent",
 248       "example" : "",
 249       "deprecated" : "",
 250       "since" : "",
 251       "see" : "",
 252       "params" : [
 253         {
 254           "name" : "local",
 255           "type" : "Boolean",
 256           "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
 257           "isOptional" : false
 258         }
 259       ],
 260       "returns" : []
 261     },
 262     {
 263       "name" : "getSize",
 264       "desc" : "Gets the current size of the component's underlying element.",
 265       "isStatic" : false,
 266       "isConstructor" : false,
 267       "isPrivate" : false,
 268       "memberOf" : "Roo.BoxComponent",
 269       "example" : "",
 270       "deprecated" : "",
 271       "since" : "",
 272       "see" : "",
 273       "params" : [],
 274       "returns" : [
 275         {
 276           "name" : "",
 277           "type" : "Object",
 278           "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
 279         }
 280       ]
 281     },
 282     {
 283       "name" : "onPosition",
 284       "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
 285       "isStatic" : false,
 286       "isConstructor" : false,
 287       "isPrivate" : false,
 288       "memberOf" : "Roo.BoxComponent",
 289       "example" : "",
 290       "deprecated" : "",
 291       "since" : "",
 292       "see" : "",
 293       "params" : [
 294         {
 295           "name" : "x",
 296           "type" : "Number",
 297           "desc" : "The new x position",
 298           "isOptional" : false
 299         },
 300         {
 301           "name" : "y",
 302           "type" : "Number",
 303           "desc" : "The new y position",
 304           "isOptional" : false
 305         }
 306       ],
 307       "returns" : []
 308     },
 309     {
 310       "name" : "setPosition",
 311       "desc" : "Sets the left and top of the component.  To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
 312       "isStatic" : false,
 313       "isConstructor" : false,
 314       "isPrivate" : false,
 315       "memberOf" : "Roo.BoxComponent",
 316       "example" : "",
 317       "deprecated" : "",
 318       "since" : "",
 319       "see" : "",
 320       "params" : [
 321         {
 322           "name" : "left",
 323           "type" : "Number",
 324           "desc" : "The new left",
 325           "isOptional" : false
 326         },
 327         {
 328           "name" : "top",
 329           "type" : "Number",
 330           "desc" : "The new top",
 331           "isOptional" : false
 332         }
 333       ],
 334       "returns" : []
 335     },
 336     {
 337       "name" : "getId",
 338       "desc" : "Returns the id of this component.",
 339       "isStatic" : false,
 340       "isConstructor" : false,
 341       "isPrivate" : false,
 342       "memberOf" : "Roo.Component",
 343       "example" : "",
 344       "deprecated" : "",
 345       "since" : "",
 346       "see" : "",
 347       "params" : [],
 348       "returns" : [
 349         {
 350           "name" : "",
 351           "type" : "String",
 352           "desc" : ""
 353         }
 354       ]
 355     },
 356     {
 357       "name" : "render",
 358       "desc" : "If this is a lazy rendering component, render it to its container element.",
 359       "isStatic" : false,
 360       "isConstructor" : false,
 361       "isPrivate" : false,
 362       "memberOf" : "Roo.Component",
 363       "example" : "",
 364       "deprecated" : "",
 365       "since" : "",
 366       "see" : "",
 367       "params" : [
 368         {
 369           "name" : "container",
 370           "type" : "String/HTMLElement/Element",
 371           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 372           "isOptional" : false
 373         }
 374       ],
 375       "returns" : []
 376     },
 377     {
 378       "name" : "destroy",
 379       "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
 380       "isStatic" : false,
 381       "isConstructor" : false,
 382       "isPrivate" : false,
 383       "memberOf" : "Roo.Component",
 384       "example" : "",
 385       "deprecated" : "",
 386       "since" : "",
 387       "see" : "",
 388       "params" : [],
 389       "returns" : []
 390     },
 391     {
 392       "name" : "isVisible",
 393       "desc" : "Returns true if this component is visible.",
 394       "isStatic" : false,
 395       "isConstructor" : false,
 396       "isPrivate" : false,
 397       "memberOf" : "Roo.Component",
 398       "example" : "",
 399       "deprecated" : "",
 400       "since" : "",
 401       "see" : "",
 402       "params" : [],
 403       "returns" : []
 404     },
 405     {
 406       "name" : "setDisabled",
 407       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 408       "isStatic" : false,
 409       "isConstructor" : false,
 410       "isPrivate" : false,
 411       "memberOf" : "Roo.Component",
 412       "example" : "",
 413       "deprecated" : "",
 414       "since" : "",
 415       "see" : "",
 416       "params" : [
 417         {
 418           "name" : "disabled",
 419           "type" : "Boolean",
 420           "desc" : "",
 421           "isOptional" : false
 422         }
 423       ],
 424       "returns" : []
 425     },
 426     {
 427       "name" : "hide",
 428       "desc" : "Hide this component.",
 429       "isStatic" : false,
 430       "isConstructor" : false,
 431       "isPrivate" : false,
 432       "memberOf" : "Roo.Component",
 433       "example" : "",
 434       "deprecated" : "",
 435       "since" : "",
 436       "see" : "",
 437       "params" : [],
 438       "returns" : [
 439         {
 440           "name" : "",
 441           "type" : "Roo.Component",
 442           "desc" : "this"
 443         }
 444       ]
 445     },
 446     {
 447       "name" : "focus",
 448       "desc" : "Try to focus this component.",
 449       "isStatic" : false,
 450       "isConstructor" : false,
 451       "isPrivate" : false,
 452       "memberOf" : "Roo.Component",
 453       "example" : "",
 454       "deprecated" : "",
 455       "since" : "",
 456       "see" : "",
 457       "params" : [
 458         {
 459           "name" : "selectText",
 460           "type" : "Boolean",
 461           "desc" : "True to also select the text in this component (if applicable)",
 462           "isOptional" : false
 463         }
 464       ],
 465       "returns" : [
 466         {
 467           "name" : "",
 468           "type" : "Roo.Component",
 469           "desc" : "this"
 470         }
 471       ]
 472     },
 473     {
 474       "name" : "show",
 475       "desc" : "Show this component.",
 476       "isStatic" : false,
 477       "isConstructor" : false,
 478       "isPrivate" : false,
 479       "memberOf" : "Roo.Component",
 480       "example" : "",
 481       "deprecated" : "",
 482       "since" : "",
 483       "see" : "",
 484       "params" : [],
 485       "returns" : [
 486         {
 487           "name" : "",
 488           "type" : "Roo.Component",
 489           "desc" : "this"
 490         }
 491       ]
 492     },
 493     {
 494       "name" : "enable",
 495       "desc" : "Enable this component.",
 496       "isStatic" : false,
 497       "isConstructor" : false,
 498       "isPrivate" : false,
 499       "memberOf" : "Roo.Component",
 500       "example" : "",
 501       "deprecated" : "",
 502       "since" : "",
 503       "see" : "",
 504       "params" : [],
 505       "returns" : [
 506         {
 507           "name" : "",
 508           "type" : "Roo.Component",
 509           "desc" : "this"
 510         }
 511       ]
 512     },
 513     {
 514       "name" : "setVisible",
 515       "desc" : "Convenience function to hide or show this component by boolean.",
 516       "isStatic" : false,
 517       "isConstructor" : false,
 518       "isPrivate" : false,
 519       "memberOf" : "Roo.Component",
 520       "example" : "",
 521       "deprecated" : "",
 522       "since" : "",
 523       "see" : "",
 524       "params" : [
 525         {
 526           "name" : "visible",
 527           "type" : "Boolean",
 528           "desc" : "True to show, false to hide",
 529           "isOptional" : false
 530         }
 531       ],
 532       "returns" : [
 533         {
 534           "name" : "",
 535           "type" : "Roo.Component",
 536           "desc" : "this"
 537         }
 538       ]
 539     },
 540     {
 541       "name" : "disable",
 542       "desc" : "Disable this component.",
 543       "isStatic" : false,
 544       "isConstructor" : false,
 545       "isPrivate" : false,
 546       "memberOf" : "Roo.Component",
 547       "example" : "",
 548       "deprecated" : "",
 549       "since" : "",
 550       "see" : "",
 551       "params" : [],
 552       "returns" : [
 553         {
 554           "name" : "",
 555           "type" : "Roo.Component",
 556           "desc" : "this"
 557         }
 558       ]
 559     },
 560     {
 561       "name" : "getEl",
 562       "desc" : "Returns the underlying {@link Roo.Element}.",
 563       "isStatic" : false,
 564       "isConstructor" : false,
 565       "isPrivate" : false,
 566       "memberOf" : "Roo.Component",
 567       "example" : "",
 568       "deprecated" : "",
 569       "since" : "",
 570       "see" : "",
 571       "params" : [],
 572       "returns" : [
 573         {
 574           "name" : "",
 575           "type" : "Roo.Element",
 576           "desc" : "The element"
 577         }
 578       ]
 579     },
 580     {
 581       "name" : "purgeListeners",
 582       "desc" : "Removes all listeners for this object",
 583       "isStatic" : false,
 584       "isConstructor" : false,
 585       "isPrivate" : false,
 586       "memberOf" : "Roo.util.Observable",
 587       "example" : "",
 588       "deprecated" : "",
 589       "since" : "",
 590       "see" : "",
 591       "params" : [],
 592       "returns" : []
 593     },
 594     {
 595       "name" : "on",
 596       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 597       "isStatic" : false,
 598       "isConstructor" : false,
 599       "isPrivate" : false,
 600       "memberOf" : "Roo.util.Observable",
 601       "example" : "",
 602       "deprecated" : "",
 603       "since" : "",
 604       "see" : "",
 605       "params" : [
 606         {
 607           "name" : "eventName",
 608           "type" : "String",
 609           "desc" : "The type of event to listen for",
 610           "isOptional" : false
 611         },
 612         {
 613           "name" : "handler",
 614           "type" : "Function",
 615           "desc" : "The method the event invokes",
 616           "isOptional" : false
 617         },
 618         {
 619           "name" : "scope",
 620           "type" : "Object",
 621           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 622           "isOptional" : false
 623         },
 624         {
 625           "name" : "options",
 626           "type" : "Object",
 627           "desc" : "(optional)",
 628           "isOptional" : false
 629         }
 630       ],
 631       "returns" : []
 632     },
 633     {
 634       "name" : "un",
 635       "desc" : "Removes a listener (shorthand for removeListener)",
 636       "isStatic" : false,
 637       "isConstructor" : false,
 638       "isPrivate" : false,
 639       "memberOf" : "Roo.util.Observable",
 640       "example" : "",
 641       "deprecated" : "",
 642       "since" : "",
 643       "see" : "",
 644       "params" : [
 645         {
 646           "name" : "eventName",
 647           "type" : "String",
 648           "desc" : "The type of event to listen for",
 649           "isOptional" : false
 650         },
 651         {
 652           "name" : "handler",
 653           "type" : "Function",
 654           "desc" : "The handler to remove",
 655           "isOptional" : false
 656         },
 657         {
 658           "name" : "scope",
 659           "type" : "Object",
 660           "desc" : "(optional) The scope (this object) for the handler",
 661           "isOptional" : false
 662         }
 663       ],
 664       "returns" : []
 665     },
 666     {
 667       "name" : "addEvents",
 668       "desc" : "Used to define events on this Observable",
 669       "isStatic" : false,
 670       "isConstructor" : false,
 671       "isPrivate" : false,
 672       "memberOf" : "Roo.util.Observable",
 673       "example" : "",
 674       "deprecated" : "",
 675       "since" : "",
 676       "see" : "",
 677       "params" : [
 678         {
 679           "name" : "object",
 680           "type" : "Object",
 681           "desc" : "The object with the events defined",
 682           "isOptional" : false
 683         }
 684       ],
 685       "returns" : []
 686     },
 687     {
 688       "name" : "releaseCapture",
 689       "desc" : "Removes <b>all</b> added captures from the Observable.",
 690       "isStatic" : true,
 691       "isConstructor" : false,
 692       "isPrivate" : false,
 693       "memberOf" : "Roo.util.Observable",
 694       "example" : "",
 695       "deprecated" : "",
 696       "since" : "",
 697       "see" : "",
 698       "params" : [
 699         {
 700           "name" : "o",
 701           "type" : "Observable",
 702           "desc" : "The Observable to release",
 703           "isOptional" : false
 704         }
 705       ],
 706       "returns" : []
 707     },
 708     {
 709       "name" : "removeListener",
 710       "desc" : "Removes a listener",
 711       "isStatic" : false,
 712       "isConstructor" : false,
 713       "isPrivate" : false,
 714       "memberOf" : "Roo.util.Observable",
 715       "example" : "",
 716       "deprecated" : "",
 717       "since" : "",
 718       "see" : "",
 719       "params" : [
 720         {
 721           "name" : "eventName",
 722           "type" : "String",
 723           "desc" : "The type of event to listen for",
 724           "isOptional" : false
 725         },
 726         {
 727           "name" : "handler",
 728           "type" : "Function",
 729           "desc" : "The handler to remove",
 730           "isOptional" : false
 731         },
 732         {
 733           "name" : "scope",
 734           "type" : "Object",
 735           "desc" : "(optional) The scope (this object) for the handler",
 736           "isOptional" : false
 737         }
 738       ],
 739       "returns" : []
 740     },
 741     {
 742       "name" : "fireEvent",
 743       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 744       "isStatic" : false,
 745       "isConstructor" : false,
 746       "isPrivate" : false,
 747       "memberOf" : "Roo.util.Observable",
 748       "example" : "",
 749       "deprecated" : "",
 750       "since" : "",
 751       "see" : "",
 752       "params" : [
 753         {
 754           "name" : "eventName",
 755           "type" : "String",
 756           "desc" : "",
 757           "isOptional" : false
 758         },
 759         {
 760           "name" : "args",
 761           "type" : "Object...",
 762           "desc" : "Variable number of parameters are passed to handlers",
 763           "isOptional" : false
 764         }
 765       ],
 766       "returns" : [
 767         {
 768           "name" : "",
 769           "type" : "Boolean",
 770           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 771         }
 772       ]
 773     },
 774     {
 775       "name" : "hasListener",
 776       "desc" : "Checks to see if this object has any listeners for a specified event",
 777       "isStatic" : false,
 778       "isConstructor" : false,
 779       "isPrivate" : false,
 780       "memberOf" : "Roo.util.Observable",
 781       "example" : "",
 782       "deprecated" : "",
 783       "since" : "",
 784       "see" : "",
 785       "params" : [
 786         {
 787           "name" : "eventName",
 788           "type" : "String",
 789           "desc" : "The name of the event to check for",
 790           "isOptional" : false
 791         }
 792       ],
 793       "returns" : [
 794         {
 795           "name" : "",
 796           "type" : "Boolean",
 797           "desc" : "True if the event is being listened for, else false"
 798         }
 799       ]
 800     },
 801     {
 802       "name" : "capture",
 803       "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.",
 804       "isStatic" : true,
 805       "isConstructor" : false,
 806       "isPrivate" : false,
 807       "memberOf" : "Roo.util.Observable",
 808       "example" : "",
 809       "deprecated" : "",
 810       "since" : "",
 811       "see" : "",
 812       "params" : [
 813         {
 814           "name" : "o",
 815           "type" : "Observable",
 816           "desc" : "The Observable to capture",
 817           "isOptional" : false
 818         },
 819         {
 820           "name" : "fn",
 821           "type" : "Function",
 822           "desc" : "The function to call",
 823           "isOptional" : false
 824         },
 825         {
 826           "name" : "scope",
 827           "type" : "Object",
 828           "desc" : "(optional) The scope (this object) for the fn",
 829           "isOptional" : false
 830         }
 831       ],
 832       "returns" : []
 833     },
 834     {
 835       "name" : "addListener",
 836       "desc" : "Appends an event handler to this component",
 837       "isStatic" : false,
 838       "isConstructor" : false,
 839       "isPrivate" : false,
 840       "memberOf" : "Roo.util.Observable",
 841       "example" : "",
 842       "deprecated" : "",
 843       "since" : "",
 844       "see" : "",
 845       "params" : [
 846         {
 847           "name" : "eventName",
 848           "type" : "String",
 849           "desc" : "The type of event to listen for",
 850           "isOptional" : false
 851         },
 852         {
 853           "name" : "handler",
 854           "type" : "Function",
 855           "desc" : "The method the event invokes",
 856           "isOptional" : false
 857         },
 858         {
 859           "name" : "scope",
 860           "type" : "Object",
 861           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 862           "isOptional" : false
 863         },
 864         {
 865           "name" : "options",
 866           "type" : "Object",
 867           "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>",
 868           "isOptional" : false
 869         }
 870       ],
 871       "returns" : []
 872     }
 873   ],
 874   "events" : [
 875     {
 876       "name" : "move",
 877       "desc" : "Fires after the component is moved.",
 878       "memberOf" : "Roo.BoxComponent",
 879       "example" : "",
 880       "deprecated" : "",
 881       "since" : "",
 882       "see" : "",
 883       "params" : [
 884         {
 885           "name" : "this",
 886           "type" : "Roo.Component",
 887           "desc" : "",
 888           "isOptional" : false
 889         },
 890         {
 891           "name" : "x",
 892           "type" : "Number",
 893           "desc" : "The new x position",
 894           "isOptional" : false
 895         },
 896         {
 897           "name" : "y",
 898           "type" : "Number",
 899           "desc" : "The new y position",
 900           "isOptional" : false
 901         }
 902       ],
 903       "returns" : []
 904     },
 905     {
 906       "name" : "resize",
 907       "desc" : "Fires after the component is resized.",
 908       "memberOf" : "Roo.BoxComponent",
 909       "example" : "",
 910       "deprecated" : "",
 911       "since" : "",
 912       "see" : "",
 913       "params" : [
 914         {
 915           "name" : "this",
 916           "type" : "Roo.Component",
 917           "desc" : "",
 918           "isOptional" : false
 919         },
 920         {
 921           "name" : "adjWidth",
 922           "type" : "Number",
 923           "desc" : "The box-adjusted width that was set",
 924           "isOptional" : false
 925         },
 926         {
 927           "name" : "adjHeight",
 928           "type" : "Number",
 929           "desc" : "The box-adjusted height that was set",
 930           "isOptional" : false
 931         },
 932         {
 933           "name" : "rawWidth",
 934           "type" : "Number",
 935           "desc" : "The width that was originally specified",
 936           "isOptional" : false
 937         },
 938         {
 939           "name" : "rawHeight",
 940           "type" : "Number",
 941           "desc" : "The height that was originally specified",
 942           "isOptional" : false
 943         }
 944       ],
 945       "returns" : []
 946     },
 947     {
 948       "name" : "beforerender",
 949       "desc" : "Fires before the component is rendered. Return false to stop the render.",
 950       "memberOf" : "Roo.Component",
 951       "example" : "",
 952       "deprecated" : "",
 953       "since" : "",
 954       "see" : "",
 955       "params" : [
 956         {
 957           "name" : "this",
 958           "type" : "Roo.Component",
 959           "desc" : "",
 960           "isOptional" : false
 961         }
 962       ],
 963       "returns" : []
 964     },
 965     {
 966       "name" : "disable",
 967       "desc" : "Fires after the component is disabled.",
 968       "memberOf" : "Roo.Component",
 969       "example" : "",
 970       "deprecated" : "",
 971       "since" : "",
 972       "see" : "",
 973       "params" : [
 974         {
 975           "name" : "this",
 976           "type" : "Roo.Component",
 977           "desc" : "",
 978           "isOptional" : false
 979         }
 980       ],
 981       "returns" : []
 982     },
 983     {
 984       "name" : "render",
 985       "desc" : "Fires after the component is rendered.",
 986       "memberOf" : "Roo.Component",
 987       "example" : "",
 988       "deprecated" : "",
 989       "since" : "",
 990       "see" : "",
 991       "params" : [
 992         {
 993           "name" : "this",
 994           "type" : "Roo.Component",
 995           "desc" : "",
 996           "isOptional" : false
 997         }
 998       ],
 999       "returns" : []
1000     },
1001     {
1002       "name" : "destroy",
1003       "desc" : "Fires after the component is destroyed.",
1004       "memberOf" : "Roo.Component",
1005       "example" : "",
1006       "deprecated" : "",
1007       "since" : "",
1008       "see" : "",
1009       "params" : [
1010         {
1011           "name" : "this",
1012           "type" : "Roo.Component",
1013           "desc" : "",
1014           "isOptional" : false
1015         }
1016       ],
1017       "returns" : []
1018     },
1019     {
1020       "name" : "hide",
1021       "desc" : "Fires after the component is hidden.",
1022       "memberOf" : "Roo.Component",
1023       "example" : "",
1024       "deprecated" : "",
1025       "since" : "",
1026       "see" : "",
1027       "params" : [
1028         {
1029           "name" : "this",
1030           "type" : "Roo.Component",
1031           "desc" : "",
1032           "isOptional" : false
1033         }
1034       ],
1035       "returns" : []
1036     },
1037     {
1038       "name" : "beforehide",
1039       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1040       "memberOf" : "Roo.Component",
1041       "example" : "",
1042       "deprecated" : "",
1043       "since" : "",
1044       "see" : "",
1045       "params" : [
1046         {
1047           "name" : "this",
1048           "type" : "Roo.Component",
1049           "desc" : "",
1050           "isOptional" : false
1051         }
1052       ],
1053       "returns" : []
1054     },
1055     {
1056       "name" : "show",
1057       "desc" : "Fires after the component is shown.",
1058       "memberOf" : "Roo.Component",
1059       "example" : "",
1060       "deprecated" : "",
1061       "since" : "",
1062       "see" : "",
1063       "params" : [
1064         {
1065           "name" : "this",
1066           "type" : "Roo.Component",
1067           "desc" : "",
1068           "isOptional" : false
1069         }
1070       ],
1071       "returns" : []
1072     },
1073     {
1074       "name" : "beforeshow",
1075       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1076       "memberOf" : "Roo.Component",
1077       "example" : "",
1078       "deprecated" : "",
1079       "since" : "",
1080       "see" : "",
1081       "params" : [
1082         {
1083           "name" : "this",
1084           "type" : "Roo.Component",
1085           "desc" : "",
1086           "isOptional" : false
1087         }
1088       ],
1089       "returns" : []
1090     },
1091     {
1092       "name" : "enable",
1093       "desc" : "Fires after the component is enabled.",
1094       "memberOf" : "Roo.Component",
1095       "example" : "",
1096       "deprecated" : "",
1097       "since" : "",
1098       "see" : "",
1099       "params" : [
1100         {
1101           "name" : "this",
1102           "type" : "Roo.Component",
1103           "desc" : "",
1104           "isOptional" : false
1105         }
1106       ],
1107       "returns" : []
1108     },
1109     {
1110       "name" : "beforedestroy",
1111       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1112       "memberOf" : "Roo.Component",
1113       "example" : "",
1114       "deprecated" : "",
1115       "since" : "",
1116       "see" : "",
1117       "params" : [
1118         {
1119           "name" : "this",
1120           "type" : "Roo.Component",
1121           "desc" : "",
1122           "isOptional" : false
1123         }
1124       ],
1125       "returns" : []
1126     }
1127   ]
1128 }