git.roojs.org Git - roojs1/blob - docs/symbols/Roo.menu.CheckItem.json

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