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

   1 {
   2   "name" : "Roo.bootstrap.Table",
   3   "augments" : [
   4     "Roo.bootstrap.Component",
   5     "Roo.Component",
   6     "Roo.util.Observable"
   7   ],
   8   "desc" : "Bootstrap Table class",
   9   "isSingleton" : false,
  10   "isStatic" : false,
  11   "isBuiltin" : false,
  12   "memberOf" : "Table",
  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   ],
  27   "config" : [
  28     {
  29       "name" : "footerShow",
  30       "type" : "Boolean",
  31       "desc" : "generate tfoot, default true",
  32       "memberOf" : "Roo.bootstrap.Table",
  33       "values" : [
  34         "(true",
  35         "false)"
  36       ]
  37     },
  38     {
  39       "name" : "hideMode",
  40       "type" : "String",
  41       "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
  42       "memberOf" : "Roo.Component",
  43       "values" : [
  44         "(display",
  45         "visibility)"
  46       ]
  47     },
  48     {
  49       "name" : "auto_hide_footer",
  50       "type" : "Boolean",
  51       "desc" : "auto hide footer if only one page (default false)",
  52       "memberOf" : "Roo.bootstrap.Table",
  53       "values" : [
  54       ]
  55     },
  56     {
  57       "name" : "scrollBody",
  58       "type" : "Boolean",
  59       "desc" : "default false - body scrolled / fixed header",
  60       "memberOf" : "Roo.bootstrap.Table",
  61       "values" : [
  62         "(true",
  63         "false)"
  64       ]
  65     },
  66     {
  67       "name" : "xattr",
  68       "type" : "Object",
  69       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
  70       "memberOf" : "Roo.bootstrap.Component",
  71       "values" : [
  72       ]
  73     },
  74     {
  75       "name" : "border",
  76       "type" : "Number",
  77       "desc" : "Specifies whether the table cells should have borders or not",
  78       "memberOf" : "Roo.bootstrap.Table",
  79       "values" : [
  80       ]
  81     },
  82     {
  83       "name" : "name",
  84       "type" : "string",
  85       "desc" : "Specifies name attribute",
  86       "memberOf" : "Roo.bootstrap.Component",
  87       "values" : [
  88       ]
  89     },
  90     {
  91       "name" : "width",
  92       "type" : "Number",
  93       "desc" : "Specifies the width of a table",
  94       "memberOf" : "Roo.bootstrap.Table",
  95       "values" : [
  96       ]
  97     },
  98     {
  99       "name" : "bordered",
 100       "type" : "boolean",
 101       "desc" : "Add borders to the table",
 102       "memberOf" : "Roo.bootstrap.Table",
 103       "values" : [
 104       ]
 105     },
 106     {
 107       "name" : "rules",
 108       "type" : "String",
 109       "desc" : "Specifies which parts of the inside borders that should be visible",
 110       "memberOf" : "Roo.bootstrap.Table",
 111       "values" : [
 112       ]
 113     },
 114     {
 115       "name" : "tooltip",
 116       "type" : "string",
 117       "desc" : "Text for the tooltip",
 118       "memberOf" : "Roo.bootstrap.Component",
 119       "values" : [
 120       ]
 121     },
 122     {
 123       "name" : "allowDomMove",
 124       "type" : "Boolean",
 125       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 126       "memberOf" : "Roo.Component",
 127       "values" : [
 128       ]
 129     },
 130     {
 131       "name" : "layout",
 132       "type" : "String",
 133       "desc" : "table layout (auto | fixed | initial | inherit)",
 134       "memberOf" : "Roo.bootstrap.Table",
 135       "values" : [
 136       ]
 137     },
 138     {
 139       "name" : "condensed",
 140       "type" : "boolean",
 141       "desc" : "Format condensed",
 142       "memberOf" : "Roo.bootstrap.Table",
 143       "values" : [
 144       ]
 145     },
 146     {
 147       "name" : "style",
 148       "type" : "String",
 149       "desc" : "any extra css",
 150       "memberOf" : "Roo.bootstrap.Component",
 151       "values" : [
 152       ]
 153     },
 154     {
 155       "name" : "frame",
 156       "type" : "String",
 157       "desc" : "Specifies which parts of the outside borders that should be visible",
 158       "memberOf" : "Roo.bootstrap.Table",
 159       "values" : [
 160       ]
 161     },
 162     {
 163       "name" : "cellSelection",
 164       "type" : "Boolean",
 165       "desc" : "default false",
 166       "memberOf" : "Roo.bootstrap.Table",
 167       "values" : [
 168         "(true",
 169         "false)"
 170       ]
 171     },
 172     {
 173       "name" : "sortable",
 174       "type" : "String",
 175       "desc" : "Specifies that the table should be sortable",
 176       "memberOf" : "Roo.bootstrap.Table",
 177       "values" : [
 178       ]
 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       "values" : [
 186       ]
 187     },
 188     {
 189       "name" : "listeners",
 190       "type" : "Object",
 191       "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>",
 192       "memberOf" : "Roo.util.Observable",
 193       "values" : [
 194       ]
 195     },
 196     {
 197       "name" : "striped",
 198       "type" : "boolean",
 199       "desc" : "Should the rows be alternative striped",
 200       "memberOf" : "Roo.bootstrap.Table",
 201       "values" : [
 202       ]
 203     },
 204     {
 205       "name" : "container_method",
 206       "type" : "string",
 207       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
 208       "memberOf" : "Roo.bootstrap.Component",
 209       "values" : [
 210       ]
 211     },
 212     {
 213       "name" : "cellspacing",
 214       "type" : "Number",
 215       "desc" : "Specifies the space between cells",
 216       "memberOf" : "Roo.bootstrap.Table",
 217       "values" : [
 218       ]
 219     },
 220     {
 221       "name" : "align",
 222       "type" : "String",
 223       "desc" : "Specifies the alignment of a table according to surrounding text",
 224       "memberOf" : "Roo.bootstrap.Table",
 225       "values" : [
 226         "(left",
 227         "center",
 228         "right)"
 229       ]
 230     },
 231     {
 232       "name" : "lazyLoad",
 233       "type" : "Boolean",
 234       "desc" : "auto load data while scrolling to the end (default false)",
 235       "memberOf" : "Roo.bootstrap.Table",
 236       "values" : [
 237       ]
 238     },
 239     {
 240       "name" : "footer",
 241       "type" : "Roo.bootstrap.PagingToolbar",
 242       "desc" : "a paging toolbar",
 243       "memberOf" : "Roo.bootstrap.Table",
 244       "values" : [
 245       ]
 246     },
 247     {
 248       "name" : "cls",
 249       "type" : "String",
 250       "desc" : "table class",
 251       "memberOf" : "Roo.bootstrap.Table",
 252       "values" : [
 253       ]
 254     },
 255     {
 256       "name" : "bgcolor",
 257       "type" : "String",
 258       "desc" : "Specifies the background color for a table",
 259       "memberOf" : "Roo.bootstrap.Table",
 260       "values" : [
 261       ]
 262     },
 263     {
 264       "name" : "headerShow",
 265       "type" : "Boolean",
 266       "desc" : "generate thead, default true",
 267       "memberOf" : "Roo.bootstrap.Table",
 268       "values" : [
 269         "(true",
 270         "false)"
 271       ]
 272     },
 273     {
 274       "name" : "loadMask",
 275       "type" : "Boolean",
 276       "desc" : "default false",
 277       "memberOf" : "Roo.bootstrap.Table",
 278       "values" : [
 279         "(true",
 280         "false)"
 281       ]
 282     },
 283     {
 284       "name" : "hover",
 285       "type" : "boolean",
 286       "desc" : "Add hover highlighting",
 287       "memberOf" : "Roo.bootstrap.Table",
 288       "values" : [
 289       ]
 290     },
 291     {
 292       "name" : "can_build_overlaid",
 293       "type" : "Boolean",
 294       "desc" : "True if element can be rebuild from a HTML page",
 295       "memberOf" : "Roo.bootstrap.Component",
 296       "values" : [
 297       ]
 298     },
 299     {
 300       "name" : "cellpadding",
 301       "type" : "Number",
 302       "desc" : "Specifies the space between the cell wall and the cell content",
 303       "memberOf" : "Roo.bootstrap.Table",
 304       "values" : [
 305       ]
 306     },
 307     {
 308       "name" : "disableClass",
 309       "type" : "String",
 310       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 311       "memberOf" : "Roo.Component",
 312       "values" : [
 313       ]
 314     },
 315     {
 316       "name" : "visibilityEl",
 317       "type" : "string|object",
 318       "desc" : "What element to use for visibility (@see getVisibilityEl())",
 319       "memberOf" : "Roo.bootstrap.Component",
 320       "values" : [
 321         "(el",
 322         "parent)"
 323       ]
 324     },
 325     {
 326       "name" : "dataId",
 327       "type" : "string",
 328       "desc" : "cutomer id",
 329       "memberOf" : "Roo.bootstrap.Component",
 330       "values" : [
 331       ]
 332     },
 333     {
 334       "name" : "summary",
 335       "type" : "String",
 336       "desc" : "Specifies a summary of the content of a table",
 337       "memberOf" : "Roo.bootstrap.Table",
 338       "values" : [
 339       ]
 340     },
 341     {
 342       "name" : "rowSelection",
 343       "type" : "Boolean",
 344       "desc" : "default false",
 345       "memberOf" : "Roo.bootstrap.Table",
 346       "values" : [
 347         "(true",
 348         "false)"
 349       ]
 350     },
 351     {
 352       "name" : "responsive",
 353       "type" : "boolean",
 354       "desc" : "Format condensed",
 355       "memberOf" : "Roo.bootstrap.Table",
 356       "values" : [
 357       ]
 358     }
 359   ],
 360   "methods" : [
 361     {
 362       "name" : "setRowVisibility",
 363       "desc" : "Show or hide a row.",
 364       "isStatic" : false,
 365       "isConstructor" : false,
 366       "isPrivate" : false,
 367       "memberOf" : "Roo.bootstrap.Table",
 368       "example" : "",
 369       "deprecated" : "",
 370       "since" : "",
 371       "see" : "",
 372       "params" : [
 373         {
 374           "name" : "rowIndex",
 375           "type" : "Number",
 376           "desc" : "to show or hide",
 377           "isOptional" : false
 378         },
 379         {
 380           "name" : "state",
 381           "type" : "Boolean",
 382           "desc" : "hide",
 383           "isOptional" : false
 384         }
 385       ],
 386       "returns" : [
 387       ]
 388     },
 389     {
 390       "name" : "getGridEl",
 391       "desc" : "Returns the grid's underlying element = used by panel.Grid",
 392       "isStatic" : false,
 393       "isConstructor" : false,
 394       "isPrivate" : false,
 395       "memberOf" : "Roo.bootstrap.Table",
 396       "example" : "",
 397       "deprecated" : "",
 398       "since" : "",
 399       "see" : "",
 400       "params" : [
 401       ],
 402       "returns" : [
 403         {
 404           "name" : "",
 405           "type" : "Element",
 406           "desc" : "The element"
 407         }
 408       ]
 409     },
 410     {
 411       "name" : "autoSize",
 412       "desc" : "Forces a resize - used by panel.Grid",
 413       "isStatic" : false,
 414       "isConstructor" : false,
 415       "isPrivate" : false,
 416       "memberOf" : "Roo.bootstrap.Table",
 417       "example" : "",
 418       "deprecated" : "",
 419       "since" : "",
 420       "see" : "",
 421       "params" : [
 422       ],
 423       "returns" : [
 424         {
 425           "name" : "",
 426           "type" : "Element",
 427           "desc" : "The element"
 428         }
 429       ]
 430     },
 431     {
 432       "name" : "clear",
 433       "desc" : "Remove all rows",
 434       "isStatic" : false,
 435       "isConstructor" : false,
 436       "isPrivate" : false,
 437       "memberOf" : "Roo.bootstrap.Table",
 438       "example" : "",
 439       "deprecated" : "",
 440       "since" : "",
 441       "see" : "",
 442       "params" : [
 443       ],
 444       "returns" : [
 445       ]
 446     },
 447     {
 448       "name" : "tooltipEl",
 449       "desc" : "Fetch the element to display the tooltip on.",
 450       "isStatic" : false,
 451       "isConstructor" : false,
 452       "isPrivate" : false,
 453       "memberOf" : "Roo.bootstrap.Component",
 454       "example" : "",
 455       "deprecated" : "",
 456       "since" : "",
 457       "see" : "",
 458       "params" : [
 459       ],
 460       "returns" : [
 461         {
 462           "name" : "",
 463           "type" : "Roo.Element",
 464           "desc" : "defaults to this.el"
 465         }
 466       ]
 467     },
 468     {
 469       "name" : "hide",
 470       "desc" : "Hide a component - adds 'hidden' class",
 471       "isStatic" : false,
 472       "isConstructor" : false,
 473       "isPrivate" : false,
 474       "memberOf" : "Roo.bootstrap.Component",
 475       "example" : "",
 476       "deprecated" : "",
 477       "since" : "",
 478       "see" : "",
 479       "params" : [
 480       ],
 481       "returns" : [
 482       ]
 483     },
 484     {
 485       "name" : "show",
 486       "desc" : "Show a component - removes 'hidden' class",
 487       "isStatic" : false,
 488       "isConstructor" : false,
 489       "isPrivate" : false,
 490       "memberOf" : "Roo.bootstrap.Component",
 491       "example" : "",
 492       "deprecated" : "",
 493       "since" : "",
 494       "see" : "",
 495       "params" : [
 496       ],
 497       "returns" : [
 498       ]
 499     },
 500     {
 501       "name" : "setVisibilityEl",
 502       "desc" : "Set the element that will be used to show or hide",
 503       "isStatic" : false,
 504       "isConstructor" : false,
 505       "isPrivate" : false,
 506       "memberOf" : "Roo.bootstrap.Component",
 507       "example" : "",
 508       "deprecated" : "",
 509       "since" : "",
 510       "see" : "",
 511       "params" : [
 512       ],
 513       "returns" : [
 514       ]
 515     },
 516     {
 517       "name" : "getVisibilityEl",
 518       "desc" : "Get the element that will be used to show or hide",
 519       "isStatic" : false,
 520       "isConstructor" : false,
 521       "isPrivate" : false,
 522       "memberOf" : "Roo.bootstrap.Component",
 523       "example" : "",
 524       "deprecated" : "",
 525       "since" : "",
 526       "see" : "",
 527       "params" : [
 528       ],
 529       "returns" : [
 530       ]
 531     },
 532     {
 533       "name" : "initEvents",
 534       "desc" : "Initialize Events for the element",
 535       "isStatic" : false,
 536       "isConstructor" : false,
 537       "isPrivate" : false,
 538       "memberOf" : "Roo.bootstrap.Component",
 539       "example" : "",
 540       "deprecated" : "",
 541       "since" : "",
 542       "see" : "",
 543       "params" : [
 544       ],
 545       "returns" : [
 546       ]
 547     },
 548     {
 549       "name" : "getChildContainer",
 550       "desc" : "Fetch the element to add children to",
 551       "isStatic" : false,
 552       "isConstructor" : false,
 553       "isPrivate" : false,
 554       "memberOf" : "Roo.bootstrap.Component",
 555       "example" : "",
 556       "deprecated" : "",
 557       "since" : "",
 558       "see" : "",
 559       "params" : [
 560       ],
 561       "returns" : [
 562         {
 563           "name" : "",
 564           "type" : "Roo.Element",
 565           "desc" : "defaults to this.el"
 566         }
 567       ]
 568     },
 569     {
 570       "name" : "getId",
 571       "desc" : "Returns the id of this component.",
 572       "isStatic" : false,
 573       "isConstructor" : false,
 574       "isPrivate" : false,
 575       "memberOf" : "Roo.Component",
 576       "example" : "",
 577       "deprecated" : "",
 578       "since" : "",
 579       "see" : "",
 580       "params" : [
 581       ],
 582       "returns" : [
 583         {
 584           "name" : "",
 585           "type" : "String",
 586           "desc" : ""
 587         }
 588       ]
 589     },
 590     {
 591       "name" : "render",
 592       "desc" : "If this is a lazy rendering component, render it to its container element.",
 593       "isStatic" : false,
 594       "isConstructor" : false,
 595       "isPrivate" : false,
 596       "memberOf" : "Roo.Component",
 597       "example" : "",
 598       "deprecated" : "",
 599       "since" : "",
 600       "see" : "",
 601       "params" : [
 602         {
 603           "name" : "container",
 604           "type" : "String/HTMLElement/Element",
 605           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 606           "isOptional" : false
 607         }
 608       ],
 609       "returns" : [
 610       ]
 611     },
 612     {
 613       "name" : "destroy",
 614       "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}.",
 615       "isStatic" : false,
 616       "isConstructor" : false,
 617       "isPrivate" : false,
 618       "memberOf" : "Roo.Component",
 619       "example" : "",
 620       "deprecated" : "",
 621       "since" : "",
 622       "see" : "",
 623       "params" : [
 624       ],
 625       "returns" : [
 626       ]
 627     },
 628     {
 629       "name" : "isVisible",
 630       "desc" : "Returns true if this component is visible.",
 631       "isStatic" : false,
 632       "isConstructor" : false,
 633       "isPrivate" : false,
 634       "memberOf" : "Roo.Component",
 635       "example" : "",
 636       "deprecated" : "",
 637       "since" : "",
 638       "see" : "",
 639       "params" : [
 640       ],
 641       "returns" : [
 642       ]
 643     },
 644     {
 645       "name" : "setDisabled",
 646       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 647       "isStatic" : false,
 648       "isConstructor" : false,
 649       "isPrivate" : false,
 650       "memberOf" : "Roo.Component",
 651       "example" : "",
 652       "deprecated" : "",
 653       "since" : "",
 654       "see" : "",
 655       "params" : [
 656         {
 657           "name" : "disabled",
 658           "type" : "Boolean",
 659           "desc" : "",
 660           "isOptional" : false
 661         }
 662       ],
 663       "returns" : [
 664       ]
 665     },
 666     {
 667       "name" : "focus",
 668       "desc" : "Try to focus this component.",
 669       "isStatic" : false,
 670       "isConstructor" : false,
 671       "isPrivate" : false,
 672       "memberOf" : "Roo.Component",
 673       "example" : "",
 674       "deprecated" : "",
 675       "since" : "",
 676       "see" : "",
 677       "params" : [
 678         {
 679           "name" : "selectText",
 680           "type" : "Boolean",
 681           "desc" : "True to also select the text in this component (if applicable)",
 682           "isOptional" : false
 683         }
 684       ],
 685       "returns" : [
 686         {
 687           "name" : "",
 688           "type" : "Roo.Component",
 689           "desc" : "this"
 690         }
 691       ]
 692     },
 693     {
 694       "name" : "enable",
 695       "desc" : "Enable this component.",
 696       "isStatic" : false,
 697       "isConstructor" : false,
 698       "isPrivate" : false,
 699       "memberOf" : "Roo.Component",
 700       "example" : "",
 701       "deprecated" : "",
 702       "since" : "",
 703       "see" : "",
 704       "params" : [
 705       ],
 706       "returns" : [
 707         {
 708           "name" : "",
 709           "type" : "Roo.Component",
 710           "desc" : "this"
 711         }
 712       ]
 713     },
 714     {
 715       "name" : "setVisible",
 716       "desc" : "Convenience function to hide or show this component by boolean.",
 717       "isStatic" : false,
 718       "isConstructor" : false,
 719       "isPrivate" : false,
 720       "memberOf" : "Roo.Component",
 721       "example" : "",
 722       "deprecated" : "",
 723       "since" : "",
 724       "see" : "",
 725       "params" : [
 726         {
 727           "name" : "visible",
 728           "type" : "Boolean",
 729           "desc" : "True to show, false to hide",
 730           "isOptional" : false
 731         }
 732       ],
 733       "returns" : [
 734         {
 735           "name" : "",
 736           "type" : "Roo.Component",
 737           "desc" : "this"
 738         }
 739       ]
 740     },
 741     {
 742       "name" : "disable",
 743       "desc" : "Disable this component.",
 744       "isStatic" : false,
 745       "isConstructor" : false,
 746       "isPrivate" : false,
 747       "memberOf" : "Roo.Component",
 748       "example" : "",
 749       "deprecated" : "",
 750       "since" : "",
 751       "see" : "",
 752       "params" : [
 753       ],
 754       "returns" : [
 755         {
 756           "name" : "",
 757           "type" : "Roo.Component",
 758           "desc" : "this"
 759         }
 760       ]
 761     },
 762     {
 763       "name" : "getEl",
 764       "desc" : "Returns the underlying {@link Roo.Element}.",
 765       "isStatic" : false,
 766       "isConstructor" : false,
 767       "isPrivate" : false,
 768       "memberOf" : "Roo.Component",
 769       "example" : "",
 770       "deprecated" : "",
 771       "since" : "",
 772       "see" : "",
 773       "params" : [
 774       ],
 775       "returns" : [
 776         {
 777           "name" : "",
 778           "type" : "Roo.Element",
 779           "desc" : "The element"
 780         }
 781       ]
 782     },
 783     {
 784       "name" : "purgeListeners",
 785       "desc" : "Removes all listeners for this object",
 786       "isStatic" : false,
 787       "isConstructor" : false,
 788       "isPrivate" : false,
 789       "memberOf" : "Roo.util.Observable",
 790       "example" : "",
 791       "deprecated" : "",
 792       "since" : "",
 793       "see" : "",
 794       "params" : [
 795       ],
 796       "returns" : [
 797       ]
 798     },
 799     {
 800       "name" : "on",
 801       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 802       "isStatic" : false,
 803       "isConstructor" : false,
 804       "isPrivate" : false,
 805       "memberOf" : "Roo.util.Observable",
 806       "example" : "",
 807       "deprecated" : "",
 808       "since" : "",
 809       "see" : "",
 810       "params" : [
 811         {
 812           "name" : "eventName",
 813           "type" : "String",
 814           "desc" : "The type of event to listen for",
 815           "isOptional" : false
 816         },
 817         {
 818           "name" : "handler",
 819           "type" : "Function",
 820           "desc" : "The method the event invokes",
 821           "isOptional" : false
 822         },
 823         {
 824           "name" : "scope",
 825           "type" : "Object",
 826           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 827           "isOptional" : false
 828         },
 829         {
 830           "name" : "options",
 831           "type" : "Object",
 832           "desc" : "(optional)",
 833           "isOptional" : false
 834         }
 835       ],
 836       "returns" : [
 837       ]
 838     },
 839     {
 840       "name" : "un",
 841       "desc" : "Removes a listener (shorthand for removeListener)",
 842       "isStatic" : false,
 843       "isConstructor" : false,
 844       "isPrivate" : false,
 845       "memberOf" : "Roo.util.Observable",
 846       "example" : "",
 847       "deprecated" : "",
 848       "since" : "",
 849       "see" : "",
 850       "params" : [
 851         {
 852           "name" : "eventName",
 853           "type" : "String",
 854           "desc" : "The type of event to listen for",
 855           "isOptional" : false
 856         },
 857         {
 858           "name" : "handler",
 859           "type" : "Function",
 860           "desc" : "The handler to remove",
 861           "isOptional" : false
 862         },
 863         {
 864           "name" : "scope",
 865           "type" : "Object",
 866           "desc" : "(optional) The scope (this object) for the handler",
 867           "isOptional" : false
 868         }
 869       ],
 870       "returns" : [
 871       ]
 872     },
 873     {
 874       "name" : "addEvents",
 875       "desc" : "Used to define events on this Observable",
 876       "isStatic" : false,
 877       "isConstructor" : false,
 878       "isPrivate" : false,
 879       "memberOf" : "Roo.util.Observable",
 880       "example" : "",
 881       "deprecated" : "",
 882       "since" : "",
 883       "see" : "",
 884       "params" : [
 885         {
 886           "name" : "object",
 887           "type" : "Object",
 888           "desc" : "The object with the events defined",
 889           "isOptional" : false
 890         }
 891       ],
 892       "returns" : [
 893       ]
 894     },
 895     {
 896       "name" : "releaseCapture",
 897       "desc" : "Removes <b>all</b> added captures from the Observable.",
 898       "isStatic" : true,
 899       "isConstructor" : false,
 900       "isPrivate" : false,
 901       "memberOf" : "Roo.util.Observable",
 902       "example" : "",
 903       "deprecated" : "",
 904       "since" : "",
 905       "see" : "",
 906       "params" : [
 907         {
 908           "name" : "o",
 909           "type" : "Observable",
 910           "desc" : "The Observable to release",
 911           "isOptional" : false
 912         }
 913       ],
 914       "returns" : [
 915       ]
 916     },
 917     {
 918       "name" : "removeListener",
 919       "desc" : "Removes a listener",
 920       "isStatic" : false,
 921       "isConstructor" : false,
 922       "isPrivate" : false,
 923       "memberOf" : "Roo.util.Observable",
 924       "example" : "",
 925       "deprecated" : "",
 926       "since" : "",
 927       "see" : "",
 928       "params" : [
 929         {
 930           "name" : "eventName",
 931           "type" : "String",
 932           "desc" : "The type of event to listen for",
 933           "isOptional" : false
 934         },
 935         {
 936           "name" : "handler",
 937           "type" : "Function",
 938           "desc" : "The handler to remove",
 939           "isOptional" : false
 940         },
 941         {
 942           "name" : "scope",
 943           "type" : "Object",
 944           "desc" : "(optional) The scope (this object) for the handler",
 945           "isOptional" : false
 946         }
 947       ],
 948       "returns" : [
 949       ]
 950     },
 951     {
 952       "name" : "fireEvent",
 953       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 954       "isStatic" : false,
 955       "isConstructor" : false,
 956       "isPrivate" : false,
 957       "memberOf" : "Roo.util.Observable",
 958       "example" : "",
 959       "deprecated" : "",
 960       "since" : "",
 961       "see" : "",
 962       "params" : [
 963         {
 964           "name" : "eventName",
 965           "type" : "String",
 966           "desc" : "",
 967           "isOptional" : false
 968         },
 969         {
 970           "name" : "args",
 971           "type" : "Object...",
 972           "desc" : "Variable number of parameters are passed to handlers",
 973           "isOptional" : false
 974         }
 975       ],
 976       "returns" : [
 977         {
 978           "name" : "",
 979           "type" : "Boolean",
 980           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 981         }
 982       ]
 983     },
 984     {
 985       "name" : "hasListener",
 986       "desc" : "Checks to see if this object has any listeners for a specified event",
 987       "isStatic" : false,
 988       "isConstructor" : false,
 989       "isPrivate" : false,
 990       "memberOf" : "Roo.util.Observable",
 991       "example" : "",
 992       "deprecated" : "",
 993       "since" : "",
 994       "see" : "",
 995       "params" : [
 996         {
 997           "name" : "eventName",
 998           "type" : "String",
 999           "desc" : "The name of the event to check for",
1000           "isOptional" : false
1001         }
1002       ],
1003       "returns" : [
1004         {
1005           "name" : "",
1006           "type" : "Boolean",
1007           "desc" : "True if the event is being listened for, else false"
1008         }
1009       ]
1010     },
1011     {
1012       "name" : "capture",
1013       "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.",
1014       "isStatic" : true,
1015       "isConstructor" : false,
1016       "isPrivate" : false,
1017       "memberOf" : "Roo.util.Observable",
1018       "example" : "",
1019       "deprecated" : "",
1020       "since" : "",
1021       "see" : "",
1022       "params" : [
1023         {
1024           "name" : "o",
1025           "type" : "Observable",
1026           "desc" : "The Observable to capture",
1027           "isOptional" : false
1028         },
1029         {
1030           "name" : "fn",
1031           "type" : "Function",
1032           "desc" : "The function to call",
1033           "isOptional" : false
1034         },
1035         {
1036           "name" : "scope",
1037           "type" : "Object",
1038           "desc" : "(optional) The scope (this object) for the fn",
1039           "isOptional" : false
1040         }
1041       ],
1042       "returns" : [
1043       ]
1044     },
1045     {
1046       "name" : "addListener",
1047       "desc" : "Appends an event handler to this component",
1048       "isStatic" : false,
1049       "isConstructor" : false,
1050       "isPrivate" : false,
1051       "memberOf" : "Roo.util.Observable",
1052       "example" : "",
1053       "deprecated" : "",
1054       "since" : "",
1055       "see" : "",
1056       "params" : [
1057         {
1058           "name" : "eventName",
1059           "type" : "String",
1060           "desc" : "The type of event to listen for",
1061           "isOptional" : false
1062         },
1063         {
1064           "name" : "handler",
1065           "type" : "Function",
1066           "desc" : "The method the event invokes",
1067           "isOptional" : false
1068         },
1069         {
1070           "name" : "scope",
1071           "type" : "Object",
1072           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1073           "isOptional" : false
1074         },
1075         {
1076           "name" : "options",
1077           "type" : "Object",
1078           "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>",
1079           "isOptional" : false
1080         }
1081       ],
1082       "returns" : [
1083       ]
1084     }
1085   ],
1086   "events" : [
1087     {
1088       "name" : "rowsrendered",
1089       "desc" : "Fires when all the  rows have been rendered",
1090       "memberOf" : "Roo.bootstrap.Table",
1091       "example" : "",
1092       "deprecated" : "",
1093       "since" : "",
1094       "see" : "",
1095       "params" : [
1096         {
1097           "name" : "this",
1098           "type" : "Roo.bootstrap.Table",
1099           "desc" : "",
1100           "isOptional" : false
1101         }
1102       ],
1103       "returns" : [
1104       ]
1105     },
1106     {
1107       "name" : "headercontextmenu",
1108       "desc" : "Fires when a header is right clicked",
1109       "memberOf" : "Roo.bootstrap.Table",
1110       "example" : "",
1111       "deprecated" : "",
1112       "since" : "",
1113       "see" : "",
1114       "params" : [
1115         {
1116           "name" : "this",
1117           "type" : "Roo.bootstrap.Table",
1118           "desc" : "",
1119           "isOptional" : false
1120         },
1121         {
1122           "name" : "columnIndex",
1123           "type" : "Number",
1124           "desc" : "",
1125           "isOptional" : false
1126         },
1127         {
1128           "name" : "e",
1129           "type" : "Roo.EventObject",
1130           "desc" : "",
1131           "isOptional" : false
1132         }
1133       ],
1134       "returns" : [
1135       ]
1136     },
1137     {
1138       "name" : "rowdblclick",
1139       "desc" : "Fires when a row is double clicked",
1140       "memberOf" : "Roo.bootstrap.Table",
1141       "example" : "",
1142       "deprecated" : "",
1143       "since" : "",
1144       "see" : "",
1145       "params" : [
1146         {
1147           "name" : "this",
1148           "type" : "Roo.bootstrap.Table",
1149           "desc" : "",
1150           "isOptional" : false
1151         },
1152         {
1153           "name" : "el",
1154           "type" : "Roo.Element",
1155           "desc" : "",
1156           "isOptional" : false
1157         },
1158         {
1159           "name" : "rowIndex",
1160           "type" : "Number",
1161           "desc" : "",
1162           "isOptional" : false
1163         },
1164         {
1165           "name" : "e",
1166           "type" : "Roo.EventObject",
1167           "desc" : "",
1168           "isOptional" : false
1169         }
1170       ],
1171       "returns" : [
1172       ]
1173     },
1174     {
1175       "name" : "contextmenu",
1176       "desc" : "The raw contextmenu event for the entire grid.",
1177       "memberOf" : "Roo.bootstrap.Table",
1178       "example" : "",
1179       "deprecated" : "",
1180       "since" : "",
1181       "see" : "",
1182       "params" : [
1183         {
1184           "name" : "e",
1185           "type" : "Roo.EventObject",
1186           "desc" : "",
1187           "isOptional" : false
1188         }
1189       ],
1190       "returns" : [
1191       ]
1192     },
1193     {
1194       "name" : "rowcontextmenu",
1195       "desc" : "Fires when a row is right clicked",
1196       "memberOf" : "Roo.bootstrap.Table",
1197       "example" : "",
1198       "deprecated" : "",
1199       "since" : "",
1200       "see" : "",
1201       "params" : [
1202         {
1203           "name" : "this",
1204           "type" : "Roo.bootstrap.Table",
1205           "desc" : "",
1206           "isOptional" : false
1207         },
1208         {
1209           "name" : "rowIndex",
1210           "type" : "Number",
1211           "desc" : "",
1212           "isOptional" : false
1213         },
1214         {
1215           "name" : "e",
1216           "type" : "Roo.EventObject",
1217           "desc" : "",
1218           "isOptional" : false
1219         }
1220       ],
1221       "returns" : [
1222       ]
1223     },
1224     {
1225       "name" : "cellcontextmenu",
1226       "desc" : "Fires when a cell is right clicked",
1227       "memberOf" : "Roo.bootstrap.Table",
1228       "example" : "",
1229       "deprecated" : "",
1230       "since" : "",
1231       "see" : "",
1232       "params" : [
1233         {
1234           "name" : "this",
1235           "type" : "Roo.bootstrap.Table",
1236           "desc" : "",
1237           "isOptional" : false
1238         },
1239         {
1240           "name" : "rowIndex",
1241           "type" : "Number",
1242           "desc" : "",
1243           "isOptional" : false
1244         },
1245         {
1246           "name" : "cellIndex",
1247           "type" : "Number",
1248           "desc" : "",
1249           "isOptional" : false
1250         },
1251         {
1252           "name" : "e",
1253           "type" : "Roo.EventObject",
1254           "desc" : "",
1255           "isOptional" : false
1256         }
1257       ],
1258       "returns" : [
1259       ]
1260     },
1261     {
1262       "name" : "celldblclick",
1263       "desc" : "Fires when a cell is double clicked",
1264       "memberOf" : "Roo.bootstrap.Table",
1265       "example" : "",
1266       "deprecated" : "",
1267       "since" : "",
1268       "see" : "",
1269       "params" : [
1270         {
1271           "name" : "this",
1272           "type" : "Roo.bootstrap.Table",
1273           "desc" : "",
1274           "isOptional" : false
1275         },
1276         {
1277           "name" : "el",
1278           "type" : "Roo.Element",
1279           "desc" : "",
1280           "isOptional" : false
1281         },
1282         {
1283           "name" : "rowIndex",
1284           "type" : "Number",
1285           "desc" : "",
1286           "isOptional" : false
1287         },
1288         {
1289           "name" : "columnIndex",
1290           "type" : "Number",
1291           "desc" : "",
1292           "isOptional" : false
1293         },
1294         {
1295           "name" : "e",
1296           "type" : "Roo.EventObject",
1297           "desc" : "",
1298           "isOptional" : false
1299         }
1300       ],
1301       "returns" : [
1302       ]
1303     },
1304     {
1305       "name" : "rowclass",
1306       "desc" : "Fires when a row is rendered, so you can change add a style to it.",
1307       "memberOf" : "Roo.bootstrap.Table",
1308       "example" : "",
1309       "deprecated" : "",
1310       "since" : "",
1311       "see" : "",
1312       "params" : [
1313         {
1314           "name" : "this",
1315           "type" : "Roo.bootstrap.Table",
1316           "desc" : "",
1317           "isOptional" : false
1318         },
1319         {
1320           "name" : "rowcfg",
1321           "type" : "Object",
1322           "desc" : "contains record  rowIndex colIndex and rowClass - set rowClass to add a style.",
1323           "isOptional" : false
1324         }
1325       ],
1326       "returns" : [
1327       ]
1328     },
1329     {
1330       "name" : "mouseover",
1331       "desc" : "Fires when a mouseover occur",
1332       "memberOf" : "Roo.bootstrap.Table",
1333       "example" : "",
1334       "deprecated" : "",
1335       "since" : "",
1336       "see" : "",
1337       "params" : [
1338         {
1339           "name" : "this",
1340           "type" : "Roo.bootstrap.Table",
1341           "desc" : "",
1342           "isOptional" : false
1343         },
1344         {
1345           "name" : "el",
1346           "type" : "Roo.Element",
1347           "desc" : "",
1348           "isOptional" : false
1349         },
1350         {
1351           "name" : "rowIndex",
1352           "type" : "Number",
1353           "desc" : "",
1354           "isOptional" : false
1355         },
1356         {
1357           "name" : "columnIndex",
1358           "type" : "Number",
1359           "desc" : "",
1360           "isOptional" : false
1361         },
1362         {
1363           "name" : "e",
1364           "type" : "Roo.EventObject",
1365           "desc" : "",
1366           "isOptional" : false
1367         }
1368       ],
1369       "returns" : [
1370       ]
1371     },
1372     {
1373       "name" : "mouseout",
1374       "desc" : "Fires when a mouseout occur",
1375       "memberOf" : "Roo.bootstrap.Table",
1376       "example" : "",
1377       "deprecated" : "",
1378       "since" : "",
1379       "see" : "",
1380       "params" : [
1381         {
1382           "name" : "this",
1383           "type" : "Roo.bootstrap.Table",
1384           "desc" : "",
1385           "isOptional" : false
1386         },
1387         {
1388           "name" : "el",
1389           "type" : "Roo.Element",
1390           "desc" : "",
1391           "isOptional" : false
1392         },
1393         {
1394           "name" : "rowIndex",
1395           "type" : "Number",
1396           "desc" : "",
1397           "isOptional" : false
1398         },
1399         {
1400           "name" : "columnIndex",
1401           "type" : "Number",
1402           "desc" : "",
1403           "isOptional" : false
1404         },
1405         {
1406           "name" : "e",
1407           "type" : "Roo.EventObject",
1408           "desc" : "",
1409           "isOptional" : false
1410         }
1411       ],
1412       "returns" : [
1413       ]
1414     },
1415     {
1416       "name" : "cellclick",
1417       "desc" : "Fires when a cell is clicked",
1418       "memberOf" : "Roo.bootstrap.Table",
1419       "example" : "",
1420       "deprecated" : "",
1421       "since" : "",
1422       "see" : "",
1423       "params" : [
1424         {
1425           "name" : "this",
1426           "type" : "Roo.bootstrap.Table",
1427           "desc" : "",
1428           "isOptional" : false
1429         },
1430         {
1431           "name" : "el",
1432           "type" : "Roo.Element",
1433           "desc" : "",
1434           "isOptional" : false
1435         },
1436         {
1437           "name" : "rowIndex",
1438           "type" : "Number",
1439           "desc" : "",
1440           "isOptional" : false
1441         },
1442         {
1443           "name" : "columnIndex",
1444           "type" : "Number",
1445           "desc" : "",
1446           "isOptional" : false
1447         },
1448         {
1449           "name" : "e",
1450           "type" : "Roo.EventObject",
1451           "desc" : "",
1452           "isOptional" : false
1453         }
1454       ],
1455       "returns" : [
1456       ]
1457     },
1458     {
1459       "name" : "rowclick",
1460       "desc" : "Fires when a row is clicked",
1461       "memberOf" : "Roo.bootstrap.Table",
1462       "example" : "",
1463       "deprecated" : "",
1464       "since" : "",
1465       "see" : "",
1466       "params" : [
1467         {
1468           "name" : "this",
1469           "type" : "Roo.bootstrap.Table",
1470           "desc" : "",
1471           "isOptional" : false
1472         },
1473         {
1474           "name" : "el",
1475           "type" : "Roo.Element",
1476           "desc" : "",
1477           "isOptional" : false
1478         },
1479         {
1480           "name" : "rowIndex",
1481           "type" : "Number",
1482           "desc" : "",
1483           "isOptional" : false
1484         },
1485         {
1486           "name" : "e",
1487           "type" : "Roo.EventObject",
1488           "desc" : "",
1489           "isOptional" : false
1490         }
1491       ],
1492       "returns" : [
1493       ]
1494     },
1495     {
1496       "name" : "childrenrendered",
1497       "desc" : "Fires when the children have been rendered..",
1498       "memberOf" : "Roo.bootstrap.Component",
1499       "example" : "",
1500       "deprecated" : "",
1501       "since" : "",
1502       "see" : "",
1503       "params" : [
1504         {
1505           "name" : "this",
1506           "type" : "Roo.bootstrap.Component",
1507           "desc" : "",
1508           "isOptional" : false
1509         }
1510       ],
1511       "returns" : [
1512       ]
1513     },
1514     {
1515       "name" : "beforerender",
1516       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1517       "memberOf" : "Roo.Component",
1518       "example" : "",
1519       "deprecated" : "",
1520       "since" : "",
1521       "see" : "",
1522       "params" : [
1523         {
1524           "name" : "this",
1525           "type" : "Roo.Component",
1526           "desc" : "",
1527           "isOptional" : false
1528         }
1529       ],
1530       "returns" : [
1531       ]
1532     },
1533     {
1534       "name" : "disable",
1535       "desc" : "Fires after the component is disabled.",
1536       "memberOf" : "Roo.Component",
1537       "example" : "",
1538       "deprecated" : "",
1539       "since" : "",
1540       "see" : "",
1541       "params" : [
1542         {
1543           "name" : "this",
1544           "type" : "Roo.Component",
1545           "desc" : "",
1546           "isOptional" : false
1547         }
1548       ],
1549       "returns" : [
1550       ]
1551     },
1552     {
1553       "name" : "render",
1554       "desc" : "Fires after the component is rendered.",
1555       "memberOf" : "Roo.Component",
1556       "example" : "",
1557       "deprecated" : "",
1558       "since" : "",
1559       "see" : "",
1560       "params" : [
1561         {
1562           "name" : "this",
1563           "type" : "Roo.Component",
1564           "desc" : "",
1565           "isOptional" : false
1566         }
1567       ],
1568       "returns" : [
1569       ]
1570     },
1571     {
1572       "name" : "destroy",
1573       "desc" : "Fires after the component is destroyed.",
1574       "memberOf" : "Roo.Component",
1575       "example" : "",
1576       "deprecated" : "",
1577       "since" : "",
1578       "see" : "",
1579       "params" : [
1580         {
1581           "name" : "this",
1582           "type" : "Roo.Component",
1583           "desc" : "",
1584           "isOptional" : false
1585         }
1586       ],
1587       "returns" : [
1588       ]
1589     },
1590     {
1591       "name" : "hide",
1592       "desc" : "Fires after the component is hidden.",
1593       "memberOf" : "Roo.Component",
1594       "example" : "",
1595       "deprecated" : "",
1596       "since" : "",
1597       "see" : "",
1598       "params" : [
1599         {
1600           "name" : "this",
1601           "type" : "Roo.Component",
1602           "desc" : "",
1603           "isOptional" : false
1604         }
1605       ],
1606       "returns" : [
1607       ]
1608     },
1609     {
1610       "name" : "beforehide",
1611       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1612       "memberOf" : "Roo.Component",
1613       "example" : "",
1614       "deprecated" : "",
1615       "since" : "",
1616       "see" : "",
1617       "params" : [
1618         {
1619           "name" : "this",
1620           "type" : "Roo.Component",
1621           "desc" : "",
1622           "isOptional" : false
1623         }
1624       ],
1625       "returns" : [
1626       ]
1627     },
1628     {
1629       "name" : "show",
1630       "desc" : "Fires after the component is shown.",
1631       "memberOf" : "Roo.Component",
1632       "example" : "",
1633       "deprecated" : "",
1634       "since" : "",
1635       "see" : "",
1636       "params" : [
1637         {
1638           "name" : "this",
1639           "type" : "Roo.Component",
1640           "desc" : "",
1641           "isOptional" : false
1642         }
1643       ],
1644       "returns" : [
1645       ]
1646     },
1647     {
1648       "name" : "beforeshow",
1649       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1650       "memberOf" : "Roo.Component",
1651       "example" : "",
1652       "deprecated" : "",
1653       "since" : "",
1654       "see" : "",
1655       "params" : [
1656         {
1657           "name" : "this",
1658           "type" : "Roo.Component",
1659           "desc" : "",
1660           "isOptional" : false
1661         }
1662       ],
1663       "returns" : [
1664       ]
1665     },
1666     {
1667       "name" : "enable",
1668       "desc" : "Fires after the component is enabled.",
1669       "memberOf" : "Roo.Component",
1670       "example" : "",
1671       "deprecated" : "",
1672       "since" : "",
1673       "see" : "",
1674       "params" : [
1675         {
1676           "name" : "this",
1677           "type" : "Roo.Component",
1678           "desc" : "",
1679           "isOptional" : false
1680         }
1681       ],
1682       "returns" : [
1683       ]
1684     },
1685     {
1686       "name" : "beforedestroy",
1687       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1688       "memberOf" : "Roo.Component",
1689       "example" : "",
1690       "deprecated" : "",
1691       "since" : "",
1692       "see" : "",
1693       "params" : [
1694         {
1695           "name" : "this",
1696           "type" : "Roo.Component",
1697           "desc" : "",
1698           "isOptional" : false
1699         }
1700       ],
1701       "returns" : [
1702       ]
1703     }
1704   ]
1705 }