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