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