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