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