2 "name" : "Roo.Element",
11 "desc" : "Represents an Element in the DOM.<br><br>\nUsage:<br>\n<pre><code>\nvar el = Roo.get(\"my-div\");\n\n// or with getEl\nvar el = getEl(\"my-div\");\n\n// or with a DOM element\nvar el = Roo.get(myDivElement);\n</code></pre>\nUsing Roo.get() or getEl() instead of calling the constructor directly ensures you get the same object\neach call instead of constructing a new one.<br><br>\n<b>Animations</b><br />\nMany of the functions for manipulating an element have an optional \"animate\" parameter. The animate parameter\nshould either be a boolean (true) or an object literal with animation options. The animation options are:\n<pre>\nOption Default Description\n--------- -------- ---------------------------------------------\nduration .35 The duration of the animation in seconds\neasing easeOut The YUI easing method\ncallback none A function to execute when the anim completes\nscope this The scope (this) of the callback function\n</pre>\nAlso, the Anim object being used for the animation will be set on your options object as \"anim\", which allows you to stop or\nmanipulate the animation. Here's an example:\n<pre><code>\nvar el = Roo.get(\"my-div\");\n\n// no animation\nel.setWidth(100);\n\n// default animation\nel.setWidth(100, true);\n\n// animation with some options set\nel.setWidth(100, {\n duration: 1,\n callback: this.foo,\n scope: this\n});\n\n// using the \"anim\" property to get the Anim object\nvar opt = {\n duration: 1,\n callback: this.foo,\n scope: this\n};\nel.setWidth(100, opt);\n...\nif(opt.anim.isAnimated()){\n opt.anim.stop();\n}\n</code></pre>\n<b> Composite (Collections of) Elements</b><br />\nFor working with collections of Elements, see <a href=\"Roo.CompositeElement.html\">Roo.CompositeElement</a>",
12 "isSingleton" : false,
16 "isBuilderTop" : false,
17 "memberOf" : "Element",
25 "type" : "String/HTMLElement",
32 "desc" : "(optional) By default the constructor checks to see if there is already an instance of this element in the cache and if there is it returns the same instance. This will skip that check (useful for extending this class).",
42 "name" : "getCenterXY",
44 "desc" : "Calculates the x, y to center this element on the screen",
49 "isConstructor" : false,
62 "desc" : "The x, y values [x, y]"
69 "desc" : "Returns the current scroll position of the element.",
74 "isConstructor" : false,
87 "desc" : "An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)}"
92 "name" : "createShim",
94 "desc" : "Creates an iframe shim for this element to keep selects and other windowed objects from\nshowing through.",
99 "isConstructor" : false,
111 "type" : "Roo.Element",
112 "desc" : "The new shim element"
119 "desc" : "Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll().",
120 "sig" : "(side, value, animate)",
124 "isConstructor" : false,
136 "desc" : "Either \"left\" for scrollLeft values or \"top\" for scrollTop values.",
142 "desc" : "The new scroll value",
147 "type" : "Boolean/Object",
148 "desc" : "(optional) true for the default animation or a standard Element animation config object",
161 "name" : "removeAllListeners",
163 "desc" : "Removes all previous added listeners from this element",
164 "sig" : "()\n{\n\n}",
168 "isConstructor" : false,
180 "type" : "Roo.Element",
188 "desc" : "Wrapper for setting style properties, also takes single object parameter of multiple styles.",
189 "sig" : "(property, value)",
193 "isConstructor" : false,
204 "type" : "String/Object",
205 "desc" : "The style property to be set, or an object of multiple styles.",
211 "desc" : "(optional) The value to apply to the given property, or null if an object was passed.",
218 "type" : "Roo.Element",
226 "desc" : "Appends an event handler (Shorthand for addListener)",
227 "sig" : "(eventName, fn, scope, options)",
231 "isConstructor" : false,
241 "name" : "eventName",
243 "desc" : "The type of event to append",
249 "desc" : "The method the event invokes",
255 "desc" : "(optional) The scope (this object) of the fn",
261 "desc" : "(optional)An object with standard {@link Roo.EventManager#addListener} options",
268 "name" : "addClassOnClick",
270 "desc" : "Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect)",
271 "sig" : "(className)",
275 "isConstructor" : false,
285 "name" : "className",
294 "type" : "Roo.Element",
300 "name" : "getBorderWidth",
302 "desc" : "Gets the width of the border(s) for the specified side(s)",
307 "isConstructor" : false,
319 "desc" : "Can be t, l, r, b or any combination of those to add multiple values. For example,\npassing lr would get the border (l)eft width + the border (r)ight width.",
327 "desc" : "The width of the sides passed added together"
334 "desc" : "Scrolls this element the specified direction. Does bounds checking to make sure the scroll is\nwithin this element's scrollable range.",
335 "sig" : "(direction, distance, animate)",
339 "isConstructor" : false,
349 "name" : "direction",
351 "desc" : "Possible values are: \"l\",\"left\" - \"r\",\"right\" - \"t\",\"top\",\"up\" - \"b\",\"bottom\",\"down\".",
357 "desc" : "How far to scroll the element in pixels",
362 "type" : "Boolean/Object",
363 "desc" : "(optional) true for the default animation or a standard Element animation config object",
371 "desc" : "Returns true if a scroll was triggered or false if the element\nwas scrolled as far as it could go."
376 "name" : "addKeyMap",
378 "desc" : "Creates a KeyMap for this element",
383 "isConstructor" : false,
395 "desc" : "The KeyMap config. See {@link Roo.KeyMap} for more details",
402 "type" : "Roo.KeyMap",
403 "desc" : "The KeyMap created"
408 "name" : "createChild",
410 "desc" : "Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.",
411 "sig" : "(config, insertBefore, returnDom)",
415 "isConstructor" : false,
427 "desc" : "DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be\nautomatically generated with the specified attributes.",
431 "name" : "insertBefore",
432 "type" : "HTMLElement",
433 "desc" : "(optional) a child element of this element",
437 "name" : "returnDom",
439 "desc" : "(optional) true to return the dom node instead of creating an Element",
446 "type" : "Roo.Element",
447 "desc" : "The new child element"
454 "desc" : "Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.",
455 "sig" : "(className)",
459 "isConstructor" : false,
469 "name" : "className",
470 "type" : "String/Array",
471 "desc" : "The CSS class to add, or an array of classes",
478 "type" : "Roo.Element",
486 "desc" : "Sets or Returns the value the dom attribute value",
487 "sig" : "(name, value)",
491 "isConstructor" : false,
502 "type" : "String|Object",
503 "desc" : "The attribute name (or object to set multiple attributes)",
509 "desc" : "(optional) The value to set the attribute to",
517 "desc" : "The attribute value"
522 "name" : "setOpacity",
524 "desc" : "Set the opacity of the element",
525 "sig" : "(opacity, animate)",
529 "isConstructor" : false,
541 "desc" : "The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc",
546 "type" : "Boolean/Object",
547 "desc" : "(optional) true for the default animation or a standard Element animation config object",
554 "type" : "Roo.Element",
562 "desc" : "Set the size of the element. If animation is true, both width an height will be animated concurrently.",
563 "sig" : "(width, height, animate)",
567 "isConstructor" : false,
579 "desc" : "The new width",
585 "desc" : "The new height",
590 "type" : "Boolean/Object",
591 "desc" : "(optional) true for the default animation or a standard Element animation config object",
598 "type" : "Roo.Element",
606 "desc" : "Removes an event handler from this element (shorthand for removeListener)",
607 "sig" : "(eventName, fn)",
611 "isConstructor" : false,
621 "name" : "eventName",
623 "desc" : "the type of event to remove",
629 "desc" : "the method the event invokes",
636 "type" : "Roo.Element",
644 "desc" : "Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).\nThis is a shortcut for findParentNode() that always returns an Roo.Element.",
645 "sig" : "(selector, maxDepth)",
649 "isConstructor" : false,
661 "desc" : "The simple selector to test",
666 "type" : "Number/String/HTMLElement/Element",
667 "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
674 "type" : "Roo.Element",
675 "desc" : "The matching DOM node (or null if no match was found)"
682 "desc" : "Forces the browser to repaint this element",
683 "sig" : "()\n{\n\n}",
687 "isConstructor" : false,
699 "type" : "Roo.Element",
705 "name" : "translatePoints",
707 "desc" : "Translates the passed page coordinates into left/top css values for this element",
712 "isConstructor" : false,
723 "type" : "Number/Array",
724 "desc" : "The page x or an array containing [x, y]",
730 "desc" : "The page y",
738 "desc" : "An object with left and top properties. e.g. {left: (value), top: (value)}"
743 "name" : "createProxy",
745 "desc" : "Creates a proxy element of this element",
746 "sig" : "(config, renderTo, matchBox)",
750 "isConstructor" : false,
761 "type" : "String/Object",
762 "desc" : "The class name of the proxy element or a DomHelper config object",
767 "type" : "String/HTMLElement",
768 "desc" : "(optional) The element or element id to render the proxy to (defaults to document.body)",
774 "desc" : "(optional) True to align and size the proxy to this element now (defaults to false)",
781 "type" : "Roo.Element",
782 "desc" : "The new proxy element"
789 "desc" : "Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).",
790 "sig" : "(selector, returnDom)",
794 "isConstructor" : false,
806 "desc" : "The CSS selector",
810 "name" : "returnDom",
812 "desc" : "(optional) True to return the DOM node instead of Roo.Element (defaults to false)",
819 "type" : "HTMLElement/Roo.Element",
820 "desc" : "The child Roo.Element (or DOM node if returnDom = true)"
827 "desc" : "Return a box {x, y, width, height} that can be used to set another elements\nsize/location to match this element.",
828 "sig" : "(contentBox, local)",
832 "isConstructor" : false,
842 "name" : "contentBox",
844 "desc" : "(optional) If true a box for the content of the element is returned.",
850 "desc" : "(optional) If true the element's left and top are returned instead of page x/y.",
858 "desc" : "box An object in the format {x, y, width, height}"
865 "desc" : "Toggles the element's visibility or display, depending on visibility mode.",
870 "isConstructor" : false,
881 "type" : "Boolean/Object",
882 "desc" : "(optional) True for the default animation, or a standard Element animation config object",
889 "type" : "Roo.Element",
895 "name" : "setBounds",
897 "desc" : "Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.",
898 "sig" : "(x, y, width, height, animate)",
902 "isConstructor" : false,
914 "desc" : "X value for new position (coordinates are page-based)",
920 "desc" : "Y value for new position (coordinates are page-based)",
926 "desc" : "The new width",
932 "desc" : "The new height",
937 "type" : "Boolean/Object",
938 "desc" : "(optional) true for the default animation or a standard Element animation config object",
945 "type" : "Roo.Element",
953 "desc" : "Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
954 "sig" : "()\n{\n\n}",
958 "isConstructor" : false,
971 "desc" : "The X position of the element"
978 "desc" : "Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
979 "sig" : "()\n{\n\n}",
983 "isConstructor" : false,
996 "desc" : "The Y position of the element"
1002 "type" : "function",
1003 "desc" : "Tries to focus the element. Any exceptions are caught and ignored.",
1004 "sig" : "()\n{\n\n}",
1008 "isConstructor" : false,
1009 "isPrivate" : false,
1020 "type" : "Roo.Element",
1027 "type" : "function",
1028 "desc" : "Static method to retrieve Element objects. Uses simple caching to consistently return the same object.\nAutomatically fixes if an object was recreated with the same id via AJAX or DOM.",
1033 "isConstructor" : false,
1034 "isPrivate" : false,
1044 "type" : "String/HTMLElement/Element",
1045 "desc" : "The id of the node, a DOM Node or an existing Element.",
1046 "isOptional" : false
1053 "desc" : "The Element object"
1058 "name" : "autoHeight",
1059 "type" : "function",
1060 "desc" : "Measures the element's content height and updates height to match. Note: this function uses setTimeout so\nthe new height may not be available immediately.",
1061 "sig" : "(animate, duration, onComplete, easing)",
1065 "isConstructor" : false,
1066 "isPrivate" : false,
1077 "desc" : "(optional) Animate the transition (defaults to false)",
1078 "isOptional" : false
1081 "name" : "duration",
1083 "desc" : "(optional) Length of the animation in seconds (defaults to .35)",
1084 "isOptional" : false
1087 "name" : "onComplete",
1088 "type" : "Function",
1089 "desc" : "(optional) Function to call when animation completes",
1090 "isOptional" : false
1095 "desc" : "(optional) Easing method to use (defaults to easeOut)",
1096 "isOptional" : false
1102 "type" : "Roo.Element",
1108 "name" : "scrollIntoView",
1109 "type" : "function",
1110 "desc" : "Scrolls this element into view within the passed container.",
1111 "sig" : "(container, hscroll)",
1115 "isConstructor" : false,
1116 "isPrivate" : false,
1125 "name" : "container",
1126 "type" : "String/HTMLElement/Element",
1127 "desc" : "(optional) The container element to scroll (defaults to document.body)",
1128 "isOptional" : false
1133 "desc" : "(optional) False to disable horizontal scroll (defaults to true)",
1134 "isOptional" : false
1140 "type" : "Roo.Element",
1146 "name" : "getAlignToXY",
1147 "type" : "function",
1148 "desc" : "Gets the x,y coordinates to align this element with another element. See {@link #alignTo} for more info on the\nsupported position values.",
1149 "sig" : "(element, position, offsets)",
1153 "isConstructor" : false,
1154 "isPrivate" : false,
1164 "type" : "String/HTMLElement/Roo.Element",
1165 "desc" : "The element to align to.",
1166 "isOptional" : false
1169 "name" : "position",
1171 "desc" : "The position to align to.",
1172 "isOptional" : false
1177 "desc" : "(optional) Offset the positioning by [x, y]",
1178 "isOptional" : false
1190 "name" : "clearOpacity",
1191 "type" : "function",
1192 "desc" : "Clears any opacity settings from this element. Required in some cases for IE.",
1193 "sig" : "()\n{\n\n}",
1197 "isConstructor" : false,
1198 "isPrivate" : false,
1209 "type" : "Roo.Element",
1215 "name" : "setPositioning",
1216 "type" : "function",
1217 "desc" : "Set positioning with an object returned by getPositioning().",
1222 "isConstructor" : false,
1223 "isPrivate" : false,
1235 "isOptional" : false
1241 "type" : "Roo.Element",
1247 "name" : "getMargins",
1248 "type" : "function",
1249 "desc" : "Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,\nthen it returns the calculated width of the sides (see getPadding)",
1254 "isConstructor" : false,
1255 "isPrivate" : false,
1266 "desc" : "(optional) Any combination of l, r, t, b to get the sum of those sides",
1267 "isOptional" : false
1273 "type" : "Object/Number",
1279 "name" : "setRegion",
1280 "type" : "function",
1281 "desc" : "Sets the element's position and size the the specified region. If animation is true then width, height, x and y will be animated concurrently.",
1282 "sig" : "(region, animate)",
1286 "isConstructor" : false,
1287 "isPrivate" : false,
1297 "type" : "Roo.lib.Region",
1298 "desc" : "The region to fill",
1299 "isOptional" : false
1303 "type" : "Boolean/Object",
1304 "desc" : "(optional) true for the default animation or a standard Element animation config object",
1305 "isOptional" : false
1311 "type" : "Roo.Element",
1317 "name" : "getAttributeNS",
1318 "type" : "function",
1319 "desc" : "Returns the value of a namespaced attribute from the element's underlying DOM node.",
1320 "sig" : "(namespace, name)",
1324 "isConstructor" : false,
1325 "isPrivate" : false,
1334 "name" : "namespace",
1336 "desc" : "The namespace in which to look for the attribute",
1337 "isOptional" : false
1342 "desc" : "The attribute name",
1343 "isOptional" : false
1350 "desc" : "The attribute value"
1356 "type" : "function",
1357 "desc" : "Sets the element's left position directly using CSS style (instead of {@link #setX}).",
1362 "isConstructor" : false,
1363 "isPrivate" : false,
1374 "desc" : "The left CSS property value",
1375 "isOptional" : false
1381 "type" : "Roo.Element",
1388 "type" : "function",
1389 "desc" : "Direct access to the UpdateManager update() method (takes the same parameters).",
1390 "sig" : "(url, params, callback, discardUrl)",
1394 "isConstructor" : false,
1395 "isPrivate" : false,
1405 "type" : "String/Function",
1406 "desc" : "The url for this request or a function to call to get the url",
1407 "isOptional" : false
1411 "type" : "String/Object",
1412 "desc" : "(optional) The parameters to pass as either a url encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
1413 "isOptional" : false
1416 "name" : "callback",
1417 "type" : "Function",
1418 "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)",
1419 "isOptional" : false
1422 "name" : "discardUrl",
1424 "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.",
1425 "isOptional" : false
1431 "type" : "Roo.Element",
1437 "name" : "replaceClass",
1438 "type" : "function",
1439 "desc" : "Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.",
1440 "sig" : "(oldClassName, newClassName)",
1444 "isConstructor" : false,
1445 "isPrivate" : false,
1454 "name" : "oldClassName",
1456 "desc" : "The CSS class to replace",
1457 "isOptional" : false
1460 "name" : "newClassName",
1462 "desc" : "The replacement CSS class",
1463 "isOptional" : false
1469 "type" : "Roo.Element",
1475 "name" : "initDDTarget",
1476 "type" : "function",
1477 "desc" : "Initializes a {@link Roo.dd.DDTarget} object for this element.",
1478 "sig" : "(group, config, overrides)",
1482 "isConstructor" : false,
1483 "isPrivate" : false,
1494 "desc" : "The group the DDTarget object is member of",
1495 "isOptional" : false
1500 "desc" : "The DDTarget config object",
1501 "isOptional" : false
1504 "name" : "overrides",
1506 "desc" : "An object containing methods to override/implement on the DDTarget object",
1507 "isOptional" : false
1513 "type" : "Roo.dd.DDTarget",
1514 "desc" : "The DDTarget object"
1519 "name" : "setHeight",
1520 "type" : "function",
1521 "desc" : "Set the height of the element",
1522 "sig" : "(height, animate)",
1526 "isConstructor" : false,
1527 "isPrivate" : false,
1538 "desc" : "The new height",
1539 "isOptional" : false
1543 "type" : "Boolean/Object",
1544 "desc" : "(optional) true for the default animation or a standard Element animation config object",
1545 "isOptional" : false
1551 "type" : "Roo.Element",
1558 "type" : "function",
1559 "desc" : "Removes worthless text nodes",
1560 "sig" : "(forceReclean)",
1564 "isConstructor" : false,
1565 "isPrivate" : false,
1574 "name" : "forceReclean",
1576 "desc" : "(optional) By default the element\nkeeps track if it has been cleaned already so\nyou can call this over and over. However, if you update the element and\nneed to force a reclean, you can pass true.",
1577 "isOptional" : false
1583 "name" : "getPositioning",
1584 "type" : "function",
1585 "desc" : "Gets an object with all CSS positioning properties. Useful along with setPostioning to get\nsnapshot before performing an update and then restoring the element.",
1586 "sig" : "()\n{\n\n}",
1590 "isConstructor" : false,
1591 "isPrivate" : false,
1609 "type" : "function",
1610 "desc" : "Update the innerHTML of this element, optionally searching for and processing scripts",
1611 "sig" : "(html, loadScripts, callback)",
1615 "isConstructor" : false,
1616 "isPrivate" : false,
1627 "desc" : "The new HTML",
1628 "isOptional" : false
1631 "name" : "loadScripts",
1633 "desc" : "(optional) true to look for and process scripts",
1634 "isOptional" : false
1637 "name" : "callback",
1638 "type" : "Function",
1639 "desc" : "For async script loading you can be noticed when the update completes",
1640 "isOptional" : false
1646 "type" : "Roo.Element",
1652 "name" : "contains",
1653 "type" : "function",
1654 "desc" : "Returns true if this element is an ancestor of the passed element",
1659 "isConstructor" : false,
1660 "isPrivate" : false,
1670 "type" : "HTMLElement/String",
1671 "desc" : "The element to check",
1672 "isOptional" : false
1679 "desc" : "True if this element is an ancestor of el, else false"
1684 "name" : "appendChild",
1685 "type" : "function",
1686 "desc" : "Appends the passed element(s) to this element",
1691 "isConstructor" : false,
1692 "isPrivate" : false,
1702 "type" : "String/HTMLElement/Array/Element/CompositeElement",
1704 "isOptional" : false
1710 "type" : "Roo.Element",
1716 "name" : "getValue",
1717 "type" : "function",
1718 "desc" : "Returns the value of the \"value\" attribute",
1719 "sig" : "(asNumber)",
1723 "isConstructor" : false,
1724 "isPrivate" : false,
1733 "name" : "asNumber",
1735 "desc" : "true to parse the value as a number",
1736 "isOptional" : false
1742 "type" : "String/Number",
1748 "name" : "getRegion",
1749 "type" : "function",
1750 "desc" : "Returns the region of the given element.\nThe element must be part of the DOM tree to have a region (display:none or elements not appended return false).",
1751 "sig" : "()\n{\n\n}",
1755 "isConstructor" : false,
1756 "isPrivate" : false,
1768 "desc" : "A Roo.lib.Region containing \"top, left, bottom, right\" member data."
1773 "name" : "anchorTo",
1774 "type" : "function",
1775 "desc" : "Anchors an element to another element and realigns it when the window is resized.",
1776 "sig" : "(element, position, offsets, animate, monitorScroll, callback)",
1780 "isConstructor" : false,
1781 "isPrivate" : false,
1791 "type" : "String/HTMLElement/Roo.Element",
1792 "desc" : "The element to align to.",
1793 "isOptional" : false
1796 "name" : "position",
1798 "desc" : "The position to align to.",
1799 "isOptional" : false
1804 "desc" : "(optional) Offset the positioning by [x, y]",
1805 "isOptional" : false
1809 "type" : "Boolean/Object",
1810 "desc" : "(optional) True for the default animation or a standard Element animation config object",
1811 "isOptional" : false
1814 "name" : "monitorScroll",
1815 "type" : "Boolean/Number",
1816 "desc" : "(optional) True to monitor body scroll and reposition. If this parameter\nis a number, it is used as the buffer delay (defaults to 50ms).",
1817 "isOptional" : false
1820 "name" : "callback",
1821 "type" : "Function",
1822 "desc" : "The function to call after the animation finishes",
1823 "isOptional" : false
1829 "type" : "Roo.Element",
1835 "name" : "removeClass",
1836 "type" : "function",
1837 "desc" : "Removes one or more CSS classes from the element.",
1838 "sig" : "(className)",
1842 "isConstructor" : false,
1843 "isPrivate" : false,
1852 "name" : "className",
1853 "type" : "String/Array",
1854 "desc" : "The CSS class to remove, or an array of classes",
1855 "isOptional" : false
1861 "type" : "Roo.Element",
1867 "name" : "radioClass",
1868 "type" : "function",
1869 "desc" : "Adds one or more CSS classes to this element and removes the same class(es) from all siblings.",
1870 "sig" : "(className)",
1874 "isConstructor" : false,
1875 "isPrivate" : false,
1884 "name" : "className",
1885 "type" : "String/Array",
1886 "desc" : "The CSS class to add, or an array of classes",
1887 "isOptional" : false
1893 "type" : "Roo.Element",
1899 "name" : "getWidth",
1900 "type" : "function",
1901 "desc" : "Returns the offset width of the element",
1902 "sig" : "(contentWidth)",
1906 "isConstructor" : false,
1907 "isPrivate" : false,
1916 "name" : "contentWidth",
1918 "desc" : "(optional) true to get the width minus borders and padding",
1919 "isOptional" : false
1926 "desc" : "The element's width"
1931 "name" : "insertBefore",
1932 "type" : "function",
1933 "desc" : "Inserts this element before the passed element in the DOM",
1938 "isConstructor" : false,
1939 "isPrivate" : false,
1949 "type" : "String/HTMLElement/Element",
1950 "desc" : "The element to insert before",
1951 "isOptional" : false
1957 "type" : "Roo.Element",
1963 "name" : "getHeight",
1964 "type" : "function",
1965 "desc" : "Returns the offset height of the element",
1966 "sig" : "(contentHeight)",
1970 "isConstructor" : false,
1971 "isPrivate" : false,
1980 "name" : "contentHeight",
1982 "desc" : "(optional) true to get the height minus borders and padding",
1983 "isOptional" : false
1990 "desc" : "The element's height"
1996 "type" : "function",
1997 "desc" : "Sets the element's top position directly using CSS style (instead of {@link #setY}).",
2002 "isConstructor" : false,
2003 "isPrivate" : false,
2014 "desc" : "The top CSS property value",
2015 "isOptional" : false
2021 "type" : "Roo.Element",
2027 "name" : "toggleClass",
2028 "type" : "function",
2029 "desc" : "Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).",
2030 "sig" : "(className)",
2034 "isConstructor" : false,
2035 "isPrivate" : false,
2044 "name" : "className",
2046 "desc" : "The CSS class to toggle",
2047 "isOptional" : false
2053 "type" : "Roo.Element",
2060 "type" : "function",
2061 "desc" : "Creates and wraps this element with another element",
2062 "sig" : "(config, returnDom)",
2066 "isConstructor" : false,
2067 "isPrivate" : false,
2078 "desc" : "(optional) DomHelper element config object for the wrapper element or null for an empty div",
2079 "isOptional" : false
2082 "name" : "returnDom",
2084 "desc" : "(optional) True to return the raw DOM element instead of Roo.Element",
2085 "isOptional" : false
2091 "type" : "HTMLElement/Element",
2092 "desc" : "The newly created wrapper element"
2097 "name" : "setVisible",
2098 "type" : "function",
2099 "desc" : "Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use\nthe display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property.",
2100 "sig" : "(visible, animate)",
2104 "isConstructor" : false,
2105 "isPrivate" : false,
2116 "desc" : "Whether the element is visible",
2117 "isOptional" : false
2121 "type" : "Boolean/Object",
2122 "desc" : "(optional) True for the default animation, or a standard Element animation config object",
2123 "isOptional" : false
2129 "type" : "Roo.Element",
2135 "name" : "addListener",
2136 "type" : "function",
2137 "desc" : "Appends an event handler",
2138 "sig" : "(eventName, fn, scope, options)",
2142 "isConstructor" : false,
2143 "isPrivate" : false,
2152 "name" : "eventName",
2154 "desc" : "The type of event to append",
2155 "isOptional" : false
2159 "type" : "Function",
2160 "desc" : "The method the event invokes",
2161 "isOptional" : false
2166 "desc" : "(optional) The scope (this object) of the fn",
2167 "isOptional" : false
2172 "desc" : "(optional)An object with standard {@link Roo.EventManager#addListener} options",
2173 "isOptional" : false
2179 "name" : "setWidth",
2180 "type" : "function",
2181 "desc" : "Set the width of the element",
2182 "sig" : "(width, animate)",
2186 "isConstructor" : false,
2187 "isPrivate" : false,
2198 "desc" : "The new width",
2199 "isOptional" : false
2203 "type" : "Boolean/Object",
2204 "desc" : "(optional) true for the default animation or a standard Element animation config object",
2205 "isOptional" : false
2211 "type" : "Roo.Element",
2218 "type" : "function",
2219 "desc" : "Centers the Element in either the viewport, or another Element.",
2220 "sig" : "(centerIn)",
2224 "isConstructor" : false,
2225 "isPrivate" : false,
2234 "name" : "centerIn",
2235 "type" : "String/HTMLElement/Roo.Element",
2236 "desc" : "(optional) The element in which to center the element.",
2237 "isOptional" : false
2243 "name" : "isVisible",
2244 "type" : "function",
2245 "desc" : "Checks whether the element is currently visible using both visibility and display properties.",
2250 "isConstructor" : false,
2251 "isPrivate" : false,
2262 "desc" : "(optional) True to walk the dom and see if parent elements are hidden (defaults to false)",
2263 "isOptional" : false
2270 "desc" : "True if the element is currently visible, else false"
2275 "name" : "findParent",
2276 "type" : "function",
2277 "desc" : "Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)",
2278 "sig" : "(selector, maxDepth, returnEl)",
2282 "isConstructor" : false,
2283 "isPrivate" : false,
2292 "name" : "selector",
2294 "desc" : "The simple selector to test",
2295 "isOptional" : false
2298 "name" : "maxDepth",
2299 "type" : "Number/String/HTMLElement/Element",
2300 "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
2301 "isOptional" : false
2304 "name" : "returnEl",
2306 "desc" : "(optional) True to return a Roo.Element object instead of DOM node",
2307 "isOptional" : false
2313 "type" : "HTMLElement",
2314 "desc" : "The matching DOM node (or null if no match was found)"
2319 "name" : "addKeyListener",
2320 "type" : "function",
2321 "desc" : "Convenience method for constructing a KeyMap",
2322 "sig" : "(key, fn, scope)",
2326 "isConstructor" : false,
2327 "isPrivate" : false,
2337 "type" : "Number/Array/Object/String",
2338 "desc" : "Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options:\n {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}",
2339 "isOptional" : false
2343 "type" : "Function",
2344 "desc" : "The function to call",
2345 "isOptional" : false
2350 "desc" : "(optional) The scope of the function",
2351 "isOptional" : false
2357 "type" : "Roo.KeyMap",
2358 "desc" : "The KeyMap created"
2363 "name" : "swallowEvent",
2364 "type" : "function",
2365 "desc" : "Stops the specified event from bubbling and optionally prevents the default action",
2366 "sig" : "(eventName, preventDefault)",
2370 "isConstructor" : false,
2371 "isPrivate" : false,
2380 "name" : "eventName",
2383 "isOptional" : false
2386 "name" : "preventDefault",
2388 "desc" : "(optional) true to prevent the default action too",
2389 "isOptional" : false
2395 "type" : "Roo.Element",
2401 "name" : "getStyles",
2402 "type" : "function",
2403 "desc" : "Returns an object with properties matching the styles requested.\nFor example, el.getStyles('color', 'font-size', 'width') might return\n{'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}.",
2404 "sig" : "(style1, style2)",
2408 "isConstructor" : false,
2409 "isPrivate" : false,
2420 "desc" : "A style name",
2421 "isOptional" : false
2426 "desc" : "A style name",
2427 "isOptional" : false
2434 "desc" : "The style object"
2440 "type" : "function",
2441 "desc" : "Returns the size of the element.",
2442 "sig" : "(contentSize)",
2446 "isConstructor" : false,
2447 "isPrivate" : false,
2456 "name" : "contentSize",
2458 "desc" : "(optional) true to get the width/size minus borders and padding",
2459 "isOptional" : false
2466 "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
2471 "name" : "endMeasure",
2472 "type" : "function",
2473 "desc" : "Restores displays to before beginMeasure was called",
2474 "sig" : "()\n{\n\n}",
2478 "isConstructor" : false,
2479 "isPrivate" : false,
2490 "type" : "Roo.Element",
2496 "name" : "getViewSize",
2497 "type" : "function",
2498 "desc" : "Returns the width and height of the viewport.",
2499 "sig" : "()\n{\n\n}",
2503 "isConstructor" : false,
2504 "isPrivate" : false,
2516 "desc" : "An object containing the viewport's size {width: (viewport width), height: (viewport height)}"
2521 "name" : "addClassOnFocus",
2522 "type" : "function",
2523 "desc" : "Sets up event handlers to add and remove a css class when this element has the focus",
2524 "sig" : "(className)",
2528 "isConstructor" : false,
2529 "isPrivate" : false,
2538 "name" : "className",
2541 "isOptional" : false
2547 "type" : "Roo.Element",
2554 "type" : "function",
2555 "desc" : "Aligns this element with another element relative to the specified anchor points. If the other element is the\ndocument it aligns it to the viewport.\nThe position parameter is optional, and can be specified in any one of the following formats:\n<ul>\n <li><b>Blank</b>: Defaults to aligning the element's top-left corner to the target's bottom-left corner (\"tl-bl\").</li>\n <li><b>One anchor (deprecated)</b>: The passed anchor position is used as the target element's anchor point.\n The element being aligned will position its top-left corner (tl) to that point. <i>This method has been\n deprecated in favor of the newer two anchor syntax below</i>.</li>\n <li><b>Two anchors</b>: If two values from the table below are passed separated by a dash, the first value is used as the\n element's anchor point, and the second value is used as the target's anchor point.</li>\n</ul>\nIn addition to the anchor points, the position parameter also supports the \"?\" character. If \"?\" is passed at the end of\nthe position string, the element will attempt to align as specified, but the position will be adjusted to constrain to\nthe viewport if necessary. Note that the element being aligned might be swapped to align to a different position than\nthat specified in order to enforce the viewport constraints.\nFollowing are all of the supported anchor positions:\n <pre>\n Value Description\n ----- -----------------------------\n tl The top left corner (default)\n t The center of the top edge\n tr The top right corner\n l The center of the left edge\n c In the center of the element\n r The center of the right edge\n bl The bottom left corner\n b The center of the bottom edge\n br The bottom right corner\n </pre>\n Example Usage:\n <pre><code>\n // align el to other-el using the default positioning (\"tl-bl\", non-constrained)\n el.alignTo(\"other-el\");\n\n // align the top left corner of el with the top right corner of other-el (constrained to viewport)\n el.alignTo(\"other-el\", \"tr?\");\n\n // align the bottom right corner of el with the center left edge of other-el\n el.alignTo(\"other-el\", \"br-l?\");\n\n // align the center of el with the bottom left corner of other-el and\n // adjust the x position by -6 pixels (and the y position by 0)\n el.alignTo(\"other-el\", \"c-bl\", [-6, 0]);\n </code></pre>",
2556 "sig" : "(element, position, offsets, animate)",
2560 "isConstructor" : false,
2561 "isPrivate" : false,
2571 "type" : "String/HTMLElement/Roo.Element",
2572 "desc" : "The element to align to.",
2573 "isOptional" : false
2576 "name" : "position",
2578 "desc" : "The position to align to.",
2579 "isOptional" : false
2584 "desc" : "(optional) Offset the positioning by [x, y]",
2585 "isOptional" : false
2589 "type" : "Boolean/Object",
2590 "desc" : "(optional) true for the default animation or a standard Element animation config object",
2591 "isOptional" : false
2597 "type" : "Roo.Element",
2603 "name" : "insertAfter",
2604 "type" : "function",
2605 "desc" : "Inserts this element after the passed element in the DOM",
2610 "isConstructor" : false,
2611 "isPrivate" : false,
2621 "type" : "String/HTMLElement/Element",
2622 "desc" : "The element to insert after",
2623 "isOptional" : false
2629 "type" : "Roo.Element",
2636 "type" : "function",
2637 "desc" : "Hide this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.",
2638 "sig" : "(animate)",
2642 "isConstructor" : false,
2643 "isPrivate" : false,
2653 "type" : "Boolean/Object",
2654 "desc" : "(optional) true for the default animation or a standard Element animation config object",
2655 "isOptional" : false
2661 "type" : "Roo.Element",
2667 "name" : "setBottom",
2668 "type" : "function",
2669 "desc" : "Sets the element's CSS bottom style.",
2674 "isConstructor" : false,
2675 "isPrivate" : false,
2686 "desc" : "The bottom CSS property value",
2687 "isOptional" : false
2693 "type" : "Roo.Element",
2699 "name" : "clearPositioning",
2700 "type" : "function",
2701 "desc" : "Clear positioning back to the default when the document was loaded",
2706 "isConstructor" : false,
2707 "isPrivate" : false,
2718 "desc" : "(optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.",
2719 "isOptional" : false
2725 "type" : "Roo.Element",
2731 "name" : "isDisplayed",
2732 "type" : "function",
2733 "desc" : "Returns true if display is not \"none\"",
2734 "sig" : "()\n{\n\n}",
2738 "isConstructor" : false,
2739 "isPrivate" : false,
2757 "type" : "function",
2758 "desc" : "Show this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.",
2759 "sig" : "(animate)",
2763 "isConstructor" : false,
2764 "isPrivate" : false,
2774 "type" : "Boolean/Object",
2775 "desc" : "(optional) true for the default animation or a standard Element animation config object",
2776 "isOptional" : false
2782 "type" : "Roo.Element",
2788 "name" : "setLeftTop",
2789 "type" : "function",
2790 "desc" : "Quick set left and top adding default units",
2791 "sig" : "(left, top)",
2795 "isConstructor" : false,
2796 "isPrivate" : false,
2807 "desc" : "The left CSS property value",
2808 "isOptional" : false
2813 "desc" : "The top CSS property value",
2814 "isOptional" : false
2820 "type" : "Roo.Element",
2827 "type" : "function",
2828 "desc" : "Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).",
2829 "sig" : "(selector, returnDom)",
2833 "isConstructor" : false,
2834 "isPrivate" : false,
2843 "name" : "selector",
2845 "desc" : "The CSS selector",
2846 "isOptional" : false
2849 "name" : "returnDom",
2851 "desc" : "(optional) True to return the DOM node instead of Roo.Element (defaults to false)",
2852 "isOptional" : false
2858 "type" : "HTMLElement/Roo.Element",
2859 "desc" : "The child Roo.Element (or DOM node if returnDom = true)"
2865 "type" : "function",
2866 "desc" : "Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise\nit is cached for reuse.",
2867 "sig" : "()\n{\n\n}",
2871 "isConstructor" : false,
2872 "isPrivate" : false,
2884 "type" : "function",
2885 "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
2886 "sig" : "(x, y, animate)",
2890 "isConstructor" : false,
2891 "isPrivate" : false,
2902 "desc" : "X value for new position (coordinates are page-based)",
2903 "isOptional" : false
2908 "desc" : "Y value for new position (coordinates are page-based)",
2909 "isOptional" : false
2913 "type" : "Boolean/Object",
2914 "desc" : "(optional) True for the default animation, or a standard Element animation config object",
2915 "isOptional" : false
2921 "type" : "Roo.Element",
2927 "name" : "addClassOnOver",
2928 "type" : "function",
2929 "desc" : "Sets up event handlers to add and remove a css class when the mouse is over this element",
2930 "sig" : "(className, preventFlicker)",
2934 "isConstructor" : false,
2935 "isPrivate" : false,
2944 "name" : "className",
2947 "isOptional" : false
2950 "name" : "preventFlicker",
2952 "desc" : "(optional) If set to true, it prevents flickering by filtering\nmouseout events for children elements",
2953 "isOptional" : false
2959 "type" : "Roo.Element",
2966 "type" : "function",
2967 "desc" : "Gets the left X coordinate",
2972 "isConstructor" : false,
2973 "isPrivate" : false,
2984 "desc" : "True to get the local css position instead of page coordinate",
2985 "isOptional" : false
2997 "name" : "isScrollable",
2998 "type" : "function",
2999 "desc" : "Returns true if this element is scrollable.",
3000 "sig" : "()\n{\n\n}",
3004 "isConstructor" : false,
3005 "isPrivate" : false,
3023 "type" : "function",
3024 "desc" : "Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a\ngradient background, rounded corners and a 4-way shadow.",
3029 "isConstructor" : false,
3030 "isPrivate" : false,
3041 "desc" : "(optional) A base CSS class to apply to the containing wrapper element (defaults to 'x-box').\nNote that there are a number of CSS rules that are dependent on this name to make the overall effect work,\nso if you supply an alternate base class, make sure you also supply all of the necessary rules.",
3042 "isOptional" : false
3048 "type" : "Roo.Element",
3055 "type" : "function",
3056 "desc" : "Replaces the passed element with this element",
3061 "isConstructor" : false,
3062 "isPrivate" : false,
3072 "type" : "String/HTMLElement/Element",
3073 "desc" : "The element to replace",
3074 "isOptional" : false
3080 "type" : "Roo.Element",
3087 "type" : "function",
3088 "desc" : "Creates a {@link Roo.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id).",
3089 "sig" : "(selector, unique)",
3093 "isConstructor" : false,
3094 "isPrivate" : false,
3103 "name" : "selector",
3105 "desc" : "The CSS selector",
3106 "isOptional" : false
3111 "desc" : "(optional) True to create a unique Roo.Element for each child (defaults to false, which creates a single shared flyweight object)",
3112 "isOptional" : false
3118 "type" : "CompositeElement/CompositeElementLite",
3119 "desc" : "The composite element"
3124 "name" : "isMasked",
3125 "type" : "function",
3126 "desc" : "Returns true if this element is masked",
3127 "sig" : "()\n{\n\n}",
3131 "isConstructor" : false,
3132 "isPrivate" : false,
3149 "name" : "getUpdateManager",
3150 "type" : "function",
3151 "desc" : "Gets this element's UpdateManager",
3152 "sig" : "()\n{\n\n}",
3156 "isConstructor" : false,
3157 "isPrivate" : false,
3168 "type" : "Roo.UpdateManager",
3169 "desc" : "The UpdateManager"
3174 "name" : "insertHtml",
3175 "type" : "function",
3176 "desc" : "Inserts an html fragment into this element",
3177 "sig" : "(where, html, returnEl)",
3181 "isConstructor" : false,
3182 "isPrivate" : false,
3193 "desc" : "Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd.",
3194 "isOptional" : false
3199 "desc" : "The HTML fragment",
3200 "isOptional" : false
3203 "name" : "returnEl",
3205 "desc" : "True to return an Roo.Element",
3206 "isOptional" : false
3212 "type" : "HTMLElement/Roo.Element",
3213 "desc" : "The inserted node (or nearest related if more than 1 inserted)"
3219 "type" : "function",
3220 "desc" : "Puts a mask over this element to disable user interaction. Requires core.css.\nThis method can only be applied to elements which accept child nodes.",
3221 "sig" : "(msg, msgCls)",
3225 "isConstructor" : false,
3226 "isPrivate" : false,
3237 "desc" : "(optional) A message to display in the mask",
3238 "isOptional" : false
3243 "desc" : "(optional) A css class to apply to the msg element - use no-spinner to hide the spinner on bootstrap",
3244 "isOptional" : false
3251 "desc" : "The mask element"
3257 "type" : "function",
3258 "desc" : "Gets the top Y coordinate",
3263 "isConstructor" : false,
3264 "isPrivate" : false,
3275 "desc" : "True to get the local css position instead of page coordinate",
3276 "isOptional" : false
3288 "name" : "getBottom",
3289 "type" : "function",
3290 "desc" : "Gets the bottom Y coordinate of the element (element Y position + element height)",
3295 "isConstructor" : false,
3296 "isPrivate" : false,
3307 "desc" : "True to get the local css position instead of page coordinate",
3308 "isOptional" : false
3320 "name" : "getRight",
3321 "type" : "function",
3322 "desc" : "Gets the right X coordinate of the element (element X position + element width)",
3327 "isConstructor" : false,
3328 "isPrivate" : false,
3339 "desc" : "True to get the local css position instead of page coordinate",
3340 "isOptional" : false
3352 "name" : "beginMeasure",
3353 "type" : "function",
3354 "desc" : "Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.",
3355 "sig" : "()\n{\n\n}",
3359 "isConstructor" : false,
3360 "isPrivate" : false,
3371 "type" : "Roo.Element",
3377 "name" : "appendTo",
3378 "type" : "function",
3379 "desc" : "Appends this element to the passed element",
3384 "isConstructor" : false,
3385 "isPrivate" : false,
3395 "type" : "String/HTMLElement/Element",
3396 "desc" : "The new parent element",
3397 "isOptional" : false
3403 "type" : "Roo.Element",
3410 "type" : "function",
3411 "desc" : "Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code.",
3412 "sig" : "(el, named)",
3416 "isConstructor" : false,
3417 "isPrivate" : false,
3427 "type" : "String/HTMLElement",
3428 "desc" : "The dom node or id",
3429 "isOptional" : false
3434 "desc" : "(optional) Allows for creation of named reusable flyweights to\n prevent conflicts (e.g. internally Roo uses \"_internal\")",
3435 "isOptional" : false
3442 "desc" : "The shared Element object"
3447 "name" : "hasClass",
3448 "type" : "function",
3449 "desc" : "Checks if the specified CSS class exists on this element's DOM node.",
3450 "sig" : "(className)",
3454 "isConstructor" : false,
3455 "isPrivate" : false,
3464 "name" : "className",
3466 "desc" : "The CSS class to check for",
3467 "isOptional" : false
3474 "desc" : "True if the class exists, else false"
3479 "name" : "findScrollableParent",
3480 "type" : "function",
3481 "desc" : "Looks at the scrollable parent element",
3482 "sig" : "()\n{\n\n}",
3486 "isConstructor" : false,
3487 "isPrivate" : false,
3498 "name" : "fitToParent",
3499 "type" : "function",
3500 "desc" : "Sizes this element to its parent element's dimensions performing\nneccessary box adjustments.",
3501 "sig" : "(monitorResize, targetParent)",
3505 "isConstructor" : false,
3506 "isPrivate" : false,
3515 "name" : "monitorResize",
3517 "desc" : "(optional) If true maintains the fit when the browser window is resized.",
3518 "isOptional" : false
3521 "name" : "targetParent",
3522 "type" : "String/HTMLElment/Element",
3523 "desc" : "(optional) The target parent, default to the parentNode.",
3524 "isOptional" : false
3530 "type" : "Roo.Element",
3537 "type" : "function",
3538 "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
3539 "sig" : "(pos, animate)",
3543 "isConstructor" : false,
3544 "isPrivate" : false,
3555 "desc" : "Contains X & Y [x, y] values for new position (coordinates are page-based)",
3556 "isOptional" : false
3560 "type" : "Boolean/Object",
3561 "desc" : "(optional) True for the default animation, or a standard Element animation config object",
3562 "isOptional" : false
3568 "type" : "Roo.Element",
3575 "type" : "function",
3576 "desc" : "Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
3577 "sig" : "()\n{\n\n}",
3581 "isConstructor" : false,
3582 "isPrivate" : false,
3594 "desc" : "The XY position of the element"
3599 "name" : "unselectable",
3600 "type" : "function",
3601 "desc" : "Disables text selection for this element (normalized across browsers)",
3602 "sig" : "()\n{\n\n}",
3606 "isConstructor" : false,
3607 "isPrivate" : false,
3618 "type" : "Roo.Element",
3625 "type" : "function",
3626 "desc" : "Tries to blur the element. Any exceptions are caught and ignored.",
3627 "sig" : "()\n{\n\n}",
3631 "isConstructor" : false,
3632 "isPrivate" : false,
3643 "type" : "Roo.Element",
3649 "name" : "setRight",
3650 "type" : "function",
3651 "desc" : "Sets the element's CSS right style.",
3656 "isConstructor" : false,
3657 "isPrivate" : false,
3668 "desc" : "The right CSS property value",
3669 "isOptional" : false
3675 "type" : "Roo.Element",
3681 "name" : "findParentNode",
3682 "type" : "function",
3683 "desc" : "Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)",
3684 "sig" : "(selector, maxDepth, returnEl)",
3688 "isConstructor" : false,
3689 "isPrivate" : false,
3698 "name" : "selector",
3700 "desc" : "The simple selector to test",
3701 "isOptional" : false
3704 "name" : "maxDepth",
3705 "type" : "Number/String/HTMLElement/Element",
3706 "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
3707 "isOptional" : false
3710 "name" : "returnEl",
3712 "desc" : "(optional) True to return a Roo.Element object instead of DOM node",
3713 "isOptional" : false
3719 "type" : "HTMLElement",
3720 "desc" : "The matching DOM node (or null if no match was found)"
3725 "name" : "position",
3726 "type" : "function",
3727 "desc" : "Initializes positioning on this element. If a desired position is not passed, it will make the\nthe element positioned relative IF it is not already positioned.",
3728 "sig" : "(pos, zIndex, x, y)",
3732 "isConstructor" : false,
3733 "isPrivate" : false,
3744 "desc" : "(optional) Positioning to use \"relative\", \"absolute\" or \"fixed\"",
3745 "isOptional" : false
3750 "desc" : "(optional) The zIndex to apply",
3751 "isOptional" : false
3756 "desc" : "(optional) Set the page X position",
3757 "isOptional" : false
3762 "desc" : "(optional) Set the page Y position",
3763 "isOptional" : false
3769 "name" : "getFrameWidth",
3770 "type" : "function",
3771 "desc" : "Returns the sum width of the padding and borders for the passed \"sides\". See getBorderWidth()\n for more information about the sides.",
3776 "isConstructor" : false,
3777 "isPrivate" : false,
3789 "isOptional" : false
3801 "name" : "setLocation",
3802 "type" : "function",
3803 "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
3804 "sig" : "(x, y, animate)",
3808 "isConstructor" : false,
3809 "isPrivate" : false,
3820 "desc" : "X value for new position (coordinates are page-based)",
3821 "isOptional" : false
3826 "desc" : "Y value for new position (coordinates are page-based)",
3827 "isOptional" : false
3831 "type" : "Boolean/Object",
3832 "desc" : "(optional) True for the default animation, or a standard Element animation config object",
3833 "isOptional" : false
3839 "type" : "Roo.Element",
3846 "type" : "function",
3847 "desc" : "Return clipping (overflow) to original clipping before clip() was called",
3848 "sig" : "()\n{\n\n}",
3852 "isConstructor" : false,
3853 "isPrivate" : false,
3864 "type" : "Roo.Element",
3871 "type" : "function",
3872 "desc" : "Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)",
3873 "sig" : "(o, useSet)",
3877 "isConstructor" : false,
3878 "isPrivate" : false,
3889 "desc" : "The object with the attributes",
3890 "isOptional" : false
3895 "desc" : "(optional) false to override the default setAttribute to use expandos.",
3896 "isOptional" : false
3902 "type" : "Roo.Element",
3908 "name" : "setDisplayed",
3909 "type" : "function",
3910 "desc" : "Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.",
3915 "isConstructor" : false,
3916 "isPrivate" : false,
3927 "desc" : "Boolean value to display the element using its default display, or a string to set the display directly",
3928 "isOptional" : false
3934 "type" : "Roo.Element",
3940 "name" : "insertFirst",
3941 "type" : "function",
3942 "desc" : "Inserts (or creates) an element (or DomHelper config) as the first child of the this element",
3947 "isConstructor" : false,
3948 "isPrivate" : false,
3958 "type" : "String/HTMLElement/Element/Object",
3959 "desc" : "The id or element to insert or a DomHelper config to create and insert",
3960 "isOptional" : false
3966 "type" : "Roo.Element",
3967 "desc" : "The new child"
3973 "type" : "function",
3974 "desc" : "Perform animation on this element.",
3975 "sig" : "(args, duration, onComplete, easing, animType)",
3979 "isConstructor" : false,
3980 "isPrivate" : false,
3991 "desc" : "The YUI animation control args",
3992 "isOptional" : false
3995 "name" : "duration",
3997 "desc" : "(optional) How long the animation lasts in seconds (defaults to .35)",
3998 "isOptional" : false
4001 "name" : "onComplete",
4002 "type" : "Function",
4003 "desc" : "(optional) Function to call when animation completes",
4004 "isOptional" : false
4009 "desc" : "(optional) Easing method to use (defaults to 'easeOut')",
4010 "isOptional" : false
4013 "name" : "animType",
4015 "desc" : "(optional) 'run' is the default. Can also be 'color', 'motion', or 'scroll'",
4016 "isOptional" : false
4022 "type" : "Roo.Element",
4028 "name" : "enableDisplayMode",
4029 "type" : "function",
4030 "desc" : "Convenience method for setVisibilityMode(Element.DISPLAY)",
4031 "sig" : "(display)",
4035 "isConstructor" : false,
4036 "isPrivate" : false,
4047 "desc" : "(optional) What to set display to when visible",
4048 "isOptional" : false
4054 "type" : "Roo.Element",
4060 "name" : "getComputedWidth",
4061 "type" : "function",
4062 "desc" : "Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders\nwhen needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements\nif a width has not been set using CSS.",
4063 "sig" : "()\n{\n\n}",
4067 "isConstructor" : false,
4068 "isPrivate" : false,
4086 "type" : "function",
4087 "desc" : "Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove",
4088 "sig" : "()\n{\n\n}",
4092 "isConstructor" : false,
4093 "isPrivate" : false,
4104 "type" : "Roo.Element",
4110 "name" : "setVisibilityMode",
4111 "type" : "function",
4112 "desc" : "Sets the element's visibility mode. When setVisible() is called it\nwill use this to determine whether to set the visibility or the display property.",
4113 "sig" : "(visMode)",
4117 "isConstructor" : false,
4118 "isPrivate" : false,
4129 "desc" : "Element.VISIBILITY or Element.DISPLAY",
4130 "isOptional" : false
4136 "type" : "Roo.Element",
4142 "name" : "getColor",
4143 "type" : "function",
4144 "desc" : "Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values\nare convert to standard 6 digit hex color.",
4145 "sig" : "(attr, defaultValue, prefix)",
4149 "isConstructor" : false,
4150 "isPrivate" : false,
4161 "desc" : "The css attribute",
4162 "isOptional" : false
4165 "name" : "defaultValue",
4167 "desc" : "The default value to use when a valid color isn't found",
4168 "isOptional" : false
4173 "desc" : "(optional) defaults to #. Use an empty string when working with\nYUI color anims.",
4174 "isOptional" : false
4180 "name" : "insertSibling",
4181 "type" : "function",
4182 "desc" : "Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element",
4183 "sig" : "(el, where, returnDom)",
4187 "isConstructor" : false,
4188 "isPrivate" : false,
4198 "type" : "String/HTMLElement/Element/Object",
4199 "desc" : "The id or element to insert or a DomHelper config to create and insert",
4200 "isOptional" : false
4205 "desc" : "(optional) 'before' or 'after' defaults to before",
4206 "isOptional" : false
4209 "name" : "returnDom",
4211 "desc" : "(optional) True to return the raw DOM element instead of Roo.Element",
4212 "isOptional" : false
4218 "type" : "Roo.Element",
4219 "desc" : "the inserted Element"
4224 "name" : "removeListener",
4225 "type" : "function",
4226 "desc" : "Removes an event handler from this element",
4227 "sig" : "(eventName, fn, scope)",
4231 "isConstructor" : false,
4232 "isPrivate" : false,
4241 "name" : "eventName",
4243 "desc" : "the type of event to remove",
4244 "isOptional" : false
4248 "type" : "Function",
4249 "desc" : "the method the event invokes",
4250 "isOptional" : false
4254 "type" : "Function",
4255 "desc" : "(needed for svg fake listeners)",
4256 "isOptional" : false
4262 "type" : "Roo.Element",
4268 "name" : "applyStyles",
4269 "type" : "function",
4270 "desc" : "More flexible version of {@link #setStyle} for setting style properties.",
4275 "isConstructor" : false,
4276 "isPrivate" : false,
4286 "type" : "String/Object/Function",
4287 "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
4288 "isOptional" : false
4294 "type" : "Roo.Element",
4300 "name" : "getPrevSibling",
4301 "type" : "function",
4302 "desc" : "Gets the previous sibling, skipping text nodes",
4303 "sig" : "()\n{\n\n}",
4307 "isConstructor" : false,
4308 "isPrivate" : false,
4319 "type" : "HTMLElement",
4320 "desc" : "The previous sibling or null"
4326 "type" : "function",
4327 "desc" : "Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently.",
4328 "sig" : "(box, adjust, animate)",
4332 "isConstructor" : false,
4333 "isPrivate" : false,
4344 "desc" : "The box to fill {x, y, width, height}",
4345 "isOptional" : false
4350 "desc" : "(optional) Whether to adjust for box-model issues automatically",
4351 "isOptional" : false
4355 "type" : "Boolean/Object",
4356 "desc" : "(optional) true for the default animation or a standard Element animation config object",
4357 "isOptional" : false
4363 "type" : "Roo.Element",
4369 "name" : "initDDProxy",
4370 "type" : "function",
4371 "desc" : "Initializes a {@link Roo.dd.DDProxy} object for this element.",
4372 "sig" : "(group, config, overrides)",
4376 "isConstructor" : false,
4377 "isPrivate" : false,
4388 "desc" : "The group the DDProxy object is member of",
4389 "isOptional" : false
4394 "desc" : "The DDProxy config object",
4395 "isOptional" : false
4398 "name" : "overrides",
4400 "desc" : "An object containing methods to override/implement on the DDProxy object",
4401 "isOptional" : false
4407 "type" : "Roo.dd.DDProxy",
4408 "desc" : "The DDProxy object"
4414 "type" : "function",
4415 "desc" : "Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
4416 "sig" : "(The, animate)",
4420 "isConstructor" : false,
4421 "isPrivate" : false,
4432 "desc" : "X position of the element",
4433 "isOptional" : false
4437 "type" : "Boolean/Object",
4438 "desc" : "(optional) True for the default animation, or a standard Element animation config object",
4439 "isOptional" : false
4445 "type" : "Roo.Element",
4452 "type" : "function",
4453 "desc" : "Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
4454 "sig" : "(The, animate)",
4458 "isConstructor" : false,
4459 "isPrivate" : false,
4470 "desc" : "Y position of the element",
4471 "isOptional" : false
4475 "type" : "Boolean/Object",
4476 "desc" : "(optional) True for the default animation, or a standard Element animation config object",
4477 "isOptional" : false
4483 "type" : "Roo.Element",
4490 "type" : "function",
4491 "desc" : "Selects child nodes based on the passed CSS selector (the selector should not contain an id).",
4492 "sig" : "(selector)",
4496 "isConstructor" : false,
4497 "isPrivate" : false,
4506 "name" : "selector",
4508 "desc" : "The CSS selector",
4509 "isOptional" : false
4516 "desc" : "An array of the matched nodes"
4521 "name" : "getAnchorXY",
4522 "type" : "function",
4523 "desc" : "Gets the x,y coordinates specified by the anchor position on the element.",
4524 "sig" : "(anchor, size, local)",
4528 "isConstructor" : false,
4529 "isPrivate" : false,
4540 "desc" : "(optional) The specified anchor position (defaults to \"c\"). See {@link #alignTo} for details on supported anchor positions.",
4541 "isOptional" : false
4546 "desc" : "(optional) An object containing the size to use for calculating anchor position\n {width: (target width), height: (target height)} (defaults to the element's current size)",
4547 "isOptional" : false
4552 "desc" : "(optional) True to get the local (element top/left-relative) anchor position instead of page coordinates",
4553 "isOptional" : false
4560 "desc" : "[x, y] An array containing the element's x and y coordinates"
4566 "type" : "function",
4567 "desc" : "Initializes a {@link Roo.dd.DD} drag drop object for this element.",
4568 "sig" : "(group, config, overrides)",
4572 "isConstructor" : false,
4573 "isPrivate" : false,
4584 "desc" : "The group the DD object is member of",
4585 "isOptional" : false
4590 "desc" : "The DD config object",
4591 "isOptional" : false
4594 "name" : "overrides",
4596 "desc" : "An object containing methods to override/implement on the DD object",
4597 "isOptional" : false
4603 "type" : "Roo.dd.DD",
4604 "desc" : "The DD object"
4609 "name" : "getComputedHeight",
4610 "type" : "function",
4611 "desc" : "Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders\nwhen needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements\nif a height has not been set using CSS.",
4612 "sig" : "()\n{\n\n}",
4616 "isConstructor" : false,
4617 "isPrivate" : false,
4635 "type" : "function",
4636 "desc" : "Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)",
4637 "sig" : "(selector)",
4641 "isConstructor" : false,
4642 "isPrivate" : false,
4651 "name" : "selector",
4653 "desc" : "The simple selector to test",
4654 "isOptional" : false
4661 "desc" : "True if this element matches the selector, else false"
4667 "type" : "function",
4668 "desc" : "Move this element relative to its current position.",
4669 "sig" : "(direction, distance, animate)",
4673 "isConstructor" : false,
4674 "isPrivate" : false,
4683 "name" : "direction",
4685 "desc" : "Possible values are: \"l\",\"left\" - \"r\",\"right\" - \"t\",\"top\",\"up\" - \"b\",\"bottom\",\"down\".",
4686 "isOptional" : false
4689 "name" : "distance",
4691 "desc" : "How far to move the element in pixels",
4692 "isOptional" : false
4696 "type" : "Boolean/Object",
4697 "desc" : "(optional) true for the default animation or a standard Element animation config object",
4698 "isOptional" : false
4704 "type" : "Roo.Element",
4711 "type" : "function",
4712 "desc" : "Removes this element from the DOM and deletes it from the cache",
4713 "sig" : "()\n{\n\n}",
4717 "isConstructor" : false,
4718 "isPrivate" : false,
4729 "name" : "getNextSibling",
4730 "type" : "function",
4731 "desc" : "Gets the next sibling, skipping text nodes",
4732 "sig" : "()\n{\n\n}",
4736 "isConstructor" : false,
4737 "isPrivate" : false,
4748 "type" : "HTMLElement",
4749 "desc" : "The next sibling or null"
4754 "name" : "getStyle",
4755 "type" : "function",
4756 "desc" : "Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.",
4757 "sig" : "(property)",
4761 "isConstructor" : false,
4762 "isPrivate" : false,
4771 "name" : "property",
4773 "desc" : "The style property whose value is returned.",
4774 "isOptional" : false
4781 "desc" : "The current value of the style property for this element."
4786 "name" : "isBorderBox",
4787 "type" : "function",
4788 "desc" : "Tests various css rules/browsers to determine if this element uses a border box",
4789 "sig" : "()\n{\n\n}",
4793 "isConstructor" : false,
4794 "isPrivate" : false,
4811 "name" : "getPadding",
4812 "type" : "function",
4813 "desc" : "Gets the width of the padding(s) for the specified side(s)",
4818 "isConstructor" : false,
4819 "isPrivate" : false,
4830 "desc" : "Can be t, l, r, b or any combination of those to add multiple values. For example,\npassing lr would get the padding (l)eft + the padding (r)ight.",
4831 "isOptional" : false
4838 "desc" : "The padding of the sides passed added together"