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

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