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

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