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