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