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