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

   1 {
   2   "name" : "Roo.bootstrap.PagingToolbar",
   3   "augments" : [
   4     "Roo.bootstrap.nav.Simplebar",
   5     "Roo.bootstrap.nav.Bar",
   6     "Roo.bootstrap.Component",
   7     "Roo.Component",
   8     "Roo.util.Observable"
   9   ],
  10   "childClasses" : {  },
  11   "tree_children" : [],
  12   "tree_parent" : [],
  13   "desc" : "A specialized toolbar that is bound to a {@link Roo.data.Store} and provides automatic paging controls.",
  14   "isSingleton" : false,
  15   "isStatic" : false,
  16   "isBuiltin" : false,
  17   "isAbstract" : false,
  18   "isBuilderTop" : false,
  19   "memberOf" : "PagingToolbar",
  20   "example" : "",
  21   "deprecated" : "",
  22   "since" : "",
  23   "see" : "",
  24   "params" : [
  25     {
  26       "name" : "config",
  27       "type" : "Object",
  28       "desc" : "The config object",
  29       "isOptional" : false
  30     },
  31     {
  32       "name" : "store",
  33       "type" : "Roo.data.Store",
  34       "desc" : "",
  35       "isOptional" : false
  36     }
  37   ],
  38   "returns" : [],
  39   "throws" : "",
  40   "requires" : "",
  41   "config" : [
  42     {
  43       "name" : "listeners",
  44       "type" : "Object",
  45       "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>",
  46       "memberOf" : "Roo.util.Observable",
  47       "isOptional" : false,
  48       "optvalues" : []
  49     },
  50     {
  51       "name" : "tooltip",
  52       "type" : "string",
  53       "desc" : "Text for the tooltip",
  54       "memberOf" : "Roo.bootstrap.Component",
  55       "isOptional" : false,
  56       "optvalues" : []
  57     },
  58     {
  59       "name" : "container_method",
  60       "type" : "string",
  61       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
  62       "memberOf" : "Roo.bootstrap.Component",
  63       "isOptional" : false,
  64       "optvalues" : []
  65     },
  66     {
  67       "name" : "visibilityEl",
  68       "type" : "string|object",
  69       "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
  70       "memberOf" : "Roo.bootstrap.Component",
  71       "isOptional" : false,
  72       "optvalues" : [
  73         "el",
  74         "parent"
  75       ]
  76     },
  77     {
  78       "name" : "inverse",
  79       "type" : "Boolean",
  80       "desc" : "is inverted color",
  81       "memberOf" : "Roo.bootstrap.nav.Simplebar",
  82       "isOptional" : false,
  83       "optvalues" : []
  84     },
  85     {
  86       "name" : "align",
  87       "type" : "String",
  88       "desc" : "t) alignme",
  89       "memberOf" : "Roo.bootstrap.nav.Simplebar",
  90       "isOptional" : false,
  91       "optvalues" : [
  92         "left",
  93         "right"
  94       ]
  95     },
  96     {
  97       "name" : "buttons[]",
  98       "type" : "Roo.bootstrap.Button",
  99       "desc" : "Buttons for the toolbar",
 100       "memberOf" : "",
 101       "isOptional" : false,
 102       "optvalues" : []
 103     },
 104     {
 105       "name" : "pageSize",
 106       "type" : "Number",
 107       "desc" : "The number of records to display per page (defaults to 20)",
 108       "memberOf" : "",
 109       "isOptional" : false,
 110       "optvalues" : []
 111     },
 112     {
 113       "name" : "can_build_overlaid",
 114       "type" : "Boolean",
 115       "desc" : "True if element can be rebuild from a HTML page",
 116       "memberOf" : "Roo.bootstrap.Component",
 117       "isOptional" : false,
 118       "optvalues" : []
 119     },
 120     {
 121       "name" : "hideMode",
 122       "type" : "String",
 123       "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",
 124       "memberOf" : "Roo.Component",
 125       "isOptional" : false,
 126       "optvalues" : [
 127         "display",
 128         "visibility"
 129       ]
 130     },
 131     {
 132       "name" : "store",
 133       "type" : "Roo.data.Store",
 134       "desc" : "The underlying data store providing the paged data",
 135       "memberOf" : "",
 136       "isOptional" : false,
 137       "optvalues" : []
 138     },
 139     {
 140       "name" : "tag",
 141       "type" : "String",
 142       "desc" : "v) default is n",
 143       "memberOf" : "Roo.bootstrap.nav.Simplebar",
 144       "isOptional" : false,
 145       "optvalues" : [
 146         "header",
 147         "footer",
 148         "nav",
 149         "div"
 150       ]
 151     },
 152     {
 153       "name" : "style",
 154       "type" : "String",
 155       "desc" : "any extra css",
 156       "memberOf" : "Roo.bootstrap.Component",
 157       "isOptional" : false,
 158       "optvalues" : []
 159     },
 160     {
 161       "name" : "allowDomMove",
 162       "type" : "Boolean",
 163       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 164       "memberOf" : "Roo.Component",
 165       "isOptional" : false,
 166       "optvalues" : []
 167     },
 168     {
 169       "name" : "container",
 170       "type" : "String/HTMLElement/Element",
 171       "desc" : "container The id or element that will contain the toolbar",
 172       "memberOf" : "",
 173       "isOptional" : false,
 174       "optvalues" : []
 175     },
 176     {
 177       "name" : "cls",
 178       "type" : "String",
 179       "desc" : "css class",
 180       "memberOf" : "Roo.bootstrap.Component",
 181       "isOptional" : false,
 182       "optvalues" : []
 183     },
 184     {
 185       "name" : "arrangement",
 186       "type" : "Boolean",
 187       "desc" : "stacked | justified",
 188       "memberOf" : "Roo.bootstrap.nav.Simplebar",
 189       "isOptional" : false,
 190       "optvalues" : []
 191     },
 192     {
 193       "name" : "loadMask",
 194       "type" : "Boolean",
 195       "desc" : "e) loadMask on the b",
 196       "memberOf" : "Roo.bootstrap.nav.Simplebar",
 197       "isOptional" : false,
 198       "optvalues" : [
 199         "true",
 200         "false"
 201       ]
 202     },
 203     {
 204       "name" : "xattr",
 205       "type" : "Object",
 206       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
 207       "memberOf" : "Roo.bootstrap.Component",
 208       "isOptional" : false,
 209       "optvalues" : []
 210     },
 211     {
 212       "name" : "actionMode",
 213       "type" : "String",
 214       "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",
 215       "memberOf" : "Roo.Component",
 216       "isOptional" : false,
 217       "optvalues" : []
 218     },
 219     {
 220       "name" : "emptyMsg",
 221       "type" : "String",
 222       "desc" : "The message to display when no records are found (defaults to \"No data to display\")",
 223       "memberOf" : "",
 224       "isOptional" : false,
 225       "optvalues" : []
 226     },
 227     {
 228       "name" : "main",
 229       "type" : "Boolean",
 230       "desc" : "e) main nav bar? default fal",
 231       "memberOf" : "Roo.bootstrap.nav.Simplebar",
 232       "isOptional" : false,
 233       "optvalues" : [
 234         "true",
 235         "false"
 236       ]
 237     },
 238     {
 239       "name" : "displayInfo",
 240       "type" : "Boolean",
 241       "desc" : "True to display the displayMsg (defaults to false)",
 242       "memberOf" : "",
 243       "isOptional" : false,
 244       "optvalues" : []
 245     },
 246     {
 247       "name" : "displayMsg",
 248       "type" : "String",
 249       "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
 250       "memberOf" : "",
 251       "isOptional" : false,
 252       "optvalues" : []
 253     },
 254     {
 255       "name" : "dataId",
 256       "type" : "string",
 257       "desc" : "cutomer id",
 258       "memberOf" : "Roo.bootstrap.Component",
 259       "isOptional" : false,
 260       "optvalues" : []
 261     },
 262     {
 263       "name" : "type",
 264       "type" : "String",
 265       "desc" : "",
 266       "memberOf" : "Roo.bootstrap.nav.Simplebar",
 267       "isOptional" : false,
 268       "optvalues" : [
 269         "nav",
 270         "pills",
 271         "tabs"
 272       ]
 273     },
 274     {
 275       "name" : "weight",
 276       "type" : "String",
 277       "desc" : "e) default is ligh",
 278       "memberOf" : "Roo.bootstrap.nav.Simplebar",
 279       "isOptional" : false,
 280       "optvalues" : [
 281         "light",
 282         "primary",
 283         "secondary",
 284         "success",
 285         "danger",
 286         "warning",
 287         "info",
 288         "dark",
 289         "white"
 290       ]
 291     },
 292     {
 293       "name" : "name",
 294       "type" : "string",
 295       "desc" : "Specifies name attribute",
 296       "memberOf" : "Roo.bootstrap.Component",
 297       "isOptional" : false,
 298       "optvalues" : []
 299     },
 300     {
 301       "name" : "disableClass",
 302       "type" : "String",
 303       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 304       "memberOf" : "Roo.Component",
 305       "isOptional" : false,
 306       "optvalues" : []
 307     }
 308   ],
 309   "methods" : [
 310     {
 311       "name" : "unbind",
 312       "type" : "function",
 313       "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}",
 314       "sig" : "(store)",
 315       "static" : false,
 316       "memberOf" : "",
 317       "isStatic" : false,
 318       "isConstructor" : false,
 319       "isPrivate" : false,
 320       "example" : "",
 321       "deprecated" : "",
 322       "since" : "",
 323       "see" : "",
 324       "exceptions" : "",
 325       "requires" : "",
 326       "params" : [
 327         {
 328           "name" : "store",
 329           "type" : "Roo.data.Store",
 330           "desc" : "The data store to unbind",
 331           "isOptional" : false
 332         }
 333       ],
 334       "returns" : []
 335     },
 336     {
 337       "name" : "bind",
 338       "type" : "function",
 339       "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}",
 340       "sig" : "(store)",
 341       "static" : false,
 342       "memberOf" : "",
 343       "isStatic" : false,
 344       "isConstructor" : false,
 345       "isPrivate" : false,
 346       "example" : "",
 347       "deprecated" : "",
 348       "since" : "",
 349       "see" : "",
 350       "exceptions" : "",
 351       "requires" : "",
 352       "params" : [
 353         {
 354           "name" : "store",
 355           "type" : "Roo.data.Store",
 356           "desc" : "The data store to bind",
 357           "isOptional" : false
 358         }
 359       ],
 360       "returns" : []
 361     },
 362     {
 363       "name" : "collapse",
 364       "type" : "function",
 365       "desc" : "Collapse the navbar pulldown",
 366       "sig" : "()\n{\n\n}",
 367       "static" : false,
 368       "memberOf" : "Roo.bootstrap.nav.Bar",
 369       "isStatic" : false,
 370       "isConstructor" : false,
 371       "isPrivate" : false,
 372       "example" : "",
 373       "deprecated" : "",
 374       "since" : "",
 375       "see" : "",
 376       "exceptions" : "",
 377       "requires" : "",
 378       "params" : [],
 379       "returns" : []
 380     },
 381     {
 382       "name" : "expand",
 383       "type" : "function",
 384       "desc" : "Expand the navbar pulldown",
 385       "sig" : "()\n{\n\n}",
 386       "static" : false,
 387       "memberOf" : "Roo.bootstrap.nav.Bar",
 388       "isStatic" : false,
 389       "isConstructor" : false,
 390       "isPrivate" : false,
 391       "example" : "",
 392       "deprecated" : "",
 393       "since" : "",
 394       "see" : "",
 395       "exceptions" : "",
 396       "requires" : "",
 397       "params" : [],
 398       "returns" : []
 399     },
 400     {
 401       "name" : "tooltipEl",
 402       "type" : "function",
 403       "desc" : "Fetch the element to display the tooltip on.",
 404       "sig" : "()\n{\n\n}",
 405       "static" : false,
 406       "memberOf" : "Roo.bootstrap.Component",
 407       "isStatic" : false,
 408       "isConstructor" : false,
 409       "isPrivate" : false,
 410       "example" : "",
 411       "deprecated" : "",
 412       "since" : "",
 413       "see" : "",
 414       "exceptions" : "",
 415       "requires" : "",
 416       "params" : [],
 417       "returns" : [
 418         {
 419           "name" : "",
 420           "type" : "Roo.Element",
 421           "desc" : "defaults to this.el"
 422         }
 423       ]
 424     },
 425     {
 426       "name" : "hide",
 427       "type" : "function",
 428       "desc" : "Hide a component - adds 'hidden' class",
 429       "sig" : "()\n{\n\n}",
 430       "static" : false,
 431       "memberOf" : "Roo.bootstrap.Component",
 432       "isStatic" : false,
 433       "isConstructor" : false,
 434       "isPrivate" : false,
 435       "example" : "",
 436       "deprecated" : "",
 437       "since" : "",
 438       "see" : "",
 439       "exceptions" : "",
 440       "requires" : "",
 441       "params" : [],
 442       "returns" : []
 443     },
 444     {
 445       "name" : "show",
 446       "type" : "function",
 447       "desc" : "Show a component - removes 'hidden' class",
 448       "sig" : "()\n{\n\n}",
 449       "static" : false,
 450       "memberOf" : "Roo.bootstrap.Component",
 451       "isStatic" : false,
 452       "isConstructor" : false,
 453       "isPrivate" : false,
 454       "example" : "",
 455       "deprecated" : "",
 456       "since" : "",
 457       "see" : "",
 458       "exceptions" : "",
 459       "requires" : "",
 460       "params" : [],
 461       "returns" : []
 462     },
 463     {
 464       "name" : "setVisibilityEl",
 465       "type" : "function",
 466       "desc" : "Set the element that will be used to show or hide",
 467       "sig" : "()\n{\n\n}",
 468       "static" : false,
 469       "memberOf" : "Roo.bootstrap.Component",
 470       "isStatic" : false,
 471       "isConstructor" : false,
 472       "isPrivate" : false,
 473       "example" : "",
 474       "deprecated" : "",
 475       "since" : "",
 476       "see" : "",
 477       "exceptions" : "",
 478       "requires" : "",
 479       "params" : [],
 480       "returns" : []
 481     },
 482     {
 483       "name" : "getVisibilityEl",
 484       "type" : "function",
 485       "desc" : "Get the element that will be used to show or hide",
 486       "sig" : "()\n{\n\n}",
 487       "static" : false,
 488       "memberOf" : "Roo.bootstrap.Component",
 489       "isStatic" : false,
 490       "isConstructor" : false,
 491       "isPrivate" : false,
 492       "example" : "",
 493       "deprecated" : "",
 494       "since" : "",
 495       "see" : "",
 496       "exceptions" : "",
 497       "requires" : "",
 498       "params" : [],
 499       "returns" : []
 500     },
 501     {
 502       "name" : "initEvents",
 503       "type" : "function",
 504       "desc" : "Initialize Events for the element",
 505       "sig" : "()\n{\n\n}",
 506       "static" : false,
 507       "memberOf" : "Roo.bootstrap.Component",
 508       "isStatic" : false,
 509       "isConstructor" : false,
 510       "isPrivate" : false,
 511       "example" : "",
 512       "deprecated" : "",
 513       "since" : "",
 514       "see" : "",
 515       "exceptions" : "",
 516       "requires" : "",
 517       "params" : [],
 518       "returns" : []
 519     },
 520     {
 521       "name" : "getChildContainer",
 522       "type" : "function",
 523       "desc" : "Fetch the element to add children to",
 524       "sig" : "()\n{\n\n}",
 525       "static" : false,
 526       "memberOf" : "Roo.bootstrap.Component",
 527       "isStatic" : false,
 528       "isConstructor" : false,
 529       "isPrivate" : false,
 530       "example" : "",
 531       "deprecated" : "",
 532       "since" : "",
 533       "see" : "",
 534       "exceptions" : "",
 535       "requires" : "",
 536       "params" : [],
 537       "returns" : [
 538         {
 539           "name" : "",
 540           "type" : "Roo.Element",
 541           "desc" : "defaults to this.el"
 542         }
 543       ]
 544     },
 545     {
 546       "name" : "getId",
 547       "type" : "function",
 548       "desc" : "Returns the id of this component.",
 549       "sig" : "()\n{\n\n}",
 550       "static" : false,
 551       "memberOf" : "Roo.Component",
 552       "isStatic" : false,
 553       "isConstructor" : false,
 554       "isPrivate" : false,
 555       "example" : "",
 556       "deprecated" : "",
 557       "since" : "",
 558       "see" : "",
 559       "exceptions" : "",
 560       "requires" : "",
 561       "params" : [],
 562       "returns" : [
 563         {
 564           "name" : "",
 565           "type" : "String",
 566           "desc" : ""
 567         }
 568       ]
 569     },
 570     {
 571       "name" : "render",
 572       "type" : "function",
 573       "desc" : "If this is a lazy rendering component, render it to its container element.",
 574       "sig" : "(container)",
 575       "static" : false,
 576       "memberOf" : "Roo.Component",
 577       "isStatic" : false,
 578       "isConstructor" : false,
 579       "isPrivate" : false,
 580       "example" : "",
 581       "deprecated" : "",
 582       "since" : "",
 583       "see" : "",
 584       "exceptions" : "",
 585       "requires" : "",
 586       "params" : [
 587         {
 588           "name" : "container",
 589           "type" : "String/HTMLElement/Element",
 590           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 591           "isOptional" : false
 592         }
 593       ],
 594       "returns" : []
 595     },
 596     {
 597       "name" : "destroy",
 598       "type" : "function",
 599       "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}.",
 600       "sig" : "()\n{\n\n}",
 601       "static" : false,
 602       "memberOf" : "Roo.Component",
 603       "isStatic" : false,
 604       "isConstructor" : false,
 605       "isPrivate" : false,
 606       "example" : "",
 607       "deprecated" : "",
 608       "since" : "",
 609       "see" : "",
 610       "exceptions" : "",
 611       "requires" : "",
 612       "params" : [],
 613       "returns" : []
 614     },
 615     {
 616       "name" : "isVisible",
 617       "type" : "function",
 618       "desc" : "Returns true if this component is visible.",
 619       "sig" : "()\n{\n\n}",
 620       "static" : false,
 621       "memberOf" : "Roo.Component",
 622       "isStatic" : false,
 623       "isConstructor" : false,
 624       "isPrivate" : false,
 625       "example" : "",
 626       "deprecated" : "",
 627       "since" : "",
 628       "see" : "",
 629       "exceptions" : "",
 630       "requires" : "",
 631       "params" : [],
 632       "returns" : []
 633     },
 634     {
 635       "name" : "setDisabled",
 636       "type" : "function",
 637       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 638       "sig" : "(disabled)",
 639       "static" : false,
 640       "memberOf" : "Roo.Component",
 641       "isStatic" : false,
 642       "isConstructor" : false,
 643       "isPrivate" : false,
 644       "example" : "",
 645       "deprecated" : "",
 646       "since" : "",
 647       "see" : "",
 648       "exceptions" : "",
 649       "requires" : "",
 650       "params" : [
 651         {
 652           "name" : "disabled",
 653           "type" : "Boolean",
 654           "desc" : "",
 655           "isOptional" : false
 656         }
 657       ],
 658       "returns" : []
 659     },
 660     {
 661       "name" : "focus",
 662       "type" : "function",
 663       "desc" : "Try to focus this component.",
 664       "sig" : "(selectText)",
 665       "static" : false,
 666       "memberOf" : "Roo.Component",
 667       "isStatic" : false,
 668       "isConstructor" : false,
 669       "isPrivate" : false,
 670       "example" : "",
 671       "deprecated" : "",
 672       "since" : "",
 673       "see" : "",
 674       "exceptions" : "",
 675       "requires" : "",
 676       "params" : [
 677         {
 678           "name" : "selectText",
 679           "type" : "Boolean",
 680           "desc" : "True to also select the text in this component (if applicable)",
 681           "isOptional" : false
 682         }
 683       ],
 684       "returns" : [
 685         {
 686           "name" : "",
 687           "type" : "Roo.Component",
 688           "desc" : "this"
 689         }
 690       ]
 691     },
 692     {
 693       "name" : "enable",
 694       "type" : "function",
 695       "desc" : "Enable this component.",
 696       "sig" : "()\n{\n\n}",
 697       "static" : false,
 698       "memberOf" : "Roo.Component",
 699       "isStatic" : false,
 700       "isConstructor" : false,
 701       "isPrivate" : false,
 702       "example" : "",
 703       "deprecated" : "",
 704       "since" : "",
 705       "see" : "",
 706       "exceptions" : "",
 707       "requires" : "",
 708       "params" : [],
 709       "returns" : [
 710         {
 711           "name" : "",
 712           "type" : "Roo.Component",
 713           "desc" : "this"
 714         }
 715       ]
 716     },
 717     {
 718       "name" : "setVisible",
 719       "type" : "function",
 720       "desc" : "Convenience function to hide or show this component by boolean.",
 721       "sig" : "(visible)",
 722       "static" : false,
 723       "memberOf" : "Roo.Component",
 724       "isStatic" : false,
 725       "isConstructor" : false,
 726       "isPrivate" : false,
 727       "example" : "",
 728       "deprecated" : "",
 729       "since" : "",
 730       "see" : "",
 731       "exceptions" : "",
 732       "requires" : "",
 733       "params" : [
 734         {
 735           "name" : "visible",
 736           "type" : "Boolean",
 737           "desc" : "True to show, false to hide",
 738           "isOptional" : false
 739         }
 740       ],
 741       "returns" : [
 742         {
 743           "name" : "",
 744           "type" : "Roo.Component",
 745           "desc" : "this"
 746         }
 747       ]
 748     },
 749     {
 750       "name" : "disable",
 751       "type" : "function",
 752       "desc" : "Disable this component.",
 753       "sig" : "()\n{\n\n}",
 754       "static" : false,
 755       "memberOf" : "Roo.Component",
 756       "isStatic" : false,
 757       "isConstructor" : false,
 758       "isPrivate" : false,
 759       "example" : "",
 760       "deprecated" : "",
 761       "since" : "",
 762       "see" : "",
 763       "exceptions" : "",
 764       "requires" : "",
 765       "params" : [],
 766       "returns" : [
 767         {
 768           "name" : "",
 769           "type" : "Roo.Component",
 770           "desc" : "this"
 771         }
 772       ]
 773     },
 774     {
 775       "name" : "getEl",
 776       "type" : "function",
 777       "desc" : "Returns the underlying {@link Roo.Element}.",
 778       "sig" : "()\n{\n\n}",
 779       "static" : false,
 780       "memberOf" : "Roo.Component",
 781       "isStatic" : false,
 782       "isConstructor" : false,
 783       "isPrivate" : false,
 784       "example" : "",
 785       "deprecated" : "",
 786       "since" : "",
 787       "see" : "",
 788       "exceptions" : "",
 789       "requires" : "",
 790       "params" : [],
 791       "returns" : [
 792         {
 793           "name" : "",
 794           "type" : "Roo.Element",
 795           "desc" : "The element"
 796         }
 797       ]
 798     },
 799     {
 800       "name" : "purgeListeners",
 801       "type" : "function",
 802       "desc" : "Removes all listeners for this object",
 803       "sig" : "()\n{\n\n}",
 804       "static" : false,
 805       "memberOf" : "Roo.util.Observable",
 806       "isStatic" : false,
 807       "isConstructor" : false,
 808       "isPrivate" : false,
 809       "example" : "",
 810       "deprecated" : "",
 811       "since" : "",
 812       "see" : "",
 813       "exceptions" : "",
 814       "requires" : "",
 815       "params" : [],
 816       "returns" : []
 817     },
 818     {
 819       "name" : "on",
 820       "type" : "function",
 821       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 822       "sig" : "(eventName, handler, scope, options)",
 823       "static" : false,
 824       "memberOf" : "Roo.util.Observable",
 825       "isStatic" : false,
 826       "isConstructor" : false,
 827       "isPrivate" : false,
 828       "example" : "",
 829       "deprecated" : "",
 830       "since" : "",
 831       "see" : "",
 832       "exceptions" : "",
 833       "requires" : "",
 834       "params" : [
 835         {
 836           "name" : "eventName",
 837           "type" : "String",
 838           "desc" : "The type of event to listen for",
 839           "isOptional" : false
 840         },
 841         {
 842           "name" : "handler",
 843           "type" : "Function",
 844           "desc" : "The method the event invokes",
 845           "isOptional" : false
 846         },
 847         {
 848           "name" : "scope",
 849           "type" : "Object",
 850           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 851           "isOptional" : false
 852         },
 853         {
 854           "name" : "options",
 855           "type" : "Object",
 856           "desc" : "(optional)",
 857           "isOptional" : false
 858         }
 859       ],
 860       "returns" : []
 861     },
 862     {
 863       "name" : "un",
 864       "type" : "function",
 865       "desc" : "Removes a listener (shorthand for removeListener)",
 866       "sig" : "(eventName, handler, scope)",
 867       "static" : false,
 868       "memberOf" : "Roo.util.Observable",
 869       "isStatic" : false,
 870       "isConstructor" : false,
 871       "isPrivate" : false,
 872       "example" : "",
 873       "deprecated" : "",
 874       "since" : "",
 875       "see" : "",
 876       "exceptions" : "",
 877       "requires" : "",
 878       "params" : [
 879         {
 880           "name" : "eventName",
 881           "type" : "String",
 882           "desc" : "The type of event to listen for",
 883           "isOptional" : false
 884         },
 885         {
 886           "name" : "handler",
 887           "type" : "Function",
 888           "desc" : "The handler to remove",
 889           "isOptional" : false
 890         },
 891         {
 892           "name" : "scope",
 893           "type" : "Object",
 894           "desc" : "(optional) The scope (this object) for the handler",
 895           "isOptional" : false
 896         }
 897       ],
 898       "returns" : []
 899     },
 900     {
 901       "name" : "addEvents",
 902       "type" : "function",
 903       "desc" : "Used to define events on this Observable",
 904       "sig" : "(object)",
 905       "static" : false,
 906       "memberOf" : "Roo.util.Observable",
 907       "isStatic" : false,
 908       "isConstructor" : false,
 909       "isPrivate" : false,
 910       "example" : "",
 911       "deprecated" : "",
 912       "since" : "",
 913       "see" : "",
 914       "exceptions" : "",
 915       "requires" : "",
 916       "params" : [
 917         {
 918           "name" : "object",
 919           "type" : "Object",
 920           "desc" : "The object with the events defined",
 921           "isOptional" : false
 922         }
 923       ],
 924       "returns" : []
 925     },
 926     {
 927       "name" : "releaseCapture",
 928       "type" : "function",
 929       "desc" : "Removes <b>all</b> added captures from the Observable.",
 930       "sig" : "(o)",
 931       "static" : true,
 932       "memberOf" : "Roo.util.Observable",
 933       "isStatic" : true,
 934       "isConstructor" : false,
 935       "isPrivate" : false,
 936       "example" : "",
 937       "deprecated" : "",
 938       "since" : "",
 939       "see" : "",
 940       "exceptions" : "",
 941       "requires" : "",
 942       "params" : [
 943         {
 944           "name" : "o",
 945           "type" : "Observable",
 946           "desc" : "The Observable to release",
 947           "isOptional" : false
 948         }
 949       ],
 950       "returns" : []
 951     },
 952     {
 953       "name" : "removeListener",
 954       "type" : "function",
 955       "desc" : "Removes a listener",
 956       "sig" : "(eventName, handler, scope)",
 957       "static" : false,
 958       "memberOf" : "Roo.util.Observable",
 959       "isStatic" : false,
 960       "isConstructor" : false,
 961       "isPrivate" : false,
 962       "example" : "",
 963       "deprecated" : "",
 964       "since" : "",
 965       "see" : "",
 966       "exceptions" : "",
 967       "requires" : "",
 968       "params" : [
 969         {
 970           "name" : "eventName",
 971           "type" : "String",
 972           "desc" : "The type of event to listen for",
 973           "isOptional" : false
 974         },
 975         {
 976           "name" : "handler",
 977           "type" : "Function",
 978           "desc" : "The handler to remove",
 979           "isOptional" : false
 980         },
 981         {
 982           "name" : "scope",
 983           "type" : "Object",
 984           "desc" : "(optional) The scope (this object) for the handler",
 985           "isOptional" : false
 986         }
 987       ],
 988       "returns" : []
 989     },
 990     {
 991       "name" : "fireEvent",
 992       "type" : "function",
 993       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 994       "sig" : "(eventName, args)",
 995       "static" : false,
 996       "memberOf" : "Roo.util.Observable",
 997       "isStatic" : false,
 998       "isConstructor" : false,
 999       "isPrivate" : false,
1000       "example" : "",
1001       "deprecated" : "",
1002       "since" : "",
1003       "see" : "",
1004       "exceptions" : "",
1005       "requires" : "",
1006       "params" : [
1007         {
1008           "name" : "eventName",
1009           "type" : "String",
1010           "desc" : "",
1011           "isOptional" : false
1012         },
1013         {
1014           "name" : "args",
1015           "type" : "Object...",
1016           "desc" : "Variable number of parameters are passed to handlers",
1017           "isOptional" : false
1018         }
1019       ],
1020       "returns" : [
1021         {
1022           "name" : "",
1023           "type" : "Boolean",
1024           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1025         }
1026       ]
1027     },
1028     {
1029       "name" : "hasListener",
1030       "type" : "function",
1031       "desc" : "Checks to see if this object has any listeners for a specified event",
1032       "sig" : "(eventName)",
1033       "static" : false,
1034       "memberOf" : "Roo.util.Observable",
1035       "isStatic" : false,
1036       "isConstructor" : false,
1037       "isPrivate" : false,
1038       "example" : "",
1039       "deprecated" : "",
1040       "since" : "",
1041       "see" : "",
1042       "exceptions" : "",
1043       "requires" : "",
1044       "params" : [
1045         {
1046           "name" : "eventName",
1047           "type" : "String",
1048           "desc" : "The name of the event to check for",
1049           "isOptional" : false
1050         }
1051       ],
1052       "returns" : [
1053         {
1054           "name" : "",
1055           "type" : "Boolean",
1056           "desc" : "True if the event is being listened for, else false"
1057         }
1058       ]
1059     },
1060     {
1061       "name" : "capture",
1062       "type" : "function",
1063       "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.",
1064       "sig" : "(o, fn, scope)",
1065       "static" : true,
1066       "memberOf" : "Roo.util.Observable",
1067       "isStatic" : true,
1068       "isConstructor" : false,
1069       "isPrivate" : false,
1070       "example" : "",
1071       "deprecated" : "",
1072       "since" : "",
1073       "see" : "",
1074       "exceptions" : "",
1075       "requires" : "",
1076       "params" : [
1077         {
1078           "name" : "o",
1079           "type" : "Observable",
1080           "desc" : "The Observable to capture",
1081           "isOptional" : false
1082         },
1083         {
1084           "name" : "fn",
1085           "type" : "Function",
1086           "desc" : "The function to call",
1087           "isOptional" : false
1088         },
1089         {
1090           "name" : "scope",
1091           "type" : "Object",
1092           "desc" : "(optional) The scope (this object) for the fn",
1093           "isOptional" : false
1094         }
1095       ],
1096       "returns" : []
1097     },
1098     {
1099       "name" : "addListener",
1100       "type" : "function",
1101       "desc" : "Appends an event handler to this component",
1102       "sig" : "(eventName, handler, scope, options)",
1103       "static" : false,
1104       "memberOf" : "Roo.util.Observable",
1105       "isStatic" : false,
1106       "isConstructor" : false,
1107       "isPrivate" : false,
1108       "example" : "",
1109       "deprecated" : "",
1110       "since" : "",
1111       "see" : "",
1112       "exceptions" : "",
1113       "requires" : "",
1114       "params" : [
1115         {
1116           "name" : "eventName",
1117           "type" : "String",
1118           "desc" : "The type of event to listen for",
1119           "isOptional" : false
1120         },
1121         {
1122           "name" : "handler",
1123           "type" : "Function",
1124           "desc" : "The method the event invokes",
1125           "isOptional" : false
1126         },
1127         {
1128           "name" : "scope",
1129           "type" : "Object",
1130           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1131           "isOptional" : false
1132         },
1133         {
1134           "name" : "options",
1135           "type" : "Object",
1136           "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>",
1137           "isOptional" : false
1138         }
1139       ],
1140       "returns" : []
1141     }
1142   ],
1143   "events" : [
1144     {
1145       "name" : "beforetoggle",
1146       "type" : "function",
1147       "desc" : "Fire before toggle the menu",
1148       "sig" : "function (e)\n{\n\n}",
1149       "memberOf" : "Roo.bootstrap.nav.Bar",
1150       "example" : "",
1151       "deprecated" : "",
1152       "since" : "",
1153       "see" : "",
1154       "params" : [
1155         {
1156           "name" : "e",
1157           "type" : "Roo.EventObject",
1158           "desc" : "",
1159           "isOptional" : false
1160         }
1161       ],
1162       "returns" : []
1163     },
1164     {
1165       "name" : "childrenrendered",
1166       "type" : "function",
1167       "desc" : "Fires when the children have been rendered..",
1168       "sig" : "function (_self)\n{\n\n}",
1169       "memberOf" : "Roo.bootstrap.Component",
1170       "example" : "",
1171       "deprecated" : "",
1172       "since" : "",
1173       "see" : "",
1174       "params" : [
1175         {
1176           "name" : "this",
1177           "type" : "Roo.bootstrap.Component",
1178           "desc" : "",
1179           "isOptional" : false
1180         }
1181       ],
1182       "returns" : []
1183     },
1184     {
1185       "name" : "beforerender",
1186       "type" : "function",
1187       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1188       "sig" : "function (_self)\n{\n\n}",
1189       "memberOf" : "Roo.Component",
1190       "example" : "",
1191       "deprecated" : "",
1192       "since" : "",
1193       "see" : "",
1194       "params" : [
1195         {
1196           "name" : "this",
1197           "type" : "Roo.Component",
1198           "desc" : "",
1199           "isOptional" : false
1200         }
1201       ],
1202       "returns" : []
1203     },
1204     {
1205       "name" : "disable",
1206       "type" : "function",
1207       "desc" : "Fires after the component is disabled.",
1208       "sig" : "function (_self)\n{\n\n}",
1209       "memberOf" : "Roo.Component",
1210       "example" : "",
1211       "deprecated" : "",
1212       "since" : "",
1213       "see" : "",
1214       "params" : [
1215         {
1216           "name" : "this",
1217           "type" : "Roo.Component",
1218           "desc" : "",
1219           "isOptional" : false
1220         }
1221       ],
1222       "returns" : []
1223     },
1224     {
1225       "name" : "render",
1226       "type" : "function",
1227       "desc" : "Fires after the component is rendered.",
1228       "sig" : "function (_self)\n{\n\n}",
1229       "memberOf" : "Roo.Component",
1230       "example" : "",
1231       "deprecated" : "",
1232       "since" : "",
1233       "see" : "",
1234       "params" : [
1235         {
1236           "name" : "this",
1237           "type" : "Roo.Component",
1238           "desc" : "",
1239           "isOptional" : false
1240         }
1241       ],
1242       "returns" : []
1243     },
1244     {
1245       "name" : "destroy",
1246       "type" : "function",
1247       "desc" : "Fires after the component is destroyed.",
1248       "sig" : "function (_self)\n{\n\n}",
1249       "memberOf" : "Roo.Component",
1250       "example" : "",
1251       "deprecated" : "",
1252       "since" : "",
1253       "see" : "",
1254       "params" : [
1255         {
1256           "name" : "this",
1257           "type" : "Roo.Component",
1258           "desc" : "",
1259           "isOptional" : false
1260         }
1261       ],
1262       "returns" : []
1263     },
1264     {
1265       "name" : "hide",
1266       "type" : "function",
1267       "desc" : "Fires after the component is hidden.",
1268       "sig" : "function (_self)\n{\n\n}",
1269       "memberOf" : "Roo.Component",
1270       "example" : "",
1271       "deprecated" : "",
1272       "since" : "",
1273       "see" : "",
1274       "params" : [
1275         {
1276           "name" : "this",
1277           "type" : "Roo.Component",
1278           "desc" : "",
1279           "isOptional" : false
1280         }
1281       ],
1282       "returns" : []
1283     },
1284     {
1285       "name" : "beforehide",
1286       "type" : "function",
1287       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1288       "sig" : "function (_self)\n{\n\n}",
1289       "memberOf" : "Roo.Component",
1290       "example" : "",
1291       "deprecated" : "",
1292       "since" : "",
1293       "see" : "",
1294       "params" : [
1295         {
1296           "name" : "this",
1297           "type" : "Roo.Component",
1298           "desc" : "",
1299           "isOptional" : false
1300         }
1301       ],
1302       "returns" : []
1303     },
1304     {
1305       "name" : "show",
1306       "type" : "function",
1307       "desc" : "Fires after the component is shown.",
1308       "sig" : "function (_self)\n{\n\n}",
1309       "memberOf" : "Roo.Component",
1310       "example" : "",
1311       "deprecated" : "",
1312       "since" : "",
1313       "see" : "",
1314       "params" : [
1315         {
1316           "name" : "this",
1317           "type" : "Roo.Component",
1318           "desc" : "",
1319           "isOptional" : false
1320         }
1321       ],
1322       "returns" : []
1323     },
1324     {
1325       "name" : "beforeshow",
1326       "type" : "function",
1327       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1328       "sig" : "function (_self)\n{\n\n}",
1329       "memberOf" : "Roo.Component",
1330       "example" : "",
1331       "deprecated" : "",
1332       "since" : "",
1333       "see" : "",
1334       "params" : [
1335         {
1336           "name" : "this",
1337           "type" : "Roo.Component",
1338           "desc" : "",
1339           "isOptional" : false
1340         }
1341       ],
1342       "returns" : []
1343     },
1344     {
1345       "name" : "enable",
1346       "type" : "function",
1347       "desc" : "Fires after the component is enabled.",
1348       "sig" : "function (_self)\n{\n\n}",
1349       "memberOf" : "Roo.Component",
1350       "example" : "",
1351       "deprecated" : "",
1352       "since" : "",
1353       "see" : "",
1354       "params" : [
1355         {
1356           "name" : "this",
1357           "type" : "Roo.Component",
1358           "desc" : "",
1359           "isOptional" : false
1360         }
1361       ],
1362       "returns" : []
1363     },
1364     {
1365       "name" : "beforedestroy",
1366       "type" : "function",
1367       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1368       "sig" : "function (_self)\n{\n\n}",
1369       "memberOf" : "Roo.Component",
1370       "example" : "",
1371       "deprecated" : "",
1372       "since" : "",
1373       "see" : "",
1374       "params" : [
1375         {
1376           "name" : "this",
1377           "type" : "Roo.Component",
1378           "desc" : "",
1379           "isOptional" : false
1380         }
1381       ],
1382       "returns" : []
1383     }
1384   ]
1385 }