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",
31 "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
32 "memberOf" : "Roo.form.Field",
39 "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>",
40 "memberOf" : "Roo.util.Observable",
47 "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
48 "memberOf" : "Roo.form.Field",
53 "name" : "fieldLabel",
55 "desc" : "Label to use when rendering a form.",
56 "memberOf" : "Roo.form.Field",
61 "name" : "validationDelay",
63 "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
64 "memberOf" : "Roo.form.Field",
71 "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>",
72 "memberOf" : "Roo.form.Field",
79 "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\".",
80 "memberOf" : "Roo.Component",
89 "desc" : "True to disable the field (defaults to false).",
90 "memberOf" : "Roo.form.Field",
97 "desc" : "A value to initialize this field with.",
98 "memberOf" : "Roo.form.Field",
103 "name" : "allowDomMove",
105 "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
106 "memberOf" : "Roo.Component",
113 "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).",
114 "memberOf" : "Roo.form.Field",
121 "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
122 "memberOf" : "Roo.form.Field",
127 "name" : "invalidClass",
129 "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
130 "memberOf" : "Roo.form.Field",
137 "desc" : "A CSS class to apply to the field's underlying element.",
138 "memberOf" : "Roo.form.Field",
143 "name" : "autoCreate",
144 "type" : "String/Object",
145 "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
146 "memberOf" : "Roo.form.Field",
151 "name" : "invalidText",
153 "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\")",
154 "memberOf" : "Roo.form.Field",
159 "name" : "actionMode",
161 "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",
162 "memberOf" : "Roo.Component",
169 "desc" : "width (optional) size of component",
170 "memberOf" : "Roo.BoxComponent",
175 "name" : "validateOnBlur",
177 "desc" : "Whether the field should validate when it loses focus (defaults to true).",
178 "memberOf" : "Roo.form.Field",
183 "name" : "validationEvent",
184 "type" : "String/Boolean",
185 "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
186 "memberOf" : "Roo.form.Field",
193 "desc" : "The field's HTML name attribute.",
194 "memberOf" : "Roo.form.Field",
201 "desc" : "Mouse over tip",
202 "memberOf" : "Roo.form.Field",
207 "name" : "focusClass",
209 "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
210 "memberOf" : "Roo.form.Field",
215 "name" : "fieldClass",
217 "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
218 "memberOf" : "Roo.form.Field",
225 "desc" : "height (optional) size of component",
226 "memberOf" : "Roo.BoxComponent",
231 "name" : "disableClass",
233 "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
234 "memberOf" : "Roo.Component",
242 "desc" : "Validates the field value",
244 "isConstructor" : false,
246 "memberOf" : "Roo.form.Field",
257 "desc" : "True if the value is valid, else false"
263 "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
265 "isConstructor" : false,
267 "memberOf" : "Roo.form.Field",
278 "desc" : "value The field value"
284 "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
286 "isConstructor" : false,
288 "memberOf" : "Roo.form.Field",
297 "desc" : "The value to set",
306 "desc" : "Returns the name attribute of the field if available",
308 "isConstructor" : false,
310 "memberOf" : "Roo.form.Field",
321 "desc" : "name The field name"
326 "name" : "markInvalid",
327 "desc" : "Mark this field as invalid",
329 "isConstructor" : false,
331 "memberOf" : "Roo.form.Field",
340 "desc" : "The validation message",
348 "name" : "getRawValue",
349 "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
351 "isConstructor" : false,
353 "memberOf" : "Roo.form.Field",
364 "desc" : "value The field value"
370 "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
372 "isConstructor" : false,
374 "memberOf" : "Roo.form.Field",
382 "type" : "String/HTMLElement/Element",
383 "desc" : "The id of the node, a DOM node or an existing Element",
390 "type" : "Roo.form.Field",
396 "name" : "resetHasChanged",
397 "desc" : "stores the current value in loadedValue",
399 "isConstructor" : false,
401 "memberOf" : "Roo.form.Field",
413 "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.",
415 "isConstructor" : false,
417 "memberOf" : "Roo.form.Field",
428 "name" : "setRawValue",
429 "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
431 "isConstructor" : false,
433 "memberOf" : "Roo.form.Field",
442 "desc" : "The value to set",
450 "name" : "clearInvalid",
451 "desc" : "Clear any invalid styles/messages for this field",
453 "isConstructor" : false,
455 "memberOf" : "Roo.form.Field",
467 "desc" : "Returns whether or not the field value is currently valid",
469 "isConstructor" : false,
471 "memberOf" : "Roo.form.Field",
478 "name" : "preventMark",
480 "desc" : "True to disable marking the field invalid",
488 "desc" : "True if the value is valid, else false"
494 "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
496 "isConstructor" : false,
498 "memberOf" : "Roo.form.Field",
509 "name" : "hasChanged",
510 "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
512 "isConstructor" : false,
514 "memberOf" : "Roo.form.Field",
525 "name" : "updateBox",
526 "desc" : "Sets the current box measurements of the component's underlying element.",
528 "isConstructor" : false,
530 "memberOf" : "Roo.BoxComponent",
539 "desc" : "An object in the format {x, y, width, height}",
547 "name" : "setPagePosition",
548 "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.",
550 "isConstructor" : false,
552 "memberOf" : "Roo.BoxComponent",
561 "desc" : "The new x position",
567 "desc" : "The new y position",
576 "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
578 "isConstructor" : false,
580 "memberOf" : "Roo.BoxComponent",
592 "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}.",
594 "isConstructor" : false,
596 "memberOf" : "Roo.BoxComponent",
604 "type" : "Number/Object",
605 "desc" : "The new width to set, or a size object in the format {width, height}",
611 "desc" : "The new height to set (not required if a size object is passed as the first arg)",
618 "type" : "Roo.BoxComponent",
624 "name" : "getPosition",
625 "desc" : "Gets the current XY position of the component's underlying element.",
627 "isConstructor" : false,
629 "memberOf" : "Roo.BoxComponent",
638 "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
646 "desc" : "The XY position of the element (e.g., [100, 200])"
652 "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.",
654 "isConstructor" : false,
656 "memberOf" : "Roo.BoxComponent",
665 "desc" : "The box-adjusted width that was set",
669 "name" : "adjHeight",
671 "desc" : "The box-adjusted height that was set",
677 "desc" : "The width that was originally specified",
681 "name" : "rawHeight",
683 "desc" : "The height that was originally specified",
692 "desc" : "Gets the current box measurements of the component's underlying element.",
694 "isConstructor" : false,
696 "memberOf" : "Roo.BoxComponent",
705 "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
714 "desc" : "Gets the current size of the component's underlying element.",
716 "isConstructor" : false,
718 "memberOf" : "Roo.BoxComponent",
729 "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
734 "name" : "onPosition",
735 "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.",
737 "isConstructor" : false,
739 "memberOf" : "Roo.BoxComponent",
748 "desc" : "The new x position",
754 "desc" : "The new y position",
762 "name" : "setPosition",
763 "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.",
765 "isConstructor" : false,
767 "memberOf" : "Roo.BoxComponent",
776 "desc" : "The new left",
782 "desc" : "The new top",
791 "desc" : "Returns the id of this component.",
793 "isConstructor" : false,
795 "memberOf" : "Roo.Component",
812 "desc" : "If this is a lazy rendering component, render it to its container element.",
814 "isConstructor" : false,
816 "memberOf" : "Roo.Component",
823 "name" : "container",
824 "type" : "String/HTMLElement/Element",
825 "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
834 "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}.",
836 "isConstructor" : false,
838 "memberOf" : "Roo.Component",
849 "name" : "isVisible",
850 "desc" : "Returns true if this component is visible.",
852 "isConstructor" : false,
854 "memberOf" : "Roo.Component",
865 "name" : "setDisabled",
866 "desc" : "Convenience function for setting disabled/enabled by boolean.",
868 "isConstructor" : false,
870 "memberOf" : "Roo.Component",
888 "desc" : "Hide this component.",
890 "isConstructor" : false,
892 "memberOf" : "Roo.Component",
902 "type" : "Roo.Component",
909 "desc" : "Try to focus this component.",
911 "isConstructor" : false,
913 "memberOf" : "Roo.Component",
920 "name" : "selectText",
922 "desc" : "True to also select the text in this component (if applicable)",
929 "type" : "Roo.Component",
936 "desc" : "Show this component.",
938 "isConstructor" : false,
940 "memberOf" : "Roo.Component",
950 "type" : "Roo.Component",
957 "desc" : "Enable this component.",
959 "isConstructor" : false,
961 "memberOf" : "Roo.Component",
971 "type" : "Roo.Component",
977 "name" : "setVisible",
978 "desc" : "Convenience function to hide or show this component by boolean.",
980 "isConstructor" : false,
982 "memberOf" : "Roo.Component",
991 "desc" : "True to show, false to hide",
998 "type" : "Roo.Component",
1005 "desc" : "Disable this component.",
1007 "isConstructor" : false,
1008 "isPrivate" : false,
1009 "memberOf" : "Roo.Component",
1019 "type" : "Roo.Component",
1026 "desc" : "Returns the underlying {@link Roo.Element}.",
1028 "isConstructor" : false,
1029 "isPrivate" : false,
1030 "memberOf" : "Roo.Component",
1040 "type" : "Roo.Element",
1041 "desc" : "The element"
1046 "name" : "purgeListeners",
1047 "desc" : "Removes all listeners for this object",
1049 "isConstructor" : false,
1050 "isPrivate" : false,
1051 "memberOf" : "Roo.util.Observable",
1063 "desc" : "Appends an event handler to this element (shorthand for addListener)",
1065 "isConstructor" : false,
1066 "isPrivate" : false,
1067 "memberOf" : "Roo.util.Observable",
1074 "name" : "eventName",
1076 "desc" : "The type of event to listen for",
1077 "isOptional" : false
1081 "type" : "Function",
1082 "desc" : "The method the event invokes",
1083 "isOptional" : false
1088 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1089 "isOptional" : false
1094 "desc" : "(optional)",
1095 "isOptional" : false
1103 "desc" : "Removes a listener (shorthand for removeListener)",
1105 "isConstructor" : false,
1106 "isPrivate" : false,
1107 "memberOf" : "Roo.util.Observable",
1114 "name" : "eventName",
1116 "desc" : "The type of event to listen for",
1117 "isOptional" : false
1121 "type" : "Function",
1122 "desc" : "The handler to remove",
1123 "isOptional" : false
1128 "desc" : "(optional) The scope (this object) for the handler",
1129 "isOptional" : false
1136 "name" : "addEvents",
1137 "desc" : "Used to define events on this Observable",
1139 "isConstructor" : false,
1140 "isPrivate" : false,
1141 "memberOf" : "Roo.util.Observable",
1150 "desc" : "The object with the events defined",
1151 "isOptional" : false
1158 "name" : "releaseCapture",
1159 "desc" : "Removes <b>all</b> added captures from the Observable.",
1161 "isConstructor" : false,
1162 "isPrivate" : false,
1163 "memberOf" : "Roo.util.Observable",
1171 "type" : "Observable",
1172 "desc" : "The Observable to release",
1173 "isOptional" : false
1180 "name" : "removeListener",
1181 "desc" : "Removes a listener",
1183 "isConstructor" : false,
1184 "isPrivate" : false,
1185 "memberOf" : "Roo.util.Observable",
1192 "name" : "eventName",
1194 "desc" : "The type of event to listen for",
1195 "isOptional" : false
1199 "type" : "Function",
1200 "desc" : "The handler to remove",
1201 "isOptional" : false
1206 "desc" : "(optional) The scope (this object) for the handler",
1207 "isOptional" : false
1214 "name" : "fireEvent",
1215 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1217 "isConstructor" : false,
1218 "isPrivate" : false,
1219 "memberOf" : "Roo.util.Observable",
1226 "name" : "eventName",
1229 "isOptional" : false
1233 "type" : "Object...",
1234 "desc" : "Variable number of parameters are passed to handlers",
1235 "isOptional" : false
1242 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1247 "name" : "hasListener",
1248 "desc" : "Checks to see if this object has any listeners for a specified event",
1250 "isConstructor" : false,
1251 "isPrivate" : false,
1252 "memberOf" : "Roo.util.Observable",
1259 "name" : "eventName",
1261 "desc" : "The name of the event to check for",
1262 "isOptional" : false
1269 "desc" : "True if the event is being listened for, else false"
1275 "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.",
1277 "isConstructor" : false,
1278 "isPrivate" : false,
1279 "memberOf" : "Roo.util.Observable",
1287 "type" : "Observable",
1288 "desc" : "The Observable to capture",
1289 "isOptional" : false
1293 "type" : "Function",
1294 "desc" : "The function to call",
1295 "isOptional" : false
1300 "desc" : "(optional) The scope (this object) for the fn",
1301 "isOptional" : false
1308 "name" : "addListener",
1309 "desc" : "Appends an event handler to this component",
1311 "isConstructor" : false,
1312 "isPrivate" : false,
1313 "memberOf" : "Roo.util.Observable",
1320 "name" : "eventName",
1322 "desc" : "The type of event to listen for",
1323 "isOptional" : false
1327 "type" : "Function",
1328 "desc" : "The method the event invokes",
1329 "isOptional" : false
1334 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1335 "isOptional" : false
1340 "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>",
1341 "isOptional" : false
1351 "desc" : "Fires when this field loses input focus.",
1352 "memberOf" : "Roo.form.Field",
1360 "type" : "Roo.form.Field",
1362 "isOptional" : false
1370 "desc" : "Fires after the field has been validated with no errors.",
1371 "memberOf" : "Roo.form.Field",
1379 "type" : "Roo.form.Field",
1381 "isOptional" : false
1388 "name" : "specialkey",
1389 "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.",
1390 "memberOf" : "Roo.form.Field",
1398 "type" : "Roo.form.Field",
1400 "isOptional" : false
1404 "type" : "Roo.EventObject",
1405 "desc" : "The event object",
1406 "isOptional" : false
1414 "desc" : "Fires when this field receives input focus.",
1415 "memberOf" : "Roo.form.Field",
1423 "type" : "Roo.form.Field",
1425 "isOptional" : false
1433 "desc" : "Fires after the key up",
1434 "memberOf" : "Roo.form.Field",
1442 "type" : "Roo.form.Field",
1444 "isOptional" : false
1448 "type" : "Roo.EventObject",
1449 "desc" : "The event Object",
1450 "isOptional" : false
1458 "desc" : "Fires after the field has been marked as invalid.",
1459 "memberOf" : "Roo.form.Field",
1467 "type" : "Roo.form.Field",
1469 "isOptional" : false
1474 "desc" : "The validation message",
1475 "isOptional" : false
1483 "desc" : "Fires just before the field blurs if the field value has changed.",
1484 "memberOf" : "Roo.form.Field",
1492 "type" : "Roo.form.Field",
1494 "isOptional" : false
1497 "name" : "newValue",
1499 "desc" : "The new value",
1500 "isOptional" : false
1503 "name" : "oldValue",
1505 "desc" : "The original value",
1506 "isOptional" : false
1514 "desc" : "Fires after the component is moved.",
1515 "memberOf" : "Roo.BoxComponent",
1523 "type" : "Roo.Component",
1525 "isOptional" : false
1530 "desc" : "The new x position",
1531 "isOptional" : false
1536 "desc" : "The new y position",
1537 "isOptional" : false
1545 "desc" : "Fires after the component is resized.",
1546 "memberOf" : "Roo.BoxComponent",
1554 "type" : "Roo.Component",
1556 "isOptional" : false
1559 "name" : "adjWidth",
1561 "desc" : "The box-adjusted width that was set",
1562 "isOptional" : false
1565 "name" : "adjHeight",
1567 "desc" : "The box-adjusted height that was set",
1568 "isOptional" : false
1571 "name" : "rawWidth",
1573 "desc" : "The width that was originally specified",
1574 "isOptional" : false
1577 "name" : "rawHeight",
1579 "desc" : "The height that was originally specified",
1580 "isOptional" : false
1587 "name" : "beforerender",
1588 "desc" : "Fires before the component is rendered. Return false to stop the render.",
1589 "memberOf" : "Roo.Component",
1597 "type" : "Roo.Component",
1599 "isOptional" : false
1607 "desc" : "Fires after the component is disabled.",
1608 "memberOf" : "Roo.Component",
1616 "type" : "Roo.Component",
1618 "isOptional" : false
1626 "desc" : "Fires after the component is rendered.",
1627 "memberOf" : "Roo.Component",
1635 "type" : "Roo.Component",
1637 "isOptional" : false
1645 "desc" : "Fires after the component is destroyed.",
1646 "memberOf" : "Roo.Component",
1654 "type" : "Roo.Component",
1656 "isOptional" : false
1664 "desc" : "Fires after the component is hidden.",
1665 "memberOf" : "Roo.Component",
1673 "type" : "Roo.Component",
1675 "isOptional" : false
1682 "name" : "beforehide",
1683 "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1684 "memberOf" : "Roo.Component",
1692 "type" : "Roo.Component",
1694 "isOptional" : false
1702 "desc" : "Fires after the component is shown.",
1703 "memberOf" : "Roo.Component",
1711 "type" : "Roo.Component",
1713 "isOptional" : false
1720 "name" : "beforeshow",
1721 "desc" : "Fires before the component is shown. Return false to stop the show.",
1722 "memberOf" : "Roo.Component",
1730 "type" : "Roo.Component",
1732 "isOptional" : false
1740 "desc" : "Fires after the component is enabled.",
1741 "memberOf" : "Roo.Component",
1749 "type" : "Roo.Component",
1751 "isOptional" : false
1758 "name" : "beforedestroy",
1759 "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1760 "memberOf" : "Roo.Component",
1768 "type" : "Roo.Component",
1770 "isOptional" : false