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