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