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