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

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