1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.Shadow</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.Shadow-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.Shadow-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.Shadow-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.Shadow-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <!-- ============================== class title / details ============================ -->
48 <h1 class="classTitle">
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
57 <tr><td class="label">Defined In:</td><td class="hd-info">
59 <a href="./src/Roo_Shadow.js.html">Roo/Shadow.js</a>.
62 <tr><td class="label">Class:</td><td class="hd-info">Shadow</td></tr>
70 <!-- ============================== class summary ========================== -->
71 <div class="description">
72 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.
76 <!-- ============================== Class comment block... ========================== -->
78 <div class="comments">
79 <b>Class Comments / Notes</B> =>
80 <u onclick="parent.CommentDialog.showCommentId = 'Roo.Shadow';">[Add Your comment/notes about this class]</u>
82 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
83 src="/blog.php/GtkDjsComments/Roo.Shadow.html"></iframe>
88 <!-- ============================== config options ========================== -->
93 <div class="hr"></div>
94 <a id="Roo.Shadow-configs"></a>
100 <table cellspacing="0" class="member-table">
101 <caption>Config Options (Usually are also Properties)</caption>
105 <th class="sig-header" colspan="2">Options</th>
107 <th class="msource-header">Defined By</th>
114 <tr class="config-row expandable config-row-alt0 notInherited">
115 <td class="micon"><a class="exi" href="#expand"> </a></td>
118 <a id="Roo.Shadow-cfg-mode" name=".mode"></a>
119 <div class="fixedFont">
120 <b class="itemname">mode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
126 <div class="short">The shadow display mode.</div>
130 <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>
144 <tr class="config-row expandable config-row-alt1 notInherited">
145 <td class="micon"><a class="exi" href="#expand"> </a></td>
148 <a id="Roo.Shadow-cfg-offset" name=".offset"></a>
149 <div class="fixedFont">
150 <b class="itemname">offset</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
156 <div class="short">The number of pixels to offset the shadow from the element (defaults to 4)</div>
160 <div class="long">The number of pixels to offset the shadow from the element (defaults to 4)</div>
184 <!-- ============================== public properties ==================== -->
188 <a id="Roo.Shadow-props"></a>
194 <table cellspacing="0" class="member-table">
195 <caption class="Empty">Public Properties - Has None</caption>
201 <!-- ============================== methods summary / details ======================== -->
204 <a id="Roo.Shadow-methods"></a>
205 <!-- constructor?? -->
212 <!-- then dynamics first -->
219 <table cellspacing="0" class="member-table">
220 <caption>Public Methods</caption>
222 <th class="sig-header" colspan="2">Method</th>
223 <th class="msource-header">Defined By</th>
233 <tr class="method-row config-row-alt0 expandable notInherited">
234 <td class="micon"><a class="exi" href="#expand"> </a></td>
238 <a id="Roo-method-Shadow" name=".Shadow"></a>
239 <div class="fixedFont">
240 <span class="attributes">new <B>Roo.</B></span><b class="itemname">Shadow</b>
242 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
250 <div class="short">Create a new Roo.Shadow</div>
257 Create a new Roo.Shadow
260 <dl class="detailList">
261 <dt class="heading">Parameters:</dt>
264 <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>
267 <dd>The config object</dd>
291 <tr class="method-row config-row-alt1 expandable notInherited">
292 <td class="micon"><a class="exi" href="#expand"> </a></td>
296 <a id="Roo.Shadow-method-hide" name=".hide"></a>
297 <div class="fixedFont">
298 <span class="attributes"></span><b class="itemname">hide</b>
307 <div class="short">Hides this shadow</div>
342 <tr class="method-row config-row-alt0 expandable notInherited">
343 <td class="micon"><a class="exi" href="#expand"> </a></td>
347 <a id="Roo.Shadow-method-isVisible" name=".isVisible"></a>
348 <div class="fixedFont">
349 <span class="attributes"></span><b class="itemname">isVisible</b>
358 <div class="short">Returns true if the shadow is visible, else false</div>
364 Returns true if the shadow is visible, else false
393 <tr class="method-row config-row-alt1 expandable notInherited">
394 <td class="micon"><a class="exi" href="#expand"> </a></td>
398 <a id="Roo.Shadow-method-realign" name=".realign"></a>
399 <div class="fixedFont">
400 <span class="attributes"></span><b class="itemname">realign</b>
402 (<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>)
409 <div class="short">Direct alignment when values are already available.</div>
415 Direct alignment when values are already available. Show must be called at least once before<br/>calling this method to ensure it is initialized.
422 <dl class="detailList">
423 <dt class="heading">Parameters:</dt>
426 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>left</b>
429 <dd>The target element left position</dd>
432 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>top</b>
435 <dd>The target element top position</dd>
438 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>width</b>
441 <dd>The target element width</dd>
444 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
447 <dd>The target element height</dd>
473 <tr class="method-row config-row-alt0 expandable notInherited">
474 <td class="micon"><a class="exi" href="#expand"> </a></td>
478 <a id="Roo.Shadow-method-setZIndex" name=".setZIndex"></a>
479 <div class="fixedFont">
480 <span class="attributes"></span><b class="itemname">setZIndex</b>
482 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>zindex</i></B>)
489 <div class="short">Adjust the z-index of this shadow</div>
495 Adjust the z-index of this shadow
502 <dl class="detailList">
503 <dt class="heading">Parameters:</dt>
506 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>zindex</b>
509 <dd>The new z-index</dd>
535 <tr class="method-row config-row-alt1 expandable notInherited">
536 <td class="micon"><a class="exi" href="#expand"> </a></td>
540 <a id="Roo.Shadow-method-show" name=".show"></a>
541 <div class="fixedFont">
542 <span class="attributes"></span><b class="itemname">show</b>
544 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>targetEl</i></B>)
551 <div class="short">Displays the shadow under the target element</div>
557 Displays the shadow under the target element
564 <dl class="detailList">
565 <dt class="heading">Parameters:</dt>
568 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>targetEl</b>
571 <dd>The id or element under which the shadow should display</dd>
600 <!-- ============================== events summary / details ======================== -->
603 <a id="Roo.Shadow-events"></a>
609 <table cellspacing="0" class="member-table">
610 <caption class="Empty">Events - Has None</caption>
621 <!-- ============================== footer ================================= -->
622 <div class="fineprint" style="clear:both">
624 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Mon Aug 15 2011 16:40:29 GMT+0800 (HKT)
626 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>