2 "name" : "Roo.form.Field",
8 "desc" : "Base class for form fields that provides default event handling, sizing, value handling and other functionality.",
21 "desc" : "Configuration options",
30 "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
31 "memberOf" : "Roo.form.Field",
37 "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>",
38 "memberOf" : "Roo.util.Observable",
44 "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
45 "memberOf" : "Roo.form.Field",
49 "name" : "fieldLabel",
51 "desc" : "Label to use when rendering a form.",
52 "memberOf" : "Roo.form.Field",
56 "name" : "validationDelay",
58 "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
59 "memberOf" : "Roo.form.Field",
65 "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>",
66 "memberOf" : "Roo.form.Field",
72 "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
73 "memberOf" : "Roo.Component",
82 "desc" : "True to disable the field (defaults to false).",
83 "memberOf" : "Roo.form.Field",
89 "desc" : "A value to initialize this field with.",
90 "memberOf" : "Roo.form.Field",
94 "name" : "allowDomMove",
96 "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
97 "memberOf" : "Roo.Component",
103 "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).",
104 "memberOf" : "Roo.form.Field",
110 "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
111 "memberOf" : "Roo.form.Field",
115 "name" : "invalidClass",
117 "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
118 "memberOf" : "Roo.form.Field",
124 "desc" : "A CSS class to apply to the field's underlying element.",
125 "memberOf" : "Roo.form.Field",
129 "name" : "autoCreate",
130 "type" : "String/Object",
131 "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
132 "memberOf" : "Roo.form.Field",
136 "name" : "invalidText",
138 "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\")",
139 "memberOf" : "Roo.form.Field",
143 "name" : "actionMode",
145 "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",
146 "memberOf" : "Roo.Component",
152 "desc" : "width (optional) size of component",
153 "memberOf" : "Roo.BoxComponent",
157 "name" : "validateOnBlur",
159 "desc" : "Whether the field should validate when it loses focus (defaults to true).",
160 "memberOf" : "Roo.form.Field",
164 "name" : "validationEvent",
165 "type" : "String/Boolean",
166 "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
167 "memberOf" : "Roo.form.Field",
173 "desc" : "The field's HTML name attribute.",
174 "memberOf" : "Roo.form.Field",
180 "desc" : "Mouse over tip",
181 "memberOf" : "Roo.form.Field",
185 "name" : "focusClass",
187 "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
188 "memberOf" : "Roo.form.Field",
192 "name" : "fieldClass",
194 "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
195 "memberOf" : "Roo.form.Field",
201 "desc" : "height (optional) size of component",
202 "memberOf" : "Roo.BoxComponent",
206 "name" : "disableClass",
208 "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
209 "memberOf" : "Roo.Component",
216 "desc" : "Validates the field value",
218 "isConstructor" : false,
220 "memberOf" : "Roo.form.Field",
230 "desc" : "True if the value is valid, else false"
236 "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
238 "isConstructor" : false,
240 "memberOf" : "Roo.form.Field",
250 "desc" : "value The field value"
256 "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
258 "isConstructor" : false,
260 "memberOf" : "Roo.form.Field",
269 "desc" : "The value to set",
277 "desc" : "Returns the name attribute of the field if available",
279 "isConstructor" : false,
281 "memberOf" : "Roo.form.Field",
291 "desc" : "name The field name"
296 "name" : "markInvalid",
297 "desc" : "Mark this field as invalid",
299 "isConstructor" : false,
301 "memberOf" : "Roo.form.Field",
310 "desc" : "The validation message",
317 "name" : "getRawValue",
318 "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
320 "isConstructor" : false,
322 "memberOf" : "Roo.form.Field",
332 "desc" : "value The field value"
338 "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
340 "isConstructor" : false,
342 "memberOf" : "Roo.form.Field",
350 "type" : "String/HTMLElement/Element",
351 "desc" : "The id of the node, a DOM node or an existing Element",
358 "type" : "Roo.form.Field",
364 "name" : "resetHasChanged",
365 "desc" : "stores the current value in loadedValue",
367 "isConstructor" : false,
369 "memberOf" : "Roo.form.Field",
379 "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.",
381 "isConstructor" : false,
383 "memberOf" : "Roo.form.Field",
392 "name" : "setRawValue",
393 "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
395 "isConstructor" : false,
397 "memberOf" : "Roo.form.Field",
406 "desc" : "The value to set",
413 "name" : "clearInvalid",
414 "desc" : "Clear any invalid styles/messages for this field",
416 "isConstructor" : false,
418 "memberOf" : "Roo.form.Field",
428 "desc" : "Returns whether or not the field value is currently valid",
430 "isConstructor" : false,
432 "memberOf" : "Roo.form.Field",
439 "name" : "preventMark",
441 "desc" : "True to disable marking the field invalid",
449 "desc" : "True if the value is valid, else false"
455 "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
457 "isConstructor" : false,
459 "memberOf" : "Roo.form.Field",
468 "name" : "hasChanged",
469 "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
471 "isConstructor" : false,
473 "memberOf" : "Roo.form.Field",
482 "name" : "updateBox",
483 "desc" : "Sets the current box measurements of the component's underlying element.",
485 "isConstructor" : false,
487 "memberOf" : "Roo.BoxComponent",
496 "desc" : "An object in the format {x, y, width, height}",
503 "name" : "setPagePosition",
504 "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.",
506 "isConstructor" : false,
508 "memberOf" : "Roo.BoxComponent",
517 "desc" : "The new x position",
523 "desc" : "The new y position",
531 "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
533 "isConstructor" : false,
535 "memberOf" : "Roo.BoxComponent",
545 "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}.",
547 "isConstructor" : false,
549 "memberOf" : "Roo.BoxComponent",
557 "type" : "Number/Object",
558 "desc" : "The new width to set, or a size object in the format {width, height}",
564 "desc" : "The new height to set (not required if a size object is passed as the first arg)",
571 "type" : "Roo.BoxComponent",
577 "name" : "getPosition",
578 "desc" : "Gets the current XY position of the component's underlying element.",
580 "isConstructor" : false,
582 "memberOf" : "Roo.BoxComponent",
591 "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
599 "desc" : "The XY position of the element (e.g., [100, 200])"
605 "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.",
607 "isConstructor" : false,
609 "memberOf" : "Roo.BoxComponent",
618 "desc" : "The box-adjusted width that was set",
622 "name" : "adjHeight",
624 "desc" : "The box-adjusted height that was set",
630 "desc" : "The width that was originally specified",
634 "name" : "rawHeight",
636 "desc" : "The height that was originally specified",
644 "desc" : "Gets the current box measurements of the component's underlying element.",
646 "isConstructor" : false,
648 "memberOf" : "Roo.BoxComponent",
657 "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
665 "desc" : "Gets the current size of the component's underlying element.",
667 "isConstructor" : false,
669 "memberOf" : "Roo.BoxComponent",
679 "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
684 "name" : "onPosition",
685 "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.",
687 "isConstructor" : false,
689 "memberOf" : "Roo.BoxComponent",
698 "desc" : "The new x position",
704 "desc" : "The new y position",
711 "name" : "setPosition",
712 "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.",
714 "isConstructor" : false,
716 "memberOf" : "Roo.BoxComponent",
725 "desc" : "The new left",
731 "desc" : "The new top",
739 "desc" : "Returns the id of this component.",
741 "isConstructor" : false,
743 "memberOf" : "Roo.Component",
759 "desc" : "If this is a lazy rendering component, render it to its container element.",
761 "isConstructor" : false,
763 "memberOf" : "Roo.Component",
770 "name" : "container",
771 "type" : "String/HTMLElement/Element",
772 "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
780 "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}.",
782 "isConstructor" : false,
784 "memberOf" : "Roo.Component",
793 "name" : "isVisible",
794 "desc" : "Returns true if this component is visible.",
796 "isConstructor" : false,
798 "memberOf" : "Roo.Component",
807 "name" : "setDisabled",
808 "desc" : "Convenience function for setting disabled/enabled by boolean.",
810 "isConstructor" : false,
812 "memberOf" : "Roo.Component",
829 "desc" : "Hide this component.",
831 "isConstructor" : false,
833 "memberOf" : "Roo.Component",
842 "type" : "Roo.Component",
849 "desc" : "Try to focus this component.",
851 "isConstructor" : false,
853 "memberOf" : "Roo.Component",
860 "name" : "selectText",
862 "desc" : "True to also select the text in this component (if applicable)",
869 "type" : "Roo.Component",
876 "desc" : "Show this component.",
878 "isConstructor" : false,
880 "memberOf" : "Roo.Component",
889 "type" : "Roo.Component",
896 "desc" : "Enable this component.",
898 "isConstructor" : false,
900 "memberOf" : "Roo.Component",
909 "type" : "Roo.Component",
915 "name" : "setVisible",
916 "desc" : "Convenience function to hide or show this component by boolean.",
918 "isConstructor" : false,
920 "memberOf" : "Roo.Component",
929 "desc" : "True to show, false to hide",
936 "type" : "Roo.Component",
943 "desc" : "Disable this component.",
945 "isConstructor" : false,
947 "memberOf" : "Roo.Component",
956 "type" : "Roo.Component",
963 "desc" : "Returns the underlying {@link Roo.Element}.",
965 "isConstructor" : false,
967 "memberOf" : "Roo.Component",
976 "type" : "Roo.Element",
977 "desc" : "The element"
982 "name" : "purgeListeners",
983 "desc" : "Removes all listeners for this object",
985 "isConstructor" : false,
987 "memberOf" : "Roo.util.Observable",
997 "desc" : "Appends an event handler to this element (shorthand for addListener)",
999 "isConstructor" : false,
1000 "isPrivate" : false,
1001 "memberOf" : "Roo.util.Observable",
1008 "name" : "eventName",
1010 "desc" : "The type of event to listen for",
1011 "isOptional" : false
1015 "type" : "Function",
1016 "desc" : "The method the event invokes",
1017 "isOptional" : false
1022 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1023 "isOptional" : false
1028 "desc" : "(optional)",
1029 "isOptional" : false
1036 "desc" : "Removes a listener (shorthand for removeListener)",
1038 "isConstructor" : false,
1039 "isPrivate" : false,
1040 "memberOf" : "Roo.util.Observable",
1047 "name" : "eventName",
1049 "desc" : "The type of event to listen for",
1050 "isOptional" : false
1054 "type" : "Function",
1055 "desc" : "The handler to remove",
1056 "isOptional" : false
1061 "desc" : "(optional) The scope (this object) for the handler",
1062 "isOptional" : false
1068 "name" : "addEvents",
1069 "desc" : "Used to define events on this Observable",
1071 "isConstructor" : false,
1072 "isPrivate" : false,
1073 "memberOf" : "Roo.util.Observable",
1082 "desc" : "The object with the events defined",
1083 "isOptional" : false
1089 "name" : "releaseCapture",
1090 "desc" : "Removes <b>all</b> added captures from the Observable.",
1092 "isConstructor" : false,
1093 "isPrivate" : false,
1094 "memberOf" : "Roo.util.Observable",
1102 "type" : "Observable",
1103 "desc" : "The Observable to release",
1104 "isOptional" : false
1110 "name" : "removeListener",
1111 "desc" : "Removes a listener",
1113 "isConstructor" : false,
1114 "isPrivate" : false,
1115 "memberOf" : "Roo.util.Observable",
1122 "name" : "eventName",
1124 "desc" : "The type of event to listen for",
1125 "isOptional" : false
1129 "type" : "Function",
1130 "desc" : "The handler to remove",
1131 "isOptional" : false
1136 "desc" : "(optional) The scope (this object) for the handler",
1137 "isOptional" : false
1143 "name" : "fireEvent",
1144 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1146 "isConstructor" : false,
1147 "isPrivate" : false,
1148 "memberOf" : "Roo.util.Observable",
1155 "name" : "eventName",
1158 "isOptional" : false
1162 "type" : "Object...",
1163 "desc" : "Variable number of parameters are passed to handlers",
1164 "isOptional" : false
1171 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1176 "name" : "hasListener",
1177 "desc" : "Checks to see if this object has any listeners for a specified event",
1179 "isConstructor" : false,
1180 "isPrivate" : false,
1181 "memberOf" : "Roo.util.Observable",
1188 "name" : "eventName",
1190 "desc" : "The name of the event to check for",
1191 "isOptional" : false
1198 "desc" : "True if the event is being listened for, else false"
1204 "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.",
1206 "isConstructor" : false,
1207 "isPrivate" : false,
1208 "memberOf" : "Roo.util.Observable",
1216 "type" : "Observable",
1217 "desc" : "The Observable to capture",
1218 "isOptional" : false
1222 "type" : "Function",
1223 "desc" : "The function to call",
1224 "isOptional" : false
1229 "desc" : "(optional) The scope (this object) for the fn",
1230 "isOptional" : false
1236 "name" : "addListener",
1237 "desc" : "Appends an event handler to this component",
1239 "isConstructor" : false,
1240 "isPrivate" : false,
1241 "memberOf" : "Roo.util.Observable",
1248 "name" : "eventName",
1250 "desc" : "The type of event to listen for",
1251 "isOptional" : false
1255 "type" : "Function",
1256 "desc" : "The method the event invokes",
1257 "isOptional" : false
1262 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1263 "isOptional" : false
1268 "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>",
1269 "isOptional" : false
1278 "desc" : "Fires when this field loses input focus.",
1279 "memberOf" : "Roo.form.Field",
1287 "type" : "Roo.form.Field",
1289 "isOptional" : false
1296 "desc" : "Fires after the field has been validated with no errors.",
1297 "memberOf" : "Roo.form.Field",
1305 "type" : "Roo.form.Field",
1307 "isOptional" : false
1313 "name" : "specialkey",
1314 "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.",
1315 "memberOf" : "Roo.form.Field",
1323 "type" : "Roo.form.Field",
1325 "isOptional" : false
1329 "type" : "Roo.EventObject",
1330 "desc" : "The event object",
1331 "isOptional" : false
1338 "desc" : "Fires when this field receives input focus.",
1339 "memberOf" : "Roo.form.Field",
1347 "type" : "Roo.form.Field",
1349 "isOptional" : false
1356 "desc" : "Fires after the key up",
1357 "memberOf" : "Roo.form.Field",
1365 "type" : "Roo.form.Field",
1367 "isOptional" : false
1371 "type" : "Roo.EventObject",
1372 "desc" : "The event Object",
1373 "isOptional" : false
1380 "desc" : "Fires after the field has been marked as invalid.",
1381 "memberOf" : "Roo.form.Field",
1389 "type" : "Roo.form.Field",
1391 "isOptional" : false
1396 "desc" : "The validation message",
1397 "isOptional" : false
1404 "desc" : "Fires just before the field blurs if the field value has changed.",
1405 "memberOf" : "Roo.form.Field",
1413 "type" : "Roo.form.Field",
1415 "isOptional" : false
1418 "name" : "newValue",
1420 "desc" : "The new value",
1421 "isOptional" : false
1424 "name" : "oldValue",
1426 "desc" : "The original value",
1427 "isOptional" : false
1434 "desc" : "Fires after the component is moved.",
1435 "memberOf" : "Roo.BoxComponent",
1443 "type" : "Roo.Component",
1445 "isOptional" : false
1450 "desc" : "The new x position",
1451 "isOptional" : false
1456 "desc" : "The new y position",
1457 "isOptional" : false
1464 "desc" : "Fires after the component is resized.",
1465 "memberOf" : "Roo.BoxComponent",
1473 "type" : "Roo.Component",
1475 "isOptional" : false
1478 "name" : "adjWidth",
1480 "desc" : "The box-adjusted width that was set",
1481 "isOptional" : false
1484 "name" : "adjHeight",
1486 "desc" : "The box-adjusted height that was set",
1487 "isOptional" : false
1490 "name" : "rawWidth",
1492 "desc" : "The width that was originally specified",
1493 "isOptional" : false
1496 "name" : "rawHeight",
1498 "desc" : "The height that was originally specified",
1499 "isOptional" : false
1505 "name" : "beforerender",
1506 "desc" : "Fires before the component is rendered. Return false to stop the render.",
1507 "memberOf" : "Roo.Component",
1515 "type" : "Roo.Component",
1517 "isOptional" : false
1524 "desc" : "Fires after the component is disabled.",
1525 "memberOf" : "Roo.Component",
1533 "type" : "Roo.Component",
1535 "isOptional" : false
1542 "desc" : "Fires after the component is rendered.",
1543 "memberOf" : "Roo.Component",
1551 "type" : "Roo.Component",
1553 "isOptional" : false
1560 "desc" : "Fires after the component is destroyed.",
1561 "memberOf" : "Roo.Component",
1569 "type" : "Roo.Component",
1571 "isOptional" : false
1578 "desc" : "Fires after the component is hidden.",
1579 "memberOf" : "Roo.Component",
1587 "type" : "Roo.Component",
1589 "isOptional" : false
1595 "name" : "beforehide",
1596 "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1597 "memberOf" : "Roo.Component",
1605 "type" : "Roo.Component",
1607 "isOptional" : false
1614 "desc" : "Fires after the component is shown.",
1615 "memberOf" : "Roo.Component",
1623 "type" : "Roo.Component",
1625 "isOptional" : false
1631 "name" : "beforeshow",
1632 "desc" : "Fires before the component is shown. Return false to stop the show.",
1633 "memberOf" : "Roo.Component",
1641 "type" : "Roo.Component",
1643 "isOptional" : false
1650 "desc" : "Fires after the component is enabled.",
1651 "memberOf" : "Roo.Component",
1659 "type" : "Roo.Component",
1661 "isOptional" : false
1667 "name" : "beforedestroy",
1668 "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1669 "memberOf" : "Roo.Component",
1677 "type" : "Roo.Component",
1679 "isOptional" : false