commit extjs-2.2.1
[extjs.git] / docs / output / Ext.Shadow.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.Shadow-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.Shadow-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.Shadow-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                             <a class="inner-link" href="#Ext.Shadow-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7                         <a class="bookmark" href="../docs/?class=Ext.Shadow"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
8         </div>
9                 <h1>Class Ext.Shadow</h1>
10         <table cellspacing="0">
11             <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
12             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Shadow.js" target="_blank">Shadow.js</a></td></tr>
13             <tr><td class="label">Class:</td><td class="hd-info">Shadow</td></tr>
14                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
15                     </table>
16         <div class="description">
17             *
18 Simple class that can provide a shadow effect for any element.  Note that the element MUST be absolutely positioned,
19 and the shadow does not provide any shimming.  This should be used only in simple cases -- for more advanced
20 functionality that can also provide the same shadow effect, see the <a ext:cls="Ext.Layer" href="output/Ext.Layer.html">Ext.Layer</a> class.        </div>
21         
22         <div class="hr"></div>
23                 <a id="Ext.Shadow-configs"></a>
24         <h2>Config Options</h2>
25         <table cellspacing="0" class="member-table">
26             <tr>
27                 <th class="sig-header" colspan="2">Config Options</th>
28                 <th class="msource-header">Defined By</th>
29             </tr>
30                 <tr class="config-row expandable">\r
31         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
32         <td class="sig">\r
33         <a id="Ext.Shadow-mode"></a>\r
34             <b>mode</b> : String            <div class="mdesc">\r
35                         <div class="short">The shadow display mode. Supports the following options: sides: Shadow displays on both sides and bottom only frame: ...</div>\r
36             <div class="long">\r
37                 The shadow display mode. Supports the following options:<br /> sides: Shadow displays on both sides and bottom only<br /> frame: Shadow displays equally on all four sides<br /> drop: Traditional bottom-right drop shadow (default)            </div>\r
38                         </div>\r
39         </td>\r
40         <td class="msource">Shadow</td>\r
41     </tr>\r
42         <tr class="config-row alt">\r
43         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
44         <td class="sig">\r
45         <a id="Ext.Shadow-offset"></a>\r
46             <b>offset</b> : String            <div class="mdesc">\r
47                             The number of pixels to offset the shadow from the element (defaults to 4)                        </div>\r
48         </td>\r
49         <td class="msource">Shadow</td>\r
50     </tr>\r
51             </table>
52                 <a id="Ext.Shadow-props"></a>
53         <h2>Public Properties</h2>
54         <div class="no-members">This class has no public properties.</div>        <a id="Ext.Shadow-methods"></a>
55         <h2>Public Methods</h2>
56                 <table cellspacing="0" class="member-table">
57             <tr>
58                 <th class="sig-header" colspan="2">Method</th>
59                 <th class="msource-header">Defined By</th>
60             </tr>
61                 <tr class="method-row expandable">\r
62         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
63         <td class="sig">\r
64         <a id="Ext.Shadow-Shadow"></a>\r
65             <b>Shadow</b>(&nbsp;<code>Object config</code>&nbsp;)            <div class="mdesc">\r
66                         <div class="short">Create a new Shadow</div>\r
67             <div class="long">\r
68                 Create a new Shadow    <div class="mdetail-params">\r
69         <strong>Parameters:</strong>\r
70         <ul><li><code>config</code> : Object<div class="sub-desc">The config object</div></li>        </ul>\r
71         <strong>Returns:</strong>\r
72         <ul>\r
73             <li><code></code></li>\r
74         </ul>\r
75     </div>\r
76                 </div>\r
77                         </div>\r
78         </td>\r
79         <td class="msource">Shadow</td>\r
80     </tr>\r
81         <tr class="method-row alt expandable">\r
82         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
83         <td class="sig">\r
84         <a id="Ext.Shadow-hide"></a>\r
85             <b>hide</b>() : void            <div class="mdesc">\r
86                         <div class="short">Hides this shadow</div>\r
87             <div class="long">\r
88                 Hides this shadow    <div class="mdetail-params">\r
89         <strong>Parameters:</strong>\r
90         <ul><li>None.</li>        </ul>\r
91         <strong>Returns:</strong>\r
92         <ul>\r
93             <li><code>void</code></li>\r
94         </ul>\r
95     </div>\r
96                 </div>\r
97                         </div>\r
98         </td>\r
99         <td class="msource">Shadow</td>\r
100     </tr>\r
101         <tr class="method-row expandable">\r
102         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
103         <td class="sig">\r
104         <a id="Ext.Shadow-isVisible"></a>\r
105             <b>isVisible</b>() : void            <div class="mdesc">\r
106                         <div class="short">Returns true if the shadow is visible, else false</div>\r
107             <div class="long">\r
108                 Returns true if the shadow is visible, else false    <div class="mdetail-params">\r
109         <strong>Parameters:</strong>\r
110         <ul><li>None.</li>        </ul>\r
111         <strong>Returns:</strong>\r
112         <ul>\r
113             <li><code>void</code></li>\r
114         </ul>\r
115     </div>\r
116                 </div>\r
117                         </div>\r
118         </td>\r
119         <td class="msource">Shadow</td>\r
120     </tr>\r
121         <tr class="method-row alt expandable">\r
122         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
123         <td class="sig">\r
124         <a id="Ext.Shadow-realign"></a>\r
125             <b>realign</b>(&nbsp;<code>Number left</code>, <code>Number top</code>, <code>Number width</code>, <code>Number height</code>&nbsp;) : void            <div class="mdesc">\r
126                         <div class="short">Direct alignment when values are already available. Show must be called at least once before
127 calling this method to e...</div>\r
128             <div class="long">\r
129                 Direct alignment when values are already available. Show must be called at least once before
130 calling this method to ensure it is initialized.    <div class="mdetail-params">\r
131         <strong>Parameters:</strong>\r
132         <ul><li><code>left</code> : Number<div class="sub-desc">The target element left position</div></li><li><code>top</code> : Number<div class="sub-desc">The target element top position</div></li><li><code>width</code> : Number<div class="sub-desc">The target element width</div></li><li><code>height</code> : Number<div class="sub-desc">The target element height</div></li>        </ul>\r
133         <strong>Returns:</strong>\r
134         <ul>\r
135             <li><code>void</code></li>\r
136         </ul>\r
137     </div>\r
138                 </div>\r
139                         </div>\r
140         </td>\r
141         <td class="msource">Shadow</td>\r
142     </tr>\r
143         <tr class="method-row expandable">\r
144         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
145         <td class="sig">\r
146         <a id="Ext.Shadow-setZIndex"></a>\r
147             <b>setZIndex</b>(&nbsp;<code>Number zindex</code>&nbsp;) : void            <div class="mdesc">\r
148                         <div class="short">Adjust the z-index of this shadow</div>\r
149             <div class="long">\r
150                 Adjust the z-index of this shadow    <div class="mdetail-params">\r
151         <strong>Parameters:</strong>\r
152         <ul><li><code>zindex</code> : Number<div class="sub-desc">The new z-index</div></li>        </ul>\r
153         <strong>Returns:</strong>\r
154         <ul>\r
155             <li><code>void</code></li>\r
156         </ul>\r
157     </div>\r
158                 </div>\r
159                         </div>\r
160         </td>\r
161         <td class="msource">Shadow</td>\r
162     </tr>\r
163         <tr class="method-row alt expandable">\r
164         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
165         <td class="sig">\r
166         <a id="Ext.Shadow-show"></a>\r
167             <b>show</b>(&nbsp;<code>Mixed targetEl</code>&nbsp;) : void            <div class="mdesc">\r
168                         <div class="short">Displays the shadow under the target element</div>\r
169             <div class="long">\r
170                 Displays the shadow under the target element    <div class="mdetail-params">\r
171         <strong>Parameters:</strong>\r
172         <ul><li><code>targetEl</code> : Mixed<div class="sub-desc">The id or element under which the shadow should display</div></li>        </ul>\r
173         <strong>Returns:</strong>\r
174         <ul>\r
175             <li><code>void</code></li>\r
176         </ul>\r
177     </div>\r
178                 </div>\r
179                         </div>\r
180         </td>\r
181         <td class="msource">Shadow</td>\r
182     </tr>\r
183             </table>
184                 <a id="Ext.Shadow-events"></a>
185         <h2>Public Events</h2>
186         <div class="no-members">This class has no public events.</div>
187         </div>