Upgrade to ExtJS 3.0.0 - Released 07/06/2009

[extjs.git] / docs / source / Element.scroll.html
diff --git a/docs/source/Element.scroll.html b/docs/source/Element.scroll.html

new file mode 100644 (file)

index 0000000..e190a5f
--- /dev/null
+++ b/docs/source/Element.scroll.html
@@ -0,0 +1,61 @@
+<html>\r
+<head>\r
+  <title>The source code</title>\r
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
+</head>\r
+<body  onload="prettyPrint();">\r
+    <pre class="prettyprint lang-js"><div id="cls-Ext.Element"></div>/**\r
+ * @class Ext.Element\r
+ */\r
+Ext.Element.addMethods({\r
+    <div id="method-Ext.Element-isScrollable"></div>/**\r
+     * Returns true if this element is scrollable.\r
+     * @return {Boolean}\r
+     */\r
+    isScrollable : function(){\r
+        var dom = this.dom;\r
+        return dom.scrollHeight > dom.clientHeight || dom.scrollWidth > dom.clientWidth;\r
+    },\r
+\r
+    <div id="method-Ext.Element-scrollTo"></div>/**\r
+     * 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().\r
+     * @param {String} side Either "left" for scrollLeft values or "top" for scrollTop values.\r
+     * @param {Number} value The new scroll value.\r
+     * @return {Element} this\r
+     */\r
+    scrollTo : function(side, value){\r
+        this.dom["scroll" + (/top/i.test(side) ? "Top" : "Left")] = value;\r
+        return this;\r
+    },\r
+\r
+    <div id="method-Ext.Element-getScroll"></div>/**\r
+     * Returns the current scroll position of the element.\r
+     * @return {Object} An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)}\r
+     */\r
+    getScroll : function(){\r
+        var d = this.dom, \r
+            doc = document,\r
+            body = doc.body,\r
+            docElement = doc.documentElement,\r
+            l,\r
+            t,\r
+            ret;\r
+\r
+        if(d == doc || d == body){\r
+            if(Ext.isIE && Ext.isStrict){\r
+                l = docElement.scrollLeft; \r
+                t = docElement.scrollTop;\r
+            }else{\r
+                l = window.pageXOffset;\r
+                t = window.pageYOffset;\r
+            }\r
+            ret = {left: l || (body ? body.scrollLeft : 0), top: t || (body ? body.scrollTop : 0)};\r
+        }else{\r
+            ret = {left: d.scrollLeft, top: d.scrollTop};\r
+        }\r
+        return ret;\r
+    }\r
+});</pre>    \r
+</body>\r
+</html>
+\ No newline at end of file