disable tidy serializer when autoclean is disabled.
[roojs1] / docs / symbols / Roo.form.Signature.json
1 {
2   "name" : "Roo.form.Signature",
3   "augments" : [
4     "Roo.form.Field",
5     "Roo.BoxComponent",
6     "Roo.Component",
7     "Roo.util.Observable"
8   ],
9   "childClasses" : {  },
10   "tree_children" : [],
11   "tree_parent" : [],
12   "desc" : "Signature field.",
13   "isSingleton" : false,
14   "isStatic" : false,
15   "isBuiltin" : false,
16   "isAbstract" : false,
17   "isBuilderTop" : false,
18   "memberOf" : "Signature",
19   "example" : "",
20   "deprecated" : "",
21   "since" : "",
22   "see" : "",
23   "params" : [
24     {
25       "name" : "config",
26       "type" : "Object",
27       "desc" : "Configuration options",
28       "isOptional" : false
29     }
30   ],
31   "returns" : [],
32   "throws" : "",
33   "requires" : "",
34   "config" : [
35     {
36       "name" : "inputType",
37       "type" : "String",
38       "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
39       "memberOf" : "Roo.form.Field",
40       "isOptional" : false,
41       "optvals" : []
42     },
43     {
44       "name" : "listeners",
45       "type" : "Object",
46       "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>",
47       "memberOf" : "Roo.util.Observable",
48       "isOptional" : false,
49       "optvals" : []
50     },
51     {
52       "name" : "msgFx",
53       "type" : "String",
54       "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
55       "memberOf" : "Roo.form.Field",
56       "isOptional" : false,
57       "optvals" : []
58     },
59     {
60       "name" : "fieldLabel",
61       "type" : "String",
62       "desc" : "Label to use when rendering a form.",
63       "memberOf" : "Roo.form.Field",
64       "isOptional" : false,
65       "optvals" : []
66     },
67     {
68       "name" : "validationDelay",
69       "type" : "Number",
70       "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
71       "memberOf" : "Roo.form.Field",
72       "isOptional" : false,
73       "optvals" : []
74     },
75     {
76       "name" : "msgTarget",
77       "type" : "String",
78       "desc" : "The location where error text should display.  Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n</pre>",
79       "memberOf" : "Roo.form.Field",
80       "isOptional" : false,
81       "optvals" : []
82     },
83     {
84       "name" : "hideMode",
85       "type" : "String",
86       "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",
87       "memberOf" : "Roo.Component",
88       "isOptional" : false,
89       "optvals" : [
90         "display",
91         "visibility"
92       ]
93     },
94     {
95       "name" : "disabled",
96       "type" : "Boolean",
97       "desc" : "True to disable the field (defaults to false).",
98       "memberOf" : "Roo.form.Field",
99       "isOptional" : false,
100       "optvals" : []
101     },
102     {
103       "name" : "value",
104       "type" : "Mixed",
105       "desc" : "A value to initialize this field with.",
106       "memberOf" : "Roo.form.Field",
107       "isOptional" : false,
108       "optvals" : []
109     },
110     {
111       "name" : "style",
112       "type" : "String",
113       "desc" : "css styles to add to component\neg. text-align:right;",
114       "memberOf" : "Roo.Component",
115       "isOptional" : false,
116       "optvals" : []
117     },
118     {
119       "name" : "allowDomMove",
120       "type" : "Boolean",
121       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
122       "memberOf" : "Roo.Component",
123       "isOptional" : false,
124       "optvals" : []
125     },
126     {
127       "name" : "allowBlank",
128       "type" : "Boolean",
129       "desc" : "False to validate that the value length > 0 (defaults to false)",
130       "memberOf" : "",
131       "isOptional" : false,
132       "optvals" : []
133     },
134     {
135       "name" : "tabIndex",
136       "type" : "Number",
137       "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
138       "memberOf" : "Roo.form.Field",
139       "isOptional" : false,
140       "optvals" : []
141     },
142     {
143       "name" : "readOnly",
144       "type" : "Boolean",
145       "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
146       "memberOf" : "Roo.form.Field",
147       "isOptional" : false,
148       "optvals" : []
149     },
150     {
151       "name" : "invalidClass",
152       "type" : "String",
153       "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
154       "memberOf" : "Roo.form.Field",
155       "isOptional" : false,
156       "optvals" : []
157     },
158     {
159       "name" : "cls",
160       "type" : "String",
161       "desc" : "A CSS class to apply to the field's underlying element.",
162       "memberOf" : "Roo.form.Field",
163       "isOptional" : false,
164       "optvals" : []
165     },
166     {
167       "name" : "autoCreate",
168       "type" : "String/Object",
169       "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
170       "memberOf" : "Roo.form.Field",
171       "isOptional" : false,
172       "optvals" : []
173     },
174     {
175       "name" : "invalidText",
176       "type" : "String",
177       "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
178       "memberOf" : "Roo.form.Field",
179       "isOptional" : false,
180       "optvals" : []
181     },
182     {
183       "name" : "actionMode",
184       "type" : "String",
185       "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",
186       "memberOf" : "Roo.Component",
187       "isOptional" : false,
188       "optvals" : []
189     },
190     {
191       "name" : "width",
192       "type" : "Number",
193       "desc" : "The signature panel width (defaults to 300)",
194       "memberOf" : "",
195       "isOptional" : false,
196       "optvals" : []
197     },
198     {
199       "name" : "labels",
200       "type" : "Object",
201       "desc" : "Label to use when rendering a form.\ndefaults to \nlabels : { \n     clear : \"Clear\",\n     confirm : \"Confirm\"\n }",
202       "memberOf" : "",
203       "isOptional" : false,
204       "optvals" : []
205     },
206     {
207       "name" : "validateOnBlur",
208       "type" : "Boolean",
209       "desc" : "Whether the field should validate when it loses focus (defaults to true).",
210       "memberOf" : "Roo.form.Field",
211       "isOptional" : false,
212       "optvals" : []
213     },
214     {
215       "name" : "validationEvent",
216       "type" : "String/Boolean",
217       "desc" : "The event that should initiate field validation. Set to false to disable\n      automatic validation (defaults to \"keyup\").",
218       "memberOf" : "Roo.form.Field",
219       "isOptional" : false,
220       "optvals" : []
221     },
222     {
223       "name" : "height",
224       "type" : "Number",
225       "desc" : "The signature panel height (defaults to 100)",
226       "memberOf" : "",
227       "isOptional" : false,
228       "optvals" : []
229     },
230     {
231       "name" : "name",
232       "type" : "String",
233       "desc" : "The field's HTML name attribute.",
234       "memberOf" : "Roo.form.Field",
235       "isOptional" : false,
236       "optvals" : []
237     },
238     {
239       "name" : "qtip",
240       "type" : "String",
241       "desc" : "Mouse over tip",
242       "memberOf" : "Roo.form.Field",
243       "isOptional" : false,
244       "optvals" : []
245     },
246     {
247       "name" : "focusClass",
248       "type" : "String",
249       "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
250       "memberOf" : "Roo.form.Field",
251       "isOptional" : false,
252       "optvals" : []
253     },
254     {
255       "name" : "fieldClass",
256       "type" : "String",
257       "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
258       "memberOf" : "Roo.form.Field",
259       "isOptional" : false,
260       "optvals" : []
261     },
262     {
263       "name" : "disableClass",
264       "type" : "String",
265       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
266       "memberOf" : "Roo.Component",
267       "isOptional" : false,
268       "optvals" : []
269     }
270   ],
271   "methods" : [
272     {
273       "name" : "getImageDataURI",
274       "type" : "function",
275       "desc" : "when user is clicked confirm then show this image.....",
276       "sig" : "()\n{\n\n}",
277       "static" : false,
278       "memberOf" : "",
279       "isStatic" : false,
280       "isConstructor" : false,
281       "isPrivate" : false,
282       "example" : "",
283       "deprecated" : "",
284       "since" : "",
285       "see" : "",
286       "exceptions" : "",
287       "requires" : "",
288       "params" : [],
289       "returns" : [
290         {
291           "name" : "",
292           "type" : "String",
293           "desc" : "Image Data URI"
294         }
295       ]
296     },
297     {
298       "name" : "getConfirmed",
299       "type" : "function",
300       "desc" : "",
301       "sig" : "()\n{\n\n}",
302       "static" : false,
303       "memberOf" : "",
304       "isStatic" : false,
305       "isConstructor" : false,
306       "isPrivate" : false,
307       "example" : "",
308       "deprecated" : "",
309       "since" : "",
310       "see" : "",
311       "exceptions" : "",
312       "requires" : "",
313       "params" : [],
314       "returns" : [
315         {
316           "name" : "",
317           "type" : "Boolean",
318           "desc" : "this.isConfirmed"
319         }
320       ]
321     },
322     {
323       "name" : "getHeight",
324       "type" : "function",
325       "desc" : "",
326       "sig" : "()\n{\n\n}",
327       "static" : false,
328       "memberOf" : "",
329       "isStatic" : false,
330       "isConstructor" : false,
331       "isPrivate" : false,
332       "example" : "",
333       "deprecated" : "",
334       "since" : "",
335       "see" : "",
336       "exceptions" : "",
337       "requires" : "",
338       "params" : [],
339       "returns" : [
340         {
341           "name" : "",
342           "type" : "Number",
343           "desc" : "this.height"
344         }
345       ]
346     },
347     {
348       "name" : "createToolbar",
349       "type" : "function",
350       "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.",
351       "sig" : "(editor)",
352       "static" : false,
353       "memberOf" : "",
354       "isStatic" : false,
355       "isConstructor" : false,
356       "isPrivate" : false,
357       "example" : "",
358       "deprecated" : "",
359       "since" : "",
360       "see" : "",
361       "exceptions" : "",
362       "requires" : "",
363       "params" : [
364         {
365           "name" : "editor",
366           "type" : "HtmlEditor",
367           "desc" : "",
368           "isOptional" : false
369         }
370       ],
371       "returns" : []
372     },
373     {
374       "name" : "getWidth",
375       "type" : "function",
376       "desc" : "",
377       "sig" : "()\n{\n\n}",
378       "static" : false,
379       "memberOf" : "",
380       "isStatic" : false,
381       "isConstructor" : false,
382       "isPrivate" : false,
383       "example" : "",
384       "deprecated" : "",
385       "since" : "",
386       "see" : "",
387       "exceptions" : "",
388       "requires" : "",
389       "params" : [],
390       "returns" : [
391         {
392           "name" : "",
393           "type" : "Number",
394           "desc" : "this.width"
395         }
396       ]
397     },
398     {
399       "name" : "validate",
400       "type" : "function",
401       "desc" : "Validates the field value",
402       "sig" : "()\n{\n\n}",
403       "static" : false,
404       "memberOf" : "Roo.form.Field",
405       "isStatic" : false,
406       "isConstructor" : false,
407       "isPrivate" : false,
408       "example" : "",
409       "deprecated" : "",
410       "since" : "",
411       "see" : "",
412       "exceptions" : "",
413       "requires" : "",
414       "params" : [],
415       "returns" : [
416         {
417           "name" : "",
418           "type" : "Boolean",
419           "desc" : "True if the value is valid, else false"
420         }
421       ]
422     },
423     {
424       "name" : "getValue",
425       "type" : "function",
426       "desc" : "Returns the normalized data value (undefined or emptyText will be returned as '').  To return the raw value see {@link #getRawValue}.",
427       "sig" : "()\n{\n\n}",
428       "static" : false,
429       "memberOf" : "Roo.form.Field",
430       "isStatic" : false,
431       "isConstructor" : false,
432       "isPrivate" : false,
433       "example" : "",
434       "deprecated" : "",
435       "since" : "",
436       "see" : "",
437       "exceptions" : "",
438       "requires" : "",
439       "params" : [],
440       "returns" : [
441         {
442           "name" : "",
443           "type" : "Mixed",
444           "desc" : "value The field value"
445         }
446       ]
447     },
448     {
449       "name" : "setValue",
450       "type" : "function",
451       "desc" : "Sets a data value into the field and validates it.  To set the value directly without validation see {@link #setRawValue}.",
452       "sig" : "(value)",
453       "static" : false,
454       "memberOf" : "Roo.form.Field",
455       "isStatic" : false,
456       "isConstructor" : false,
457       "isPrivate" : false,
458       "example" : "",
459       "deprecated" : "",
460       "since" : "",
461       "see" : "",
462       "exceptions" : "",
463       "requires" : "",
464       "params" : [
465         {
466           "name" : "value",
467           "type" : "Mixed",
468           "desc" : "The value to set",
469           "isOptional" : false
470         }
471       ],
472       "returns" : []
473     },
474     {
475       "name" : "getName",
476       "type" : "function",
477       "desc" : "Returns the name attribute of the field if available",
478       "sig" : "()\n{\n\n}",
479       "static" : false,
480       "memberOf" : "Roo.form.Field",
481       "isStatic" : false,
482       "isConstructor" : false,
483       "isPrivate" : false,
484       "example" : "",
485       "deprecated" : "",
486       "since" : "",
487       "see" : "",
488       "exceptions" : "",
489       "requires" : "",
490       "params" : [],
491       "returns" : [
492         {
493           "name" : "",
494           "type" : "String",
495           "desc" : "name The field name"
496         }
497       ]
498     },
499     {
500       "name" : "markInvalid",
501       "type" : "function",
502       "desc" : "Mark this field as invalid",
503       "sig" : "(msg)",
504       "static" : false,
505       "memberOf" : "Roo.form.Field",
506       "isStatic" : false,
507       "isConstructor" : false,
508       "isPrivate" : false,
509       "example" : "",
510       "deprecated" : "",
511       "since" : "",
512       "see" : "",
513       "exceptions" : "",
514       "requires" : "",
515       "params" : [
516         {
517           "name" : "msg",
518           "type" : "String",
519           "desc" : "The validation message",
520           "isOptional" : false
521         }
522       ],
523       "returns" : []
524     },
525     {
526       "name" : "getRawValue",
527       "type" : "function",
528       "desc" : "Returns the raw data value which may or may not be a valid, defined value.  To return a normalized value see {@link #getValue}.",
529       "sig" : "()\n{\n\n}",
530       "static" : false,
531       "memberOf" : "Roo.form.Field",
532       "isStatic" : false,
533       "isConstructor" : false,
534       "isPrivate" : false,
535       "example" : "",
536       "deprecated" : "",
537       "since" : "",
538       "see" : "",
539       "exceptions" : "",
540       "requires" : "",
541       "params" : [],
542       "returns" : [
543         {
544           "name" : "",
545           "type" : "Mixed",
546           "desc" : "value The field value"
547         }
548       ]
549     },
550     {
551       "name" : "applyTo",
552       "type" : "function",
553       "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
554       "sig" : "(el)",
555       "static" : false,
556       "memberOf" : "Roo.form.Field",
557       "isStatic" : false,
558       "isConstructor" : false,
559       "isPrivate" : false,
560       "example" : "",
561       "deprecated" : "",
562       "since" : "",
563       "see" : "",
564       "exceptions" : "",
565       "requires" : "",
566       "params" : [
567         {
568           "name" : "el",
569           "type" : "String/HTMLElement/Element",
570           "desc" : "The id of the node, a DOM node or an existing Element",
571           "isOptional" : false
572         }
573       ],
574       "returns" : [
575         {
576           "name" : "",
577           "type" : "Roo.form.Field",
578           "desc" : "this"
579         }
580       ]
581     },
582     {
583       "name" : "resetHasChanged",
584       "type" : "function",
585       "desc" : "stores the current value in loadedValue",
586       "sig" : "()\n{\n\n}",
587       "static" : false,
588       "memberOf" : "Roo.form.Field",
589       "isStatic" : false,
590       "isConstructor" : false,
591       "isPrivate" : false,
592       "example" : "",
593       "deprecated" : "",
594       "since" : "",
595       "see" : "",
596       "exceptions" : "",
597       "requires" : "",
598       "params" : [],
599       "returns" : []
600     },
601     {
602       "name" : "isDirty",
603       "type" : "function",
604       "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED  - it never worked well - use hasChanged/resetHasChanged.",
605       "sig" : "()\n{\n\n}",
606       "static" : false,
607       "memberOf" : "Roo.form.Field",
608       "isStatic" : false,
609       "isConstructor" : false,
610       "isPrivate" : false,
611       "example" : "",
612       "deprecated" : "",
613       "since" : "",
614       "see" : "",
615       "exceptions" : "",
616       "requires" : "",
617       "params" : [],
618       "returns" : []
619     },
620     {
621       "name" : "setRawValue",
622       "type" : "function",
623       "desc" : "Sets the underlying DOM field's value directly, bypassing validation.  To set the value with validation see {@link #setValue}.",
624       "sig" : "(value)",
625       "static" : false,
626       "memberOf" : "Roo.form.Field",
627       "isStatic" : false,
628       "isConstructor" : false,
629       "isPrivate" : false,
630       "example" : "",
631       "deprecated" : "",
632       "since" : "",
633       "see" : "",
634       "exceptions" : "",
635       "requires" : "",
636       "params" : [
637         {
638           "name" : "value",
639           "type" : "Mixed",
640           "desc" : "The value to set",
641           "isOptional" : false
642         }
643       ],
644       "returns" : []
645     },
646     {
647       "name" : "clearInvalid",
648       "type" : "function",
649       "desc" : "Clear any invalid styles/messages for this field",
650       "sig" : "()\n{\n\n}",
651       "static" : false,
652       "memberOf" : "Roo.form.Field",
653       "isStatic" : false,
654       "isConstructor" : false,
655       "isPrivate" : false,
656       "example" : "",
657       "deprecated" : "",
658       "since" : "",
659       "see" : "",
660       "exceptions" : "",
661       "requires" : "",
662       "params" : [],
663       "returns" : []
664     },
665     {
666       "name" : "isValid",
667       "type" : "function",
668       "desc" : "Returns whether or not the field value is currently valid",
669       "sig" : "(preventMark)",
670       "static" : false,
671       "memberOf" : "Roo.form.Field",
672       "isStatic" : false,
673       "isConstructor" : false,
674       "isPrivate" : false,
675       "example" : "",
676       "deprecated" : "",
677       "since" : "",
678       "see" : "",
679       "exceptions" : "",
680       "requires" : "",
681       "params" : [
682         {
683           "name" : "preventMark",
684           "type" : "Boolean",
685           "desc" : "True to disable marking the field invalid",
686           "isOptional" : false
687         }
688       ],
689       "returns" : [
690         {
691           "name" : "",
692           "type" : "Boolean",
693           "desc" : "True if the value is valid, else false"
694         }
695       ]
696     },
697     {
698       "name" : "reset",
699       "type" : "function",
700       "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
701       "sig" : "()\n{\n\n}",
702       "static" : false,
703       "memberOf" : "Roo.form.Field",
704       "isStatic" : false,
705       "isConstructor" : false,
706       "isPrivate" : false,
707       "example" : "",
708       "deprecated" : "",
709       "since" : "",
710       "see" : "",
711       "exceptions" : "",
712       "requires" : "",
713       "params" : [],
714       "returns" : []
715     },
716     {
717       "name" : "hasChanged",
718       "type" : "function",
719       "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
720       "sig" : "()\n{\n\n}",
721       "static" : false,
722       "memberOf" : "Roo.form.Field",
723       "isStatic" : false,
724       "isConstructor" : false,
725       "isPrivate" : false,
726       "example" : "",
727       "deprecated" : "",
728       "since" : "",
729       "see" : "",
730       "exceptions" : "",
731       "requires" : "",
732       "params" : [],
733       "returns" : []
734     },
735     {
736       "name" : "updateBox",
737       "type" : "function",
738       "desc" : "Sets the current box measurements of the component's underlying element.",
739       "sig" : "(box)",
740       "static" : false,
741       "memberOf" : "Roo.BoxComponent",
742       "isStatic" : false,
743       "isConstructor" : false,
744       "isPrivate" : false,
745       "example" : "",
746       "deprecated" : "",
747       "since" : "",
748       "see" : "",
749       "exceptions" : "",
750       "requires" : "",
751       "params" : [
752         {
753           "name" : "box",
754           "type" : "Object",
755           "desc" : "An object in the format {x, y, width, height}",
756           "isOptional" : false
757         }
758       ],
759       "returns" : []
760     },
761     {
762       "name" : "setPagePosition",
763       "type" : "function",
764       "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.",
765       "sig" : "(x, y)",
766       "static" : false,
767       "memberOf" : "Roo.BoxComponent",
768       "isStatic" : false,
769       "isConstructor" : false,
770       "isPrivate" : false,
771       "example" : "",
772       "deprecated" : "",
773       "since" : "",
774       "see" : "",
775       "exceptions" : "",
776       "requires" : "",
777       "params" : [
778         {
779           "name" : "x",
780           "type" : "Number",
781           "desc" : "The new x position",
782           "isOptional" : false
783         },
784         {
785           "name" : "y",
786           "type" : "Number",
787           "desc" : "The new y position",
788           "isOptional" : false
789         }
790       ],
791       "returns" : []
792     },
793     {
794       "name" : "syncSize",
795       "type" : "function",
796       "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
797       "sig" : "()\n{\n\n}",
798       "static" : false,
799       "memberOf" : "Roo.BoxComponent",
800       "isStatic" : false,
801       "isConstructor" : false,
802       "isPrivate" : false,
803       "example" : "",
804       "deprecated" : "",
805       "since" : "",
806       "see" : "",
807       "exceptions" : "",
808       "requires" : "",
809       "params" : [],
810       "returns" : []
811     },
812     {
813       "name" : "setSize",
814       "type" : "function",
815       "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}.",
816       "sig" : "(width, height)",
817       "static" : false,
818       "memberOf" : "Roo.BoxComponent",
819       "isStatic" : false,
820       "isConstructor" : false,
821       "isPrivate" : false,
822       "example" : "",
823       "deprecated" : "",
824       "since" : "",
825       "see" : "",
826       "exceptions" : "",
827       "requires" : "",
828       "params" : [
829         {
830           "name" : "width",
831           "type" : "Number/Object",
832           "desc" : "The new width to set, or a size object in the format {width, height}",
833           "isOptional" : false
834         },
835         {
836           "name" : "height",
837           "type" : "Number",
838           "desc" : "The new height to set (not required if a size object is passed as the first arg)",
839           "isOptional" : false
840         }
841       ],
842       "returns" : [
843         {
844           "name" : "",
845           "type" : "Roo.BoxComponent",
846           "desc" : "this"
847         }
848       ]
849     },
850     {
851       "name" : "getPosition",
852       "type" : "function",
853       "desc" : "Gets the current XY position of the component's underlying element.",
854       "sig" : "(local)",
855       "static" : false,
856       "memberOf" : "Roo.BoxComponent",
857       "isStatic" : false,
858       "isConstructor" : false,
859       "isPrivate" : false,
860       "example" : "",
861       "deprecated" : "",
862       "since" : "",
863       "see" : "",
864       "exceptions" : "",
865       "requires" : "",
866       "params" : [
867         {
868           "name" : "local",
869           "type" : "Boolean",
870           "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
871           "isOptional" : false
872         }
873       ],
874       "returns" : [
875         {
876           "name" : "",
877           "type" : "Array",
878           "desc" : "The XY position of the element (e.g., [100, 200])"
879         }
880       ]
881     },
882     {
883       "name" : "onResize",
884       "type" : "function",
885       "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.",
886       "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
887       "static" : false,
888       "memberOf" : "Roo.BoxComponent",
889       "isStatic" : false,
890       "isConstructor" : false,
891       "isPrivate" : false,
892       "example" : "",
893       "deprecated" : "",
894       "since" : "",
895       "see" : "",
896       "exceptions" : "",
897       "requires" : "",
898       "params" : [
899         {
900           "name" : "adjWidth",
901           "type" : "Number",
902           "desc" : "The box-adjusted width that was set",
903           "isOptional" : false
904         },
905         {
906           "name" : "adjHeight",
907           "type" : "Number",
908           "desc" : "The box-adjusted height that was set",
909           "isOptional" : false
910         },
911         {
912           "name" : "rawWidth",
913           "type" : "Number",
914           "desc" : "The width that was originally specified",
915           "isOptional" : false
916         },
917         {
918           "name" : "rawHeight",
919           "type" : "Number",
920           "desc" : "The height that was originally specified",
921           "isOptional" : false
922         }
923       ],
924       "returns" : []
925     },
926     {
927       "name" : "getBox",
928       "type" : "function",
929       "desc" : "Gets the current box measurements of the component's underlying element.",
930       "sig" : "(local)",
931       "static" : false,
932       "memberOf" : "Roo.BoxComponent",
933       "isStatic" : false,
934       "isConstructor" : false,
935       "isPrivate" : false,
936       "example" : "",
937       "deprecated" : "",
938       "since" : "",
939       "see" : "",
940       "exceptions" : "",
941       "requires" : "",
942       "params" : [
943         {
944           "name" : "local",
945           "type" : "Boolean",
946           "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
947           "isOptional" : false
948         }
949       ],
950       "returns" : []
951     },
952     {
953       "name" : "getSize",
954       "type" : "function",
955       "desc" : "Gets the current size of the component's underlying element.",
956       "sig" : "()\n{\n\n}",
957       "static" : false,
958       "memberOf" : "Roo.BoxComponent",
959       "isStatic" : false,
960       "isConstructor" : false,
961       "isPrivate" : false,
962       "example" : "",
963       "deprecated" : "",
964       "since" : "",
965       "see" : "",
966       "exceptions" : "",
967       "requires" : "",
968       "params" : [],
969       "returns" : [
970         {
971           "name" : "",
972           "type" : "Object",
973           "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
974         }
975       ]
976     },
977     {
978       "name" : "onPosition",
979       "type" : "function",
980       "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.",
981       "sig" : "(x, y)",
982       "static" : false,
983       "memberOf" : "Roo.BoxComponent",
984       "isStatic" : false,
985       "isConstructor" : false,
986       "isPrivate" : false,
987       "example" : "",
988       "deprecated" : "",
989       "since" : "",
990       "see" : "",
991       "exceptions" : "",
992       "requires" : "",
993       "params" : [
994         {
995           "name" : "x",
996           "type" : "Number",
997           "desc" : "The new x position",
998           "isOptional" : false
999         },
1000         {
1001           "name" : "y",
1002           "type" : "Number",
1003           "desc" : "The new y position",
1004           "isOptional" : false
1005         }
1006       ],
1007       "returns" : []
1008     },
1009     {
1010       "name" : "setPosition",
1011       "type" : "function",
1012       "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.",
1013       "sig" : "(left, top)",
1014       "static" : false,
1015       "memberOf" : "Roo.BoxComponent",
1016       "isStatic" : false,
1017       "isConstructor" : false,
1018       "isPrivate" : false,
1019       "example" : "",
1020       "deprecated" : "",
1021       "since" : "",
1022       "see" : "",
1023       "exceptions" : "",
1024       "requires" : "",
1025       "params" : [
1026         {
1027           "name" : "left",
1028           "type" : "Number",
1029           "desc" : "The new left",
1030           "isOptional" : false
1031         },
1032         {
1033           "name" : "top",
1034           "type" : "Number",
1035           "desc" : "The new top",
1036           "isOptional" : false
1037         }
1038       ],
1039       "returns" : []
1040     },
1041     {
1042       "name" : "getId",
1043       "type" : "function",
1044       "desc" : "Returns the id of this component.",
1045       "sig" : "()\n{\n\n}",
1046       "static" : false,
1047       "memberOf" : "Roo.Component",
1048       "isStatic" : false,
1049       "isConstructor" : false,
1050       "isPrivate" : false,
1051       "example" : "",
1052       "deprecated" : "",
1053       "since" : "",
1054       "see" : "",
1055       "exceptions" : "",
1056       "requires" : "",
1057       "params" : [],
1058       "returns" : [
1059         {
1060           "name" : "",
1061           "type" : "String",
1062           "desc" : ""
1063         }
1064       ]
1065     },
1066     {
1067       "name" : "render",
1068       "type" : "function",
1069       "desc" : "If this is a lazy rendering component, render it to its container element.",
1070       "sig" : "(container)",
1071       "static" : false,
1072       "memberOf" : "Roo.Component",
1073       "isStatic" : false,
1074       "isConstructor" : false,
1075       "isPrivate" : false,
1076       "example" : "",
1077       "deprecated" : "",
1078       "since" : "",
1079       "see" : "",
1080       "exceptions" : "",
1081       "requires" : "",
1082       "params" : [
1083         {
1084           "name" : "container",
1085           "type" : "String/HTMLElement/Element",
1086           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
1087           "isOptional" : false
1088         }
1089       ],
1090       "returns" : []
1091     },
1092     {
1093       "name" : "destroy",
1094       "type" : "function",
1095       "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}.",
1096       "sig" : "()\n{\n\n}",
1097       "static" : false,
1098       "memberOf" : "Roo.Component",
1099       "isStatic" : false,
1100       "isConstructor" : false,
1101       "isPrivate" : false,
1102       "example" : "",
1103       "deprecated" : "",
1104       "since" : "",
1105       "see" : "",
1106       "exceptions" : "",
1107       "requires" : "",
1108       "params" : [],
1109       "returns" : []
1110     },
1111     {
1112       "name" : "isVisible",
1113       "type" : "function",
1114       "desc" : "Returns true if this component is visible.",
1115       "sig" : "()\n{\n\n}",
1116       "static" : false,
1117       "memberOf" : "Roo.Component",
1118       "isStatic" : false,
1119       "isConstructor" : false,
1120       "isPrivate" : false,
1121       "example" : "",
1122       "deprecated" : "",
1123       "since" : "",
1124       "see" : "",
1125       "exceptions" : "",
1126       "requires" : "",
1127       "params" : [],
1128       "returns" : []
1129     },
1130     {
1131       "name" : "setDisabled",
1132       "type" : "function",
1133       "desc" : "Convenience function for setting disabled/enabled by boolean.",
1134       "sig" : "(disabled)",
1135       "static" : false,
1136       "memberOf" : "Roo.Component",
1137       "isStatic" : false,
1138       "isConstructor" : false,
1139       "isPrivate" : false,
1140       "example" : "",
1141       "deprecated" : "",
1142       "since" : "",
1143       "see" : "",
1144       "exceptions" : "",
1145       "requires" : "",
1146       "params" : [
1147         {
1148           "name" : "disabled",
1149           "type" : "Boolean",
1150           "desc" : "",
1151           "isOptional" : false
1152         }
1153       ],
1154       "returns" : []
1155     },
1156     {
1157       "name" : "hide",
1158       "type" : "function",
1159       "desc" : "Hide this component.",
1160       "sig" : "()\n{\n\n}",
1161       "static" : false,
1162       "memberOf" : "Roo.Component",
1163       "isStatic" : false,
1164       "isConstructor" : false,
1165       "isPrivate" : false,
1166       "example" : "",
1167       "deprecated" : "",
1168       "since" : "",
1169       "see" : "",
1170       "exceptions" : "",
1171       "requires" : "",
1172       "params" : [],
1173       "returns" : [
1174         {
1175           "name" : "",
1176           "type" : "Roo.Component",
1177           "desc" : "this"
1178         }
1179       ]
1180     },
1181     {
1182       "name" : "focus",
1183       "type" : "function",
1184       "desc" : "Try to focus this component.",
1185       "sig" : "(selectText)",
1186       "static" : false,
1187       "memberOf" : "Roo.Component",
1188       "isStatic" : false,
1189       "isConstructor" : false,
1190       "isPrivate" : false,
1191       "example" : "",
1192       "deprecated" : "",
1193       "since" : "",
1194       "see" : "",
1195       "exceptions" : "",
1196       "requires" : "",
1197       "params" : [
1198         {
1199           "name" : "selectText",
1200           "type" : "Boolean",
1201           "desc" : "True to also select the text in this component (if applicable)",
1202           "isOptional" : false
1203         }
1204       ],
1205       "returns" : [
1206         {
1207           "name" : "",
1208           "type" : "Roo.Component",
1209           "desc" : "this"
1210         }
1211       ]
1212     },
1213     {
1214       "name" : "show",
1215       "type" : "function",
1216       "desc" : "Show this component.",
1217       "sig" : "()\n{\n\n}",
1218       "static" : false,
1219       "memberOf" : "Roo.Component",
1220       "isStatic" : false,
1221       "isConstructor" : false,
1222       "isPrivate" : false,
1223       "example" : "",
1224       "deprecated" : "",
1225       "since" : "",
1226       "see" : "",
1227       "exceptions" : "",
1228       "requires" : "",
1229       "params" : [],
1230       "returns" : [
1231         {
1232           "name" : "",
1233           "type" : "Roo.Component",
1234           "desc" : "this"
1235         }
1236       ]
1237     },
1238     {
1239       "name" : "enable",
1240       "type" : "function",
1241       "desc" : "Enable this component.",
1242       "sig" : "()\n{\n\n}",
1243       "static" : false,
1244       "memberOf" : "Roo.Component",
1245       "isStatic" : false,
1246       "isConstructor" : false,
1247       "isPrivate" : false,
1248       "example" : "",
1249       "deprecated" : "",
1250       "since" : "",
1251       "see" : "",
1252       "exceptions" : "",
1253       "requires" : "",
1254       "params" : [],
1255       "returns" : [
1256         {
1257           "name" : "",
1258           "type" : "Roo.Component",
1259           "desc" : "this"
1260         }
1261       ]
1262     },
1263     {
1264       "name" : "setVisible",
1265       "type" : "function",
1266       "desc" : "Convenience function to hide or show this component by boolean.",
1267       "sig" : "(visible)",
1268       "static" : false,
1269       "memberOf" : "Roo.Component",
1270       "isStatic" : false,
1271       "isConstructor" : false,
1272       "isPrivate" : false,
1273       "example" : "",
1274       "deprecated" : "",
1275       "since" : "",
1276       "see" : "",
1277       "exceptions" : "",
1278       "requires" : "",
1279       "params" : [
1280         {
1281           "name" : "visible",
1282           "type" : "Boolean",
1283           "desc" : "True to show, false to hide",
1284           "isOptional" : false
1285         }
1286       ],
1287       "returns" : [
1288         {
1289           "name" : "",
1290           "type" : "Roo.Component",
1291           "desc" : "this"
1292         }
1293       ]
1294     },
1295     {
1296       "name" : "disable",
1297       "type" : "function",
1298       "desc" : "Disable this component.",
1299       "sig" : "()\n{\n\n}",
1300       "static" : false,
1301       "memberOf" : "Roo.Component",
1302       "isStatic" : false,
1303       "isConstructor" : false,
1304       "isPrivate" : false,
1305       "example" : "",
1306       "deprecated" : "",
1307       "since" : "",
1308       "see" : "",
1309       "exceptions" : "",
1310       "requires" : "",
1311       "params" : [],
1312       "returns" : [
1313         {
1314           "name" : "",
1315           "type" : "Roo.Component",
1316           "desc" : "this"
1317         }
1318       ]
1319     },
1320     {
1321       "name" : "getEl",
1322       "type" : "function",
1323       "desc" : "Returns the underlying {@link Roo.Element}.",
1324       "sig" : "()\n{\n\n}",
1325       "static" : false,
1326       "memberOf" : "Roo.Component",
1327       "isStatic" : false,
1328       "isConstructor" : false,
1329       "isPrivate" : false,
1330       "example" : "",
1331       "deprecated" : "",
1332       "since" : "",
1333       "see" : "",
1334       "exceptions" : "",
1335       "requires" : "",
1336       "params" : [],
1337       "returns" : [
1338         {
1339           "name" : "",
1340           "type" : "Roo.Element",
1341           "desc" : "The element"
1342         }
1343       ]
1344     },
1345     {
1346       "name" : "purgeListeners",
1347       "type" : "function",
1348       "desc" : "Removes all listeners for this object",
1349       "sig" : "()\n{\n\n}",
1350       "static" : false,
1351       "memberOf" : "Roo.util.Observable",
1352       "isStatic" : false,
1353       "isConstructor" : false,
1354       "isPrivate" : false,
1355       "example" : "",
1356       "deprecated" : "",
1357       "since" : "",
1358       "see" : "",
1359       "exceptions" : "",
1360       "requires" : "",
1361       "params" : [],
1362       "returns" : []
1363     },
1364     {
1365       "name" : "on",
1366       "type" : "function",
1367       "desc" : "Appends an event handler to this element (shorthand for addListener)",
1368       "sig" : "(eventName, handler, scope, options)",
1369       "static" : false,
1370       "memberOf" : "Roo.util.Observable",
1371       "isStatic" : false,
1372       "isConstructor" : false,
1373       "isPrivate" : false,
1374       "example" : "",
1375       "deprecated" : "",
1376       "since" : "",
1377       "see" : "",
1378       "exceptions" : "",
1379       "requires" : "",
1380       "params" : [
1381         {
1382           "name" : "eventName",
1383           "type" : "String",
1384           "desc" : "The type of event to listen for",
1385           "isOptional" : false
1386         },
1387         {
1388           "name" : "handler",
1389           "type" : "Function",
1390           "desc" : "The method the event invokes",
1391           "isOptional" : false
1392         },
1393         {
1394           "name" : "scope",
1395           "type" : "Object",
1396           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1397           "isOptional" : false
1398         },
1399         {
1400           "name" : "options",
1401           "type" : "Object",
1402           "desc" : "(optional)",
1403           "isOptional" : false
1404         }
1405       ],
1406       "returns" : []
1407     },
1408     {
1409       "name" : "un",
1410       "type" : "function",
1411       "desc" : "Removes a listener (shorthand for removeListener)",
1412       "sig" : "(eventName, handler, scope)",
1413       "static" : false,
1414       "memberOf" : "Roo.util.Observable",
1415       "isStatic" : false,
1416       "isConstructor" : false,
1417       "isPrivate" : false,
1418       "example" : "",
1419       "deprecated" : "",
1420       "since" : "",
1421       "see" : "",
1422       "exceptions" : "",
1423       "requires" : "",
1424       "params" : [
1425         {
1426           "name" : "eventName",
1427           "type" : "String",
1428           "desc" : "The type of event to listen for",
1429           "isOptional" : false
1430         },
1431         {
1432           "name" : "handler",
1433           "type" : "Function",
1434           "desc" : "The handler to remove",
1435           "isOptional" : false
1436         },
1437         {
1438           "name" : "scope",
1439           "type" : "Object",
1440           "desc" : "(optional) The scope (this object) for the handler",
1441           "isOptional" : false
1442         }
1443       ],
1444       "returns" : []
1445     },
1446     {
1447       "name" : "addEvents",
1448       "type" : "function",
1449       "desc" : "Used to define events on this Observable",
1450       "sig" : "(object)",
1451       "static" : false,
1452       "memberOf" : "Roo.util.Observable",
1453       "isStatic" : false,
1454       "isConstructor" : false,
1455       "isPrivate" : false,
1456       "example" : "",
1457       "deprecated" : "",
1458       "since" : "",
1459       "see" : "",
1460       "exceptions" : "",
1461       "requires" : "",
1462       "params" : [
1463         {
1464           "name" : "object",
1465           "type" : "Object",
1466           "desc" : "The object with the events defined",
1467           "isOptional" : false
1468         }
1469       ],
1470       "returns" : []
1471     },
1472     {
1473       "name" : "releaseCapture",
1474       "type" : "function",
1475       "desc" : "Removes <b>all</b> added captures from the Observable.",
1476       "sig" : "(o)",
1477       "static" : true,
1478       "memberOf" : "Roo.util.Observable",
1479       "isStatic" : true,
1480       "isConstructor" : false,
1481       "isPrivate" : false,
1482       "example" : "",
1483       "deprecated" : "",
1484       "since" : "",
1485       "see" : "",
1486       "exceptions" : "",
1487       "requires" : "",
1488       "params" : [
1489         {
1490           "name" : "o",
1491           "type" : "Observable",
1492           "desc" : "The Observable to release",
1493           "isOptional" : false
1494         }
1495       ],
1496       "returns" : []
1497     },
1498     {
1499       "name" : "removeListener",
1500       "type" : "function",
1501       "desc" : "Removes a listener",
1502       "sig" : "(eventName, handler, scope)",
1503       "static" : false,
1504       "memberOf" : "Roo.util.Observable",
1505       "isStatic" : false,
1506       "isConstructor" : false,
1507       "isPrivate" : false,
1508       "example" : "",
1509       "deprecated" : "",
1510       "since" : "",
1511       "see" : "",
1512       "exceptions" : "",
1513       "requires" : "",
1514       "params" : [
1515         {
1516           "name" : "eventName",
1517           "type" : "String",
1518           "desc" : "The type of event to listen for",
1519           "isOptional" : false
1520         },
1521         {
1522           "name" : "handler",
1523           "type" : "Function",
1524           "desc" : "The handler to remove",
1525           "isOptional" : false
1526         },
1527         {
1528           "name" : "scope",
1529           "type" : "Object",
1530           "desc" : "(optional) The scope (this object) for the handler",
1531           "isOptional" : false
1532         }
1533       ],
1534       "returns" : []
1535     },
1536     {
1537       "name" : "fireEvent",
1538       "type" : "function",
1539       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1540       "sig" : "(eventName, args)",
1541       "static" : false,
1542       "memberOf" : "Roo.util.Observable",
1543       "isStatic" : false,
1544       "isConstructor" : false,
1545       "isPrivate" : false,
1546       "example" : "",
1547       "deprecated" : "",
1548       "since" : "",
1549       "see" : "",
1550       "exceptions" : "",
1551       "requires" : "",
1552       "params" : [
1553         {
1554           "name" : "eventName",
1555           "type" : "String",
1556           "desc" : "",
1557           "isOptional" : false
1558         },
1559         {
1560           "name" : "args",
1561           "type" : "Object...",
1562           "desc" : "Variable number of parameters are passed to handlers",
1563           "isOptional" : false
1564         }
1565       ],
1566       "returns" : [
1567         {
1568           "name" : "",
1569           "type" : "Boolean",
1570           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1571         }
1572       ]
1573     },
1574     {
1575       "name" : "hasListener",
1576       "type" : "function",
1577       "desc" : "Checks to see if this object has any listeners for a specified event",
1578       "sig" : "(eventName)",
1579       "static" : false,
1580       "memberOf" : "Roo.util.Observable",
1581       "isStatic" : false,
1582       "isConstructor" : false,
1583       "isPrivate" : false,
1584       "example" : "",
1585       "deprecated" : "",
1586       "since" : "",
1587       "see" : "",
1588       "exceptions" : "",
1589       "requires" : "",
1590       "params" : [
1591         {
1592           "name" : "eventName",
1593           "type" : "String",
1594           "desc" : "The name of the event to check for",
1595           "isOptional" : false
1596         }
1597       ],
1598       "returns" : [
1599         {
1600           "name" : "",
1601           "type" : "Boolean",
1602           "desc" : "True if the event is being listened for, else false"
1603         }
1604       ]
1605     },
1606     {
1607       "name" : "capture",
1608       "type" : "function",
1609       "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.",
1610       "sig" : "(o, fn, scope)",
1611       "static" : true,
1612       "memberOf" : "Roo.util.Observable",
1613       "isStatic" : true,
1614       "isConstructor" : false,
1615       "isPrivate" : false,
1616       "example" : "",
1617       "deprecated" : "",
1618       "since" : "",
1619       "see" : "",
1620       "exceptions" : "",
1621       "requires" : "",
1622       "params" : [
1623         {
1624           "name" : "o",
1625           "type" : "Observable",
1626           "desc" : "The Observable to capture",
1627           "isOptional" : false
1628         },
1629         {
1630           "name" : "fn",
1631           "type" : "Function",
1632           "desc" : "The function to call",
1633           "isOptional" : false
1634         },
1635         {
1636           "name" : "scope",
1637           "type" : "Object",
1638           "desc" : "(optional) The scope (this object) for the fn",
1639           "isOptional" : false
1640         }
1641       ],
1642       "returns" : []
1643     },
1644     {
1645       "name" : "addListener",
1646       "type" : "function",
1647       "desc" : "Appends an event handler to this component",
1648       "sig" : "(eventName, handler, scope, options)",
1649       "static" : false,
1650       "memberOf" : "Roo.util.Observable",
1651       "isStatic" : false,
1652       "isConstructor" : false,
1653       "isPrivate" : false,
1654       "example" : "",
1655       "deprecated" : "",
1656       "since" : "",
1657       "see" : "",
1658       "exceptions" : "",
1659       "requires" : "",
1660       "params" : [
1661         {
1662           "name" : "eventName",
1663           "type" : "String",
1664           "desc" : "The type of event to listen for",
1665           "isOptional" : false
1666         },
1667         {
1668           "name" : "handler",
1669           "type" : "Function",
1670           "desc" : "The method the event invokes",
1671           "isOptional" : false
1672         },
1673         {
1674           "name" : "scope",
1675           "type" : "Object",
1676           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1677           "isOptional" : false
1678         },
1679         {
1680           "name" : "options",
1681           "type" : "Object",
1682           "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>",
1683           "isOptional" : false
1684         }
1685       ],
1686       "returns" : []
1687     }
1688   ],
1689   "events" : [
1690     {
1691       "name" : "confirm",
1692       "type" : "function",
1693       "desc" : "Fires when the 'confirm' icon is pressed (add a listener to enable add button)",
1694       "sig" : "function (combo)\n{\n\n}",
1695       "memberOf" : "",
1696       "example" : "",
1697       "deprecated" : "",
1698       "since" : "",
1699       "see" : "",
1700       "params" : [
1701         {
1702           "name" : "combo",
1703           "type" : "Roo.form.Signature",
1704           "desc" : "This combo box",
1705           "isOptional" : false
1706         }
1707       ],
1708       "returns" : []
1709     },
1710     {
1711       "name" : "reset",
1712       "type" : "function",
1713       "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
1714       "sig" : "function (combo, record)\n{\n\n}",
1715       "memberOf" : "",
1716       "example" : "",
1717       "deprecated" : "",
1718       "since" : "",
1719       "see" : "",
1720       "params" : [
1721         {
1722           "name" : "combo",
1723           "type" : "Roo.form.ComboBox",
1724           "desc" : "This combo box",
1725           "isOptional" : false
1726         },
1727         {
1728           "name" : "record",
1729           "type" : "Roo.data.Record|false",
1730           "desc" : "The data record returned from the underlying store (or false on nothing selected)",
1731           "isOptional" : false
1732         }
1733       ],
1734       "returns" : []
1735     },
1736     {
1737       "name" : "blur",
1738       "type" : "function",
1739       "desc" : "Fires when this field loses input focus.",
1740       "sig" : "function (_self)\n{\n\n}",
1741       "memberOf" : "Roo.form.Field",
1742       "example" : "",
1743       "deprecated" : "",
1744       "since" : "",
1745       "see" : "",
1746       "params" : [
1747         {
1748           "name" : "this",
1749           "type" : "Roo.form.Field",
1750           "desc" : "",
1751           "isOptional" : false
1752         }
1753       ],
1754       "returns" : []
1755     },
1756     {
1757       "name" : "valid",
1758       "type" : "function",
1759       "desc" : "Fires after the field has been validated with no errors.",
1760       "sig" : "function (_self)\n{\n\n}",
1761       "memberOf" : "Roo.form.Field",
1762       "example" : "",
1763       "deprecated" : "",
1764       "since" : "",
1765       "see" : "",
1766       "params" : [
1767         {
1768           "name" : "this",
1769           "type" : "Roo.form.Field",
1770           "desc" : "",
1771           "isOptional" : false
1772         }
1773       ],
1774       "returns" : []
1775     },
1776     {
1777       "name" : "specialkey",
1778       "type" : "function",
1779       "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.  You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
1780       "sig" : "function (_self, e)\n{\n\n}",
1781       "memberOf" : "Roo.form.Field",
1782       "example" : "",
1783       "deprecated" : "",
1784       "since" : "",
1785       "see" : "",
1786       "params" : [
1787         {
1788           "name" : "this",
1789           "type" : "Roo.form.Field",
1790           "desc" : "",
1791           "isOptional" : false
1792         },
1793         {
1794           "name" : "e",
1795           "type" : "Roo.EventObject",
1796           "desc" : "The event object",
1797           "isOptional" : false
1798         }
1799       ],
1800       "returns" : []
1801     },
1802     {
1803       "name" : "focus",
1804       "type" : "function",
1805       "desc" : "Fires when this field receives input focus.",
1806       "sig" : "function (_self)\n{\n\n}",
1807       "memberOf" : "Roo.form.Field",
1808       "example" : "",
1809       "deprecated" : "",
1810       "since" : "",
1811       "see" : "",
1812       "params" : [
1813         {
1814           "name" : "this",
1815           "type" : "Roo.form.Field",
1816           "desc" : "",
1817           "isOptional" : false
1818         }
1819       ],
1820       "returns" : []
1821     },
1822     {
1823       "name" : "keyup",
1824       "type" : "function",
1825       "desc" : "Fires after the key up",
1826       "sig" : "function (_self, e)\n{\n\n}",
1827       "memberOf" : "Roo.form.Field",
1828       "example" : "",
1829       "deprecated" : "",
1830       "since" : "",
1831       "see" : "",
1832       "params" : [
1833         {
1834           "name" : "this",
1835           "type" : "Roo.form.Field",
1836           "desc" : "",
1837           "isOptional" : false
1838         },
1839         {
1840           "name" : "e",
1841           "type" : "Roo.EventObject",
1842           "desc" : "The event Object",
1843           "isOptional" : false
1844         }
1845       ],
1846       "returns" : []
1847     },
1848     {
1849       "name" : "invalid",
1850       "type" : "function",
1851       "desc" : "Fires after the field has been marked as invalid.",
1852       "sig" : "function (_self, msg)\n{\n\n}",
1853       "memberOf" : "Roo.form.Field",
1854       "example" : "",
1855       "deprecated" : "",
1856       "since" : "",
1857       "see" : "",
1858       "params" : [
1859         {
1860           "name" : "this",
1861           "type" : "Roo.form.Field",
1862           "desc" : "",
1863           "isOptional" : false
1864         },
1865         {
1866           "name" : "msg",
1867           "type" : "String",
1868           "desc" : "The validation message",
1869           "isOptional" : false
1870         }
1871       ],
1872       "returns" : []
1873     },
1874     {
1875       "name" : "change",
1876       "type" : "function",
1877       "desc" : "Fires just before the field blurs if the field value has changed.",
1878       "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
1879       "memberOf" : "Roo.form.Field",
1880       "example" : "",
1881       "deprecated" : "",
1882       "since" : "",
1883       "see" : "",
1884       "params" : [
1885         {
1886           "name" : "this",
1887           "type" : "Roo.form.Field",
1888           "desc" : "",
1889           "isOptional" : false
1890         },
1891         {
1892           "name" : "newValue",
1893           "type" : "Mixed",
1894           "desc" : "The new value",
1895           "isOptional" : false
1896         },
1897         {
1898           "name" : "oldValue",
1899           "type" : "Mixed",
1900           "desc" : "The original value",
1901           "isOptional" : false
1902         }
1903       ],
1904       "returns" : []
1905     },
1906     {
1907       "name" : "move",
1908       "type" : "function",
1909       "desc" : "Fires after the component is moved.",
1910       "sig" : "function (_self, x, y)\n{\n\n}",
1911       "memberOf" : "Roo.BoxComponent",
1912       "example" : "",
1913       "deprecated" : "",
1914       "since" : "",
1915       "see" : "",
1916       "params" : [
1917         {
1918           "name" : "this",
1919           "type" : "Roo.Component",
1920           "desc" : "",
1921           "isOptional" : false
1922         },
1923         {
1924           "name" : "x",
1925           "type" : "Number",
1926           "desc" : "The new x position",
1927           "isOptional" : false
1928         },
1929         {
1930           "name" : "y",
1931           "type" : "Number",
1932           "desc" : "The new y position",
1933           "isOptional" : false
1934         }
1935       ],
1936       "returns" : []
1937     },
1938     {
1939       "name" : "resize",
1940       "type" : "function",
1941       "desc" : "Fires after the component is resized.",
1942       "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
1943       "memberOf" : "Roo.BoxComponent",
1944       "example" : "",
1945       "deprecated" : "",
1946       "since" : "",
1947       "see" : "",
1948       "params" : [
1949         {
1950           "name" : "this",
1951           "type" : "Roo.Component",
1952           "desc" : "",
1953           "isOptional" : false
1954         },
1955         {
1956           "name" : "adjWidth",
1957           "type" : "Number",
1958           "desc" : "The box-adjusted width that was set",
1959           "isOptional" : false
1960         },
1961         {
1962           "name" : "adjHeight",
1963           "type" : "Number",
1964           "desc" : "The box-adjusted height that was set",
1965           "isOptional" : false
1966         },
1967         {
1968           "name" : "rawWidth",
1969           "type" : "Number",
1970           "desc" : "The width that was originally specified",
1971           "isOptional" : false
1972         },
1973         {
1974           "name" : "rawHeight",
1975           "type" : "Number",
1976           "desc" : "The height that was originally specified",
1977           "isOptional" : false
1978         }
1979       ],
1980       "returns" : []
1981     },
1982     {
1983       "name" : "beforerender",
1984       "type" : "function",
1985       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1986       "sig" : "function (_self)\n{\n\n}",
1987       "memberOf" : "Roo.Component",
1988       "example" : "",
1989       "deprecated" : "",
1990       "since" : "",
1991       "see" : "",
1992       "params" : [
1993         {
1994           "name" : "this",
1995           "type" : "Roo.Component",
1996           "desc" : "",
1997           "isOptional" : false
1998         }
1999       ],
2000       "returns" : []
2001     },
2002     {
2003       "name" : "disable",
2004       "type" : "function",
2005       "desc" : "Fires after the component is disabled.",
2006       "sig" : "function (_self)\n{\n\n}",
2007       "memberOf" : "Roo.Component",
2008       "example" : "",
2009       "deprecated" : "",
2010       "since" : "",
2011       "see" : "",
2012       "params" : [
2013         {
2014           "name" : "this",
2015           "type" : "Roo.Component",
2016           "desc" : "",
2017           "isOptional" : false
2018         }
2019       ],
2020       "returns" : []
2021     },
2022     {
2023       "name" : "render",
2024       "type" : "function",
2025       "desc" : "Fires after the component is rendered.",
2026       "sig" : "function (_self)\n{\n\n}",
2027       "memberOf" : "Roo.Component",
2028       "example" : "",
2029       "deprecated" : "",
2030       "since" : "",
2031       "see" : "",
2032       "params" : [
2033         {
2034           "name" : "this",
2035           "type" : "Roo.Component",
2036           "desc" : "",
2037           "isOptional" : false
2038         }
2039       ],
2040       "returns" : []
2041     },
2042     {
2043       "name" : "destroy",
2044       "type" : "function",
2045       "desc" : "Fires after the component is destroyed.",
2046       "sig" : "function (_self)\n{\n\n}",
2047       "memberOf" : "Roo.Component",
2048       "example" : "",
2049       "deprecated" : "",
2050       "since" : "",
2051       "see" : "",
2052       "params" : [
2053         {
2054           "name" : "this",
2055           "type" : "Roo.Component",
2056           "desc" : "",
2057           "isOptional" : false
2058         }
2059       ],
2060       "returns" : []
2061     },
2062     {
2063       "name" : "hide",
2064       "type" : "function",
2065       "desc" : "Fires after the component is hidden.",
2066       "sig" : "function (_self)\n{\n\n}",
2067       "memberOf" : "Roo.Component",
2068       "example" : "",
2069       "deprecated" : "",
2070       "since" : "",
2071       "see" : "",
2072       "params" : [
2073         {
2074           "name" : "this",
2075           "type" : "Roo.Component",
2076           "desc" : "",
2077           "isOptional" : false
2078         }
2079       ],
2080       "returns" : []
2081     },
2082     {
2083       "name" : "beforehide",
2084       "type" : "function",
2085       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
2086       "sig" : "function (_self)\n{\n\n}",
2087       "memberOf" : "Roo.Component",
2088       "example" : "",
2089       "deprecated" : "",
2090       "since" : "",
2091       "see" : "",
2092       "params" : [
2093         {
2094           "name" : "this",
2095           "type" : "Roo.Component",
2096           "desc" : "",
2097           "isOptional" : false
2098         }
2099       ],
2100       "returns" : []
2101     },
2102     {
2103       "name" : "show",
2104       "type" : "function",
2105       "desc" : "Fires after the component is shown.",
2106       "sig" : "function (_self)\n{\n\n}",
2107       "memberOf" : "Roo.Component",
2108       "example" : "",
2109       "deprecated" : "",
2110       "since" : "",
2111       "see" : "",
2112       "params" : [
2113         {
2114           "name" : "this",
2115           "type" : "Roo.Component",
2116           "desc" : "",
2117           "isOptional" : false
2118         }
2119       ],
2120       "returns" : []
2121     },
2122     {
2123       "name" : "beforeshow",
2124       "type" : "function",
2125       "desc" : "Fires before the component is shown.  Return false to stop the show.",
2126       "sig" : "function (_self)\n{\n\n}",
2127       "memberOf" : "Roo.Component",
2128       "example" : "",
2129       "deprecated" : "",
2130       "since" : "",
2131       "see" : "",
2132       "params" : [
2133         {
2134           "name" : "this",
2135           "type" : "Roo.Component",
2136           "desc" : "",
2137           "isOptional" : false
2138         }
2139       ],
2140       "returns" : []
2141     },
2142     {
2143       "name" : "enable",
2144       "type" : "function",
2145       "desc" : "Fires after the component is enabled.",
2146       "sig" : "function (_self)\n{\n\n}",
2147       "memberOf" : "Roo.Component",
2148       "example" : "",
2149       "deprecated" : "",
2150       "since" : "",
2151       "see" : "",
2152       "params" : [
2153         {
2154           "name" : "this",
2155           "type" : "Roo.Component",
2156           "desc" : "",
2157           "isOptional" : false
2158         }
2159       ],
2160       "returns" : []
2161     },
2162     {
2163       "name" : "beforedestroy",
2164       "type" : "function",
2165       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
2166       "sig" : "function (_self)\n{\n\n}",
2167       "memberOf" : "Roo.Component",
2168       "example" : "",
2169       "deprecated" : "",
2170       "since" : "",
2171       "see" : "",
2172       "params" : [
2173         {
2174           "name" : "this",
2175           "type" : "Roo.Component",
2176           "desc" : "",
2177           "isOptional" : false
2178         }
2179       ],
2180       "returns" : []
2181     }
2182   ]
2183 }