2 "name" : "Roo.form.Field",
8 "desc" : "Base class for form fields that provides default event handling, sizing, value handling and other functionality.",
16 "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
17 "memberOf" : "Roo.form.Field",
24 "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>",
25 "memberOf" : "Roo.util.Observable",
32 "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
33 "memberOf" : "Roo.form.Field",
38 "name" : "fieldLabel",
40 "desc" : "Label to use when rendering a form.",
41 "memberOf" : "Roo.form.Field",
46 "name" : "validationDelay",
48 "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
49 "memberOf" : "Roo.form.Field",
56 "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>",
57 "memberOf" : "Roo.form.Field",
64 "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\".",
65 "memberOf" : "Roo.Component",
74 "desc" : "True to disable the field (defaults to false).",
75 "memberOf" : "Roo.form.Field",
82 "desc" : "A value to initialize this field with.",
83 "memberOf" : "Roo.form.Field",
88 "name" : "allowDomMove",
90 "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
91 "memberOf" : "Roo.Component",
98 "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).",
99 "memberOf" : "Roo.form.Field",
106 "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
107 "memberOf" : "Roo.form.Field",
112 "name" : "invalidClass",
114 "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
115 "memberOf" : "Roo.form.Field",
122 "desc" : "A CSS class to apply to the field's underlying element.",
123 "memberOf" : "Roo.form.Field",
128 "name" : "autoCreate",
129 "type" : "String/Object",
130 "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
131 "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",
144 "name" : "actionMode",
146 "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
147 "memberOf" : "Roo.Component",
154 "desc" : "width (optional) size of component",
155 "memberOf" : "Roo.BoxComponent",
160 "name" : "validateOnBlur",
162 "desc" : "Whether the field should validate when it loses focus (defaults to true).",
163 "memberOf" : "Roo.form.Field",
168 "name" : "validationEvent",
169 "type" : "String/Boolean",
170 "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
171 "memberOf" : "Roo.form.Field",
178 "desc" : "The field's HTML name attribute.",
179 "memberOf" : "Roo.form.Field",
186 "desc" : "Mouse over tip",
187 "memberOf" : "Roo.form.Field",
192 "name" : "focusClass",
194 "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
195 "memberOf" : "Roo.form.Field",
200 "name" : "fieldClass",
202 "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
203 "memberOf" : "Roo.form.Field",
210 "desc" : "height (optional) size of component",
211 "memberOf" : "Roo.BoxComponent",
216 "name" : "disableClass",
218 "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
219 "memberOf" : "Roo.Component",
227 "desc" : "Validates the field value",
229 "isConstructor" : false,
231 "memberOf" : "Roo.form.Field",
242 "desc" : "True if the value is valid, else false"
248 "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
250 "isConstructor" : false,
252 "memberOf" : "Roo.form.Field",
263 "desc" : "value The field value"
269 "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
271 "isConstructor" : false,
273 "memberOf" : "Roo.form.Field",
282 "desc" : "The value to set",
291 "desc" : "Returns the name attribute of the field if available",
293 "isConstructor" : false,
295 "memberOf" : "Roo.form.Field",
306 "desc" : "name The field name"
311 "name" : "markInvalid",
312 "desc" : "Mark this field as invalid",
314 "isConstructor" : false,
316 "memberOf" : "Roo.form.Field",
325 "desc" : "The validation message",
333 "name" : "getRawValue",
334 "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
336 "isConstructor" : false,
338 "memberOf" : "Roo.form.Field",
349 "desc" : "value The field value"
355 "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
357 "isConstructor" : false,
359 "memberOf" : "Roo.form.Field",
367 "type" : "String/HTMLElement/Element",
368 "desc" : "The id of the node, a DOM node or an existing Element",
375 "type" : "Roo.form.Field",
381 "name" : "resetHasChanged",
382 "desc" : "stores the current value in loadedValue",
384 "isConstructor" : false,
386 "memberOf" : "Roo.form.Field",
398 "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.",
400 "isConstructor" : false,
402 "memberOf" : "Roo.form.Field",
413 "name" : "setRawValue",
414 "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
416 "isConstructor" : false,
418 "memberOf" : "Roo.form.Field",
427 "desc" : "The value to set",
435 "name" : "clearInvalid",
436 "desc" : "Clear any invalid styles/messages for this field",
438 "isConstructor" : false,
440 "memberOf" : "Roo.form.Field",
452 "desc" : "Returns whether or not the field value is currently valid",
454 "isConstructor" : false,
456 "memberOf" : "Roo.form.Field",
463 "name" : "preventMark",
465 "desc" : "True to disable marking the field invalid",
473 "desc" : "True if the value is valid, else false"
479 "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
481 "isConstructor" : false,
483 "memberOf" : "Roo.form.Field",
494 "name" : "hasChanged",
495 "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
497 "isConstructor" : false,
499 "memberOf" : "Roo.form.Field",
510 "name" : "updateBox",
511 "desc" : "Sets the current box measurements of the component's underlying element.",
513 "isConstructor" : false,
515 "memberOf" : "Roo.BoxComponent",
524 "desc" : "An object in the format {x, y, width, height}",
532 "name" : "setPagePosition",
533 "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.",
535 "isConstructor" : false,
537 "memberOf" : "Roo.BoxComponent",
546 "desc" : "The new x position",
552 "desc" : "The new y position",
561 "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
563 "isConstructor" : false,
565 "memberOf" : "Roo.BoxComponent",
577 "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}.",
579 "isConstructor" : false,
581 "memberOf" : "Roo.BoxComponent",
589 "type" : "Number/Object",
590 "desc" : "The new width to set, or a size object in the format {width, height}",
596 "desc" : "The new height to set (not required if a size object is passed as the first arg)",
603 "type" : "Roo.BoxComponent",
609 "name" : "getPosition",
610 "desc" : "Gets the current XY position of the component's underlying element.",
612 "isConstructor" : false,
614 "memberOf" : "Roo.BoxComponent",
623 "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
631 "desc" : "The XY position of the element (e.g., [100, 200])"
637 "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.",
639 "isConstructor" : false,
641 "memberOf" : "Roo.BoxComponent",
650 "desc" : "The box-adjusted width that was set",
654 "name" : "adjHeight",
656 "desc" : "The box-adjusted height that was set",
662 "desc" : "The width that was originally specified",
666 "name" : "rawHeight",
668 "desc" : "The height that was originally specified",
677 "desc" : "Gets the current box measurements of the component's underlying element.",
679 "isConstructor" : false,
681 "memberOf" : "Roo.BoxComponent",
690 "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
699 "desc" : "Gets the current size of the component's underlying element.",
701 "isConstructor" : false,
703 "memberOf" : "Roo.BoxComponent",
714 "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
719 "name" : "onPosition",
720 "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.",
722 "isConstructor" : false,
724 "memberOf" : "Roo.BoxComponent",
733 "desc" : "The new x position",
739 "desc" : "The new y position",
747 "name" : "setPosition",
748 "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.",
750 "isConstructor" : false,
752 "memberOf" : "Roo.BoxComponent",
761 "desc" : "The new left",
767 "desc" : "The new top",
776 "desc" : "Returns the id of this component.",
778 "isConstructor" : false,
780 "memberOf" : "Roo.Component",
797 "desc" : "If this is a lazy rendering component, render it to its container element.",
799 "isConstructor" : false,
801 "memberOf" : "Roo.Component",
808 "name" : "container",
809 "type" : "String/HTMLElement/Element",
810 "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
819 "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}.",
821 "isConstructor" : false,
823 "memberOf" : "Roo.Component",
834 "name" : "isVisible",
835 "desc" : "Returns true if this component is visible.",
837 "isConstructor" : false,
839 "memberOf" : "Roo.Component",
850 "name" : "setDisabled",
851 "desc" : "Convenience function for setting disabled/enabled by boolean.",
853 "isConstructor" : false,
855 "memberOf" : "Roo.Component",
873 "desc" : "Hide this component.",
875 "isConstructor" : false,
877 "memberOf" : "Roo.Component",
887 "type" : "Roo.Component",
894 "desc" : "Try to focus this component.",
896 "isConstructor" : false,
898 "memberOf" : "Roo.Component",
905 "name" : "selectText",
907 "desc" : "True to also select the text in this component (if applicable)",
914 "type" : "Roo.Component",
921 "desc" : "Show this component.",
923 "isConstructor" : false,
925 "memberOf" : "Roo.Component",
935 "type" : "Roo.Component",
942 "desc" : "Enable this component.",
944 "isConstructor" : false,
946 "memberOf" : "Roo.Component",
956 "type" : "Roo.Component",
962 "name" : "setVisible",
963 "desc" : "Convenience function to hide or show this component by boolean.",
965 "isConstructor" : false,
967 "memberOf" : "Roo.Component",
976 "desc" : "True to show, false to hide",
983 "type" : "Roo.Component",
990 "desc" : "Disable this component.",
992 "isConstructor" : false,
994 "memberOf" : "Roo.Component",
1004 "type" : "Roo.Component",
1011 "desc" : "Returns the underlying {@link Roo.Element}.",
1013 "isConstructor" : false,
1014 "isPrivate" : false,
1015 "memberOf" : "Roo.Component",
1025 "type" : "Roo.Element",
1026 "desc" : "The element"
1031 "name" : "purgeListeners",
1032 "desc" : "Removes all listeners for this object",
1034 "isConstructor" : false,
1035 "isPrivate" : false,
1036 "memberOf" : "Roo.util.Observable",
1048 "desc" : "Appends an event handler to this element (shorthand for addListener)",
1050 "isConstructor" : false,
1051 "isPrivate" : false,
1052 "memberOf" : "Roo.util.Observable",
1059 "name" : "eventName",
1061 "desc" : "The type of event to listen for",
1062 "isOptional" : false
1066 "type" : "Function",
1067 "desc" : "The method the event invokes",
1068 "isOptional" : false
1073 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1074 "isOptional" : false
1079 "desc" : "(optional)",
1080 "isOptional" : false
1088 "desc" : "Removes a listener (shorthand for removeListener)",
1090 "isConstructor" : false,
1091 "isPrivate" : false,
1092 "memberOf" : "Roo.util.Observable",
1099 "name" : "eventName",
1101 "desc" : "The type of event to listen for",
1102 "isOptional" : false
1106 "type" : "Function",
1107 "desc" : "The handler to remove",
1108 "isOptional" : false
1113 "desc" : "(optional) The scope (this object) for the handler",
1114 "isOptional" : false
1121 "name" : "addEvents",
1122 "desc" : "Used to define events on this Observable",
1124 "isConstructor" : false,
1125 "isPrivate" : false,
1126 "memberOf" : "Roo.util.Observable",
1135 "desc" : "The object with the events defined",
1136 "isOptional" : false
1143 "name" : "releaseCapture",
1144 "desc" : "Removes <b>all</b> added captures from the Observable.",
1146 "isConstructor" : false,
1147 "isPrivate" : false,
1148 "memberOf" : "Roo.util.Observable",
1156 "type" : "Observable",
1157 "desc" : "The Observable to release",
1158 "isOptional" : false
1165 "name" : "removeListener",
1166 "desc" : "Removes a listener",
1168 "isConstructor" : false,
1169 "isPrivate" : false,
1170 "memberOf" : "Roo.util.Observable",
1177 "name" : "eventName",
1179 "desc" : "The type of event to listen for",
1180 "isOptional" : false
1184 "type" : "Function",
1185 "desc" : "The handler to remove",
1186 "isOptional" : false
1191 "desc" : "(optional) The scope (this object) for the handler",
1192 "isOptional" : false
1199 "name" : "fireEvent",
1200 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1202 "isConstructor" : false,
1203 "isPrivate" : false,
1204 "memberOf" : "Roo.util.Observable",
1211 "name" : "eventName",
1214 "isOptional" : false
1218 "type" : "Object...",
1219 "desc" : "Variable number of parameters are passed to handlers",
1220 "isOptional" : false
1227 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1232 "name" : "hasListener",
1233 "desc" : "Checks to see if this object has any listeners for a specified event",
1235 "isConstructor" : false,
1236 "isPrivate" : false,
1237 "memberOf" : "Roo.util.Observable",
1244 "name" : "eventName",
1246 "desc" : "The name of the event to check for",
1247 "isOptional" : false
1254 "desc" : "True if the event is being listened for, else false"
1260 "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.",
1262 "isConstructor" : false,
1263 "isPrivate" : false,
1264 "memberOf" : "Roo.util.Observable",
1272 "type" : "Observable",
1273 "desc" : "The Observable to capture",
1274 "isOptional" : false
1278 "type" : "Function",
1279 "desc" : "The function to call",
1280 "isOptional" : false
1285 "desc" : "(optional) The scope (this object) for the fn",
1286 "isOptional" : false
1293 "name" : "addListener",
1294 "desc" : "Appends an event handler to this component",
1296 "isConstructor" : false,
1297 "isPrivate" : false,
1298 "memberOf" : "Roo.util.Observable",
1305 "name" : "eventName",
1307 "desc" : "The type of event to listen for",
1308 "isOptional" : false
1312 "type" : "Function",
1313 "desc" : "The method the event invokes",
1314 "isOptional" : false
1319 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1320 "isOptional" : false
1325 "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>",
1326 "isOptional" : false
1336 "desc" : "Fires when this field loses input focus.",
1345 "type" : "Roo.form.Field",
1347 "isOptional" : false
1355 "desc" : "Fires after the field has been validated with no errors.",
1364 "type" : "Roo.form.Field",
1366 "isOptional" : false
1373 "name" : "specialkey",
1374 "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.",
1383 "type" : "Roo.form.Field",
1385 "isOptional" : false
1389 "type" : "Roo.EventObject",
1390 "desc" : "The event object",
1391 "isOptional" : false
1399 "desc" : "Fires when this field receives input focus.",
1408 "type" : "Roo.form.Field",
1410 "isOptional" : false
1418 "desc" : "Fires after the key up",
1427 "type" : "Roo.form.Field",
1429 "isOptional" : false
1433 "type" : "Roo.EventObject",
1434 "desc" : "The event Object",
1435 "isOptional" : false
1443 "desc" : "Fires after the field has been marked as invalid.",
1452 "type" : "Roo.form.Field",
1454 "isOptional" : false
1459 "desc" : "The validation message",
1460 "isOptional" : false
1468 "desc" : "Fires just before the field blurs if the field value has changed.",
1477 "type" : "Roo.form.Field",
1479 "isOptional" : false
1482 "name" : "newValue",
1484 "desc" : "The new value",
1485 "isOptional" : false
1488 "name" : "oldValue",
1490 "desc" : "The original value",
1491 "isOptional" : false
1499 "desc" : "Fires after the component is moved.",
1500 "memberOf" : "Roo.BoxComponent",
1508 "type" : "Roo.Component",
1510 "isOptional" : false
1515 "desc" : "The new x position",
1516 "isOptional" : false
1521 "desc" : "The new y position",
1522 "isOptional" : false
1530 "desc" : "Fires after the component is resized.",
1531 "memberOf" : "Roo.BoxComponent",
1539 "type" : "Roo.Component",
1541 "isOptional" : false
1544 "name" : "adjWidth",
1546 "desc" : "The box-adjusted width that was set",
1547 "isOptional" : false
1550 "name" : "adjHeight",
1552 "desc" : "The box-adjusted height that was set",
1553 "isOptional" : false
1556 "name" : "rawWidth",
1558 "desc" : "The width that was originally specified",
1559 "isOptional" : false
1562 "name" : "rawHeight",
1564 "desc" : "The height that was originally specified",
1565 "isOptional" : false
1572 "name" : "beforerender",
1573 "desc" : "Fires before the component is rendered. Return false to stop the render.",
1574 "memberOf" : "Roo.Component",
1582 "type" : "Roo.Component",
1584 "isOptional" : false
1592 "desc" : "Fires after the component is disabled.",
1593 "memberOf" : "Roo.Component",
1601 "type" : "Roo.Component",
1603 "isOptional" : false
1611 "desc" : "Fires after the component is rendered.",
1612 "memberOf" : "Roo.Component",
1620 "type" : "Roo.Component",
1622 "isOptional" : false
1630 "desc" : "Fires after the component is destroyed.",
1631 "memberOf" : "Roo.Component",
1639 "type" : "Roo.Component",
1641 "isOptional" : false
1649 "desc" : "Fires after the component is hidden.",
1650 "memberOf" : "Roo.Component",
1658 "type" : "Roo.Component",
1660 "isOptional" : false
1667 "name" : "beforehide",
1668 "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1669 "memberOf" : "Roo.Component",
1677 "type" : "Roo.Component",
1679 "isOptional" : false
1687 "desc" : "Fires after the component is shown.",
1688 "memberOf" : "Roo.Component",
1696 "type" : "Roo.Component",
1698 "isOptional" : false
1705 "name" : "beforeshow",
1706 "desc" : "Fires before the component is shown. Return false to stop the show.",
1707 "memberOf" : "Roo.Component",
1715 "type" : "Roo.Component",
1717 "isOptional" : false
1725 "desc" : "Fires after the component is enabled.",
1726 "memberOf" : "Roo.Component",
1734 "type" : "Roo.Component",
1736 "isOptional" : false
1743 "name" : "beforedestroy",
1744 "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1745 "memberOf" : "Roo.Component",
1753 "type" : "Roo.Component",
1755 "isOptional" : false