add docblock for password
[roojs1] / docs / src / Roo_lib_Dom.js.html
index b470ca7..eafdb43 100644 (file)
@@ -1,19 +1,10 @@
-<html><head><title>Roo/lib/Dom.js</title><link rel="stylesheet" type="text/css" href="../../css/highlight-js.css"/></head><body class="highlightpage"><code class="jsdoc-pretty"><span class="jsdoc-comment">/*
- * Based on:
- * Ext JS Library 1.1.1
- * Copyright(c) 2006-2007, Ext JS, LLC.
- *
- * Originally Released Under LGPL - original licence link has changed is not relivant.
- *
- * Fork - LGPL
- * &lt;script type=&quot;text/javascript&quot;&gt;
- */
-
-/**
+<html><head><title>Roo/lib/Dom.js</title><link rel="stylesheet" type="text/css" href="../../css/highlight-js.css"/></head><body class="highlightpage"><code class="jsdoc-pretty"><span class="jsdoc-comment">/**
  * @class Roo.lib.Dom
+ * @licence LGPL
  * @static
  * 
  * Dom utils (from YIU afaik)
+ *
  * 
  **/
 </span><span class="jsdoc-var">Roo.lib.Dom </span><span class="jsdoc-syntax">= {
     </span><span class="jsdoc-var">getViewHeight </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">full</span><span class="jsdoc-syntax">) {
         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">full </span><span class="jsdoc-syntax">? </span><span class="jsdoc-var">this.getDocumentHeight</span><span class="jsdoc-syntax">() : </span><span class="jsdoc-var">this.getViewportHeight</span><span class="jsdoc-syntax">();
     },
-
+    </span><span class="jsdoc-comment">/**
+     * Get the Full Document height 
+     * @return {Number} The height
+     */
     </span><span class="jsdoc-var">getDocumentHeight</span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">() {
         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">scrollHeight </span><span class="jsdoc-syntax">= (</span><span class="jsdoc-var">document.compatMode </span><span class="jsdoc-syntax">!= </span><span class="jsdoc-string">&quot;CSS1Compat&quot;</span><span class="jsdoc-syntax">) ? </span><span class="jsdoc-var">document.body.scrollHeight </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">document.documentElement.scrollHeight</span><span class="jsdoc-syntax">;
         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">Math.max</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">scrollHeight</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this.getViewportHeight</span><span class="jsdoc-syntax">());
     },
-
+    </span><span class="jsdoc-comment">/**
+     * Get the Full Document width
+     * @return {Number} The width
+     */
     </span><span class="jsdoc-var">getDocumentWidth</span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">() {
         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">scrollWidth </span><span class="jsdoc-syntax">= (</span><span class="jsdoc-var">document.compatMode </span><span class="jsdoc-syntax">!= </span><span class="jsdoc-string">&quot;CSS1Compat&quot;</span><span class="jsdoc-syntax">) ? </span><span class="jsdoc-var">document.body.scrollWidth </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">document.documentElement.scrollWidth</span><span class="jsdoc-syntax">;
         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">Math.max</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">scrollWidth</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">this.getViewportWidth</span><span class="jsdoc-syntax">());
     },
-
+    </span><span class="jsdoc-comment">/**
+     * Get the Window Viewport height
+     * @return {Number} The height
+     */
     </span><span class="jsdoc-var">getViewportHeight</span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">() {
         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">height </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">self.innerHeight</span><span class="jsdoc-syntax">;
         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">mode </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">document.compatMode</span><span class="jsdoc-syntax">;
 
         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">height</span><span class="jsdoc-syntax">;
     },
-
+    </span><span class="jsdoc-comment">/**
+     * Get the Window Viewport width
+     * @return {Number} The width
+     */
     </span><span class="jsdoc-var">getViewportWidth</span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">() {
         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">width </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">self.innerWidth</span><span class="jsdoc-syntax">;
         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">mode </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">document.compatMode</span><span class="jsdoc-syntax">;