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