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