Fix #5654 - roojspacker - get it working as a doc tool...
[roojs1] / docs.old / symbols / Roo.Shadow.html
diff --git a/docs.old/symbols/Roo.Shadow.html b/docs.old/symbols/Roo.Shadow.html
new file mode 100644 (file)
index 0000000..738587d
--- /dev/null
@@ -0,0 +1,635 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+       <head>
+               <meta http-equiv="content-type" content="text/html; charset=undefined" />
+               <meta name="generator" content="JsDoc Toolkit" />
+               
+               
+               <title>JsDoc Reference - Roo.Shadow</title>
+               
+               
+       <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />            
+       <link rel="stylesheet" type="text/css" href="../default.css" />
+       
+       
+       <script type="text/javascript" src="../page.js">
+       
+       </script>
+        
+               
+       </head>
+
+       <body onload="RooDocsPage.onload();">
+        
+       
+<div class="body-wrap">
+
+    <!-- ============================== links to methods. ================================= -->        
+
+    <div class="top-tools">
+    <!--
+        <a class="inner-link" href="#Roo.Shadow-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
+        <a class="inner-link" href="#Roo.Shadow-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
+        <a class="inner-link" href="#Roo.Shadow-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
+        <a class="inner-link" href="#Roo.Shadow-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
+        <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
+       -->
+    </div>
+
+    
+<!-- ============================== inheritance Block. ================================= -->   
+       
+<!-- ============================== class title / details ============================ -->
+    
+    
+    <h1 class="classTitle">
+                               
+                               Class Roo.Shadow
+                       </h1>
+                       
+    <table cellspacing="0" class="class-summary-table">
+       
+               <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
+       
+        <tr><td class="label">Defined In:</td><td class="hd-info">
+                       
+                                       <a href="./src/Roo_Shadow.js.html">Roo/Shadow.js</a>.
+                       
+       </td></tr>
+        <tr><td class="label">Class:</td><td class="hd-info">Shadow</td></tr>
+       
+       
+       
+       
+    </table>
+
+    
+<!-- ============================== class summary ========================== -->                       
+    <div class="description">
+       Simple class that can provide a shadow effect for any element.  Note that the element MUST be absolutely positioned,<br/>and the shadow does not provide any shimming.  This should be used only in simple cases -- for more advanced<br/>functionality that can also provide the same shadow effect, see the {<b>link</b> Roo.Layer} class.
+    </div>
+
+       
+<!-- ============================== Class comment block... ========================== -->                                      
+
+<div class="comments">
+       <b>Class Comments / Notes</B> =>  
+       <u onclick="parent.CommentDialog.showCommentId = 'Roo.Shadow';">[Add Your comment/notes about this class]</u>
+       <br/>
+       <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;" 
+               src="/blog.php/GtkDjsComments/Roo.Shadow.html"></iframe>
+</div>
+       
+
+               
+<!-- ============================== config options ========================== -->                                              
+                
+    
+    
+               
+    <div class="hr"></div>
+    <a id="Roo.Shadow-configs"></a>
+               
+    
+     
+    
+       
+      <table cellspacing="0" class="member-table">   
+      <caption>Config Options (Usually are also Properties)</caption>
+    
+       
+        <tr>
+            <th class="sig-header" colspan="2">Options</th>
+           
+            <th class="msource-header">Defined By</th>
+        </tr>
+       
+       
+       
+       
+       
+               <tr class="config-row expandable config-row-alt0">
+                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+                   <td class="sig">
+
+                       <a id="Roo-cfg-mode" name=".mode"></a>
+                       <div class="fixedFont">
+                               <b  class="itemname">mode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+                               
+                               
+                       </div>
+                 
+                       <div class="mdesc">
+                           <div class="short">The shadow display mode.</div> 
+                       </div>
+                       
+                       <div class="mdesc">
+                           <div class="long">
+                    The shadow display mode.  Supports the following options:<br /><br/>sides: Shadow displays on both sides and bottom only<br /><br/>frame: Shadow displays equally on all four sides<br /><br/>drop: Traditional bottom-right drop shadow (default)
+                    
+                </div> 
+                       </div>
+                       
+                       
+
+                   </td>
+                   <td class="msource">
+                       
+                       <a href="./Roo.html#constructor" roo:cls="Roo.html#constructor">Roo</a>
+                               
+                   </td>
+               </tr>
+        
+       
+               <tr class="config-row expandable config-row-alt1 notInherited">
+                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+                   <td class="sig">
+
+                       <a id="Roo.Shadow-cfg-offset" name=".offset"></a>
+                       <div class="fixedFont">
+                               <b  class="itemname">offset</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+                               
+                               
+                       </div>
+                 
+                       <div class="mdesc">
+                           <div class="short">The number of pixels to offset the shadow from the element (defaults to 4)</div> 
+                       </div>
+                       
+                       <div class="mdesc">
+                           <div class="long">
+                    The number of pixels to offset the shadow from the element (defaults to 4)
+                    
+                </div> 
+                       </div>
+                       
+                       
+
+                   </td>
+                   <td class="msource">
+                       
+                       Roo.Shadow
+                               
+                   </td>
+               </tr>
+        
+        
+    </table>
+               
+  
+  
+  
+  
+  
+  
+  
+  
+  <!-- ============================== public properties ==================== -->       
+  
+  
+  
+    <a id="Roo.Shadow-props"></a>      
+    
+    
+
+    
+    
+     <table cellspacing="0" class="member-table">
+      <caption class="Empty">Public Properties - Has None</caption>
+     </table>
+    
+    
+     
+    
+  <!-- ============================== methods summary / details ======================== -->
+  
+  
+  <a id="Roo.Shadow-methods"></a>
+       <!-- constructor?? -->
+       
+       <!-- static's first 
+       
+       
+       -->
+       
+       <!-- then dynamics first -->
+       
+  
+  
+    
+    
+    
+      <table cellspacing="0" class="member-table">
+      <caption>Public Methods</caption>
+        <tr>
+            <th class="sig-header" colspan="2">Method</th>            
+            <th class="msource-header">Defined By</th>
+
+        </tr>
+        
+       
+       
+        
+       
+        
+         
+          <tr class="method-row config-row-alt0 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo-method-Shadow"   name=".Shadow"></a>
+               <div class="fixedFont">
+                       <span class="attributes">new <B>Roo.</B></span><b class="itemname">Shadow</b>
+                               
+                                (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>) 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                
+                       <div class="short">Create a new Roo.Shadow</div> 
+                
+                
+                    <div class="long">
+                       
+                       
+                       
+                               Create a new Roo.Shadow
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>config</b>
+                                               
+                                       </dt>
+                                       <dd>The config object</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.Shadow-method-hide"   name=".hide"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">hide</b>
+                               
+                                () 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Hides this shadow</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Hides this shadow
+                   
+                               
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.Shadow
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt0 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.Shadow-method-isVisible"   name=".isVisible"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">isVisible</b>
+                               
+                                () 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Returns true if the shadow is visible, else false</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Returns true if the shadow is visible, else false
+                   
+                               
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.Shadow
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.Shadow-method-realign"   name=".realign"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">realign</b>
+                               
+                                (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>left</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>top</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>width</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>height</i></B>) 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Direct alignment when values are already available.</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Direct alignment when values are already available. Show must be called at least once before<br/>calling this method to ensure it is initialized.
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>left</b>
+                                               
+                                       </dt>
+                                       <dd>The target element left position</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>top</b>
+                                               
+                                       </dt>
+                                       <dd>The target element top position</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>width</b>
+                                               
+                                       </dt>
+                                       <dd>The target element width</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>height</b>
+                                               
+                                       </dt>
+                                       <dd>The target element height</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.Shadow
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt0 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.Shadow-method-setZIndex"   name=".setZIndex"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">setZIndex</b>
+                               
+                                (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>zindex</i></B>) 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Adjust the z-index of this shadow</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Adjust the z-index of this shadow
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>zindex</b>
+                                               
+                                       </dt>
+                                       <dd>The new z-index</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.Shadow
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.Shadow-method-show"   name=".show"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">show</b>
+                               
+                                (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>targetEl</i></B>) 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Displays the shadow under the target element</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Displays the shadow under the target element
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>targetEl</b>
+                                               
+                                       </dt>
+                                       <dd>The id or element under which the shadow should display</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.Shadow
+               &nbsp;
+            </td>
+        </tr>
+       
+                                                      
+    </table>
+
+  
+  <!-- ============================== events summary / details ======================== -->
+  
+  
+  <a id="Roo.Shadow-events"></a>
+    
+  
+       
+   
+    
+     <table cellspacing="0" class="member-table">
+      <caption class="Empty">Events - Has None</caption>
+     </table>
+    
+    
+  
+    
+    
+  
+  
+  
+<!-- ============================== footer ================================= -->
+               <div class="fineprint" style="clear:both">
+                       
+                       Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT)
+                       Based on 
+                       <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
+               </div>
+       </body>
+</html>