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

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