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

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