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