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

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