git.roojs.org Git - roojs1/blob - docs/symbols/Roo.Shadow.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5
   6         <head>
   7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
   8                 <meta name="generator" content="JsDoc Toolkit" />
   9
  10
  11                 <title>JsDoc Reference - Roo.Shadow</title>
  12
  13
  14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
  15         <link rel="stylesheet" type="text/css" href="../default.css" />
  16
  17
  18         <script type="text/javascript" src="../page.js">
  19
  20         </script>
  21
  22
  23         </head>
  24
  25         <body onload="RooDocsPage.onload();">
  26
  27
  28 <div class="body-wrap">
  29
  30     <!-- ============================== links to methods. ================================= -->
  31
  32     <div class="top-tools">
  33     <!--
  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>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45 <!-- ============================== class title / details ============================ -->
  46
  47
  48     <h1 class="classTitle">
  49
  50                                 Class Roo.Shadow
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_Shadow.js.html">Roo/Shadow.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">Shadow</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  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.
  73     </div>
  74
  75
  76 <!-- ============================== Class comment block... ========================== -->
  77
  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>
  81         <br/>
  82         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
  83                 src="/blog.php/GtkDjsComments/Roo.Shadow.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.Shadow-configs"></a>
  95
  96
  97
  98
  99
 100       <table cellspacing="0" class="member-table">
 101       <caption>Config Options (Usually are also Properties)</caption>
 102
 103
 104         <tr>
 105             <th class="sig-header" colspan="2">Options</th>
 106
 107             <th class="msource-header">Defined By</th>
 108         </tr>
 109
 110
 111
 112
 113
 114                 <tr class="config-row expandable config-row-alt0 notInherited">
 115                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 116                     <td class="sig">
 117
 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>
 121
 122
 123                         </div>
 124
 125                         <div class="mdesc">
 126                             <div class="short">The shadow display mode.</div>
 127                         </div>
 128
 129                         <div class="mdesc">
 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>
 131                         </div>
 132
 133
 134
 135                     </td>
 136                     <td class="msource">
 137
 138                         Roo.Shadow
 139
 140                     </td>
 141                 </tr>
 142
 143
 144                 <tr class="config-row expandable config-row-alt1 notInherited">
 145                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 146                     <td class="sig">
 147
 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>
 151
 152
 153                         </div>
 154
 155                         <div class="mdesc">
 156                             <div class="short">The number of pixels to offset the shadow from the element (defaults to 4)</div>
 157                         </div>
 158
 159                         <div class="mdesc">
 160                             <div class="long">The number of pixels to offset the shadow from the element (defaults to 4)</div>
 161                         </div>
 162
 163
 164
 165                     </td>
 166                     <td class="msource">
 167
 168                         Roo.Shadow
 169
 170                     </td>
 171                 </tr>
 172
 173
 174     </table>
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184   <!-- ============================== public properties ==================== -->
 185
 186
 187
 188     <a id="Roo.Shadow-props"></a>
 189
 190
 191
 192
 193
 194      <table cellspacing="0" class="member-table">
 195       <caption class="Empty">Public Properties - Has None</caption>
 196      </table>
 197
 198
 199
 200
 201   <!-- ============================== methods summary / details ======================== -->
 202
 203
 204   <a id="Roo.Shadow-methods"></a>
 205         <!-- constructor?? -->
 206
 207         <!-- static's first
 208
 209
 210         -->
 211
 212         <!-- then dynamics first -->
 213
 214
 215
 216
 217
 218
 219       <table cellspacing="0" class="member-table">
 220       <caption>Public Methods</caption>
 221         <tr>
 222             <th class="sig-header" colspan="2">Method</th>
 223             <th class="msource-header">Defined By</th>
 224
 225         </tr>
 226
 227
 228
 229
 230
 231
 232
 233           <tr class="method-row config-row-alt0 expandable notInherited">
 234             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 235
 236
 237             <td class="sig">
 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>
 241
 242                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 243
 244
 245
 246                 </div>
 247                 <div class="mdesc">
 248
 249
 250                         <div class="short">Create a new Roo.Shadow</div>
 251
 252
 253                     <div class="long">
 254
 255
 256
 257                                 Create a new Roo.Shadow
 258
 259
 260                                 <dl class="detailList">
 261                                 <dt class="heading">Parameters:</dt>
 262
 263                                         <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>
 265
 266                                         </dt>
 267                                         <dd>The config object</dd>
 268
 269                                 </dl>
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281                     </div>
 282                 </div>
 283
 284             </td>
 285             <td class="msource">
 286                 &nbsp;
 287             </td>
 288         </tr>
 289
 290
 291           <tr class="method-row config-row-alt1 expandable notInherited">
 292             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 293
 294
 295             <td class="sig">
 296                 <a id="Roo.Shadow-method-hide"   name=".hide"></a>
 297                 <div class="fixedFont">
 298                         <span class="attributes"></span><b class="itemname">hide</b>
 299
 300                                  ()
 301
 302
 303
 304                 </div>
 305                 <div class="mdesc">
 306
 307                    <div class="short">Hides this shadow</div>
 308
 309
 310
 311                     <div class="long">
 312
 313                                 Hides this shadow
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330                     </div>
 331                 </div>
 332
 333             </td>
 334             <td class="msource">
 335
 336                         Roo.Shadow
 337                 &nbsp;
 338             </td>
 339         </tr>
 340
 341
 342           <tr class="method-row config-row-alt0 expandable notInherited">
 343             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 344
 345
 346             <td class="sig">
 347                 <a id="Roo.Shadow-method-isVisible"   name=".isVisible"></a>
 348                 <div class="fixedFont">
 349                         <span class="attributes"></span><b class="itemname">isVisible</b>
 350
 351                                  ()
 352
 353
 354
 355                 </div>
 356                 <div class="mdesc">
 357
 358                    <div class="short">Returns true if the shadow is visible, else false</div>
 359
 360
 361
 362                     <div class="long">
 363
 364                                 Returns true if the shadow is visible, else false
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381                     </div>
 382                 </div>
 383
 384             </td>
 385             <td class="msource">
 386
 387                         Roo.Shadow
 388                 &nbsp;
 389             </td>
 390         </tr>
 391
 392
 393           <tr class="method-row config-row-alt1 expandable notInherited">
 394             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 395
 396
 397             <td class="sig">
 398                 <a id="Roo.Shadow-method-realign"   name=".realign"></a>
 399                 <div class="fixedFont">
 400                         <span class="attributes"></span><b class="itemname">realign</b>
 401
 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>)
 403
 404
 405
 406                 </div>
 407                 <div class="mdesc">
 408
 409                    <div class="short">Direct alignment when values are already available.</div>
 410
 411
 412
 413                     <div class="long">
 414
 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.
 416
 417
 418
 419
 420
 421
 422                                 <dl class="detailList">
 423                                 <dt class="heading">Parameters:</dt>
 424
 425                                         <dt>
 426                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>left</b>
 427
 428                                         </dt>
 429                                         <dd>The target element left position</dd>
 430
 431                                         <dt>
 432                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>top</b>
 433
 434                                         </dt>
 435                                         <dd>The target element top position</dd>
 436
 437                                         <dt>
 438                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>width</b>
 439
 440                                         </dt>
 441                                         <dd>The target element width</dd>
 442
 443                                         <dt>
 444                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>height</b>
 445
 446                                         </dt>
 447                                         <dd>The target element height</dd>
 448
 449                                 </dl>
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461                     </div>
 462                 </div>
 463
 464             </td>
 465             <td class="msource">
 466
 467                         Roo.Shadow
 468                 &nbsp;
 469             </td>
 470         </tr>
 471
 472
 473           <tr class="method-row config-row-alt0 expandable notInherited">
 474             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 475
 476
 477             <td class="sig">
 478                 <a id="Roo.Shadow-method-setZIndex"   name=".setZIndex"></a>
 479                 <div class="fixedFont">
 480                         <span class="attributes"></span><b class="itemname">setZIndex</b>
 481
 482                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>zindex</i></B>)
 483
 484
 485
 486                 </div>
 487                 <div class="mdesc">
 488
 489                    <div class="short">Adjust the z-index of this shadow</div>
 490
 491
 492
 493                     <div class="long">
 494
 495                                 Adjust the z-index of this shadow
 496
 497
 498
 499
 500
 501
 502                                 <dl class="detailList">
 503                                 <dt class="heading">Parameters:</dt>
 504
 505                                         <dt>
 506                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>zindex</b>
 507
 508                                         </dt>
 509                                         <dd>The new z-index</dd>
 510
 511                                 </dl>
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523                     </div>
 524                 </div>
 525
 526             </td>
 527             <td class="msource">
 528
 529                         Roo.Shadow
 530                 &nbsp;
 531             </td>
 532         </tr>
 533
 534
 535           <tr class="method-row config-row-alt1 expandable notInherited">
 536             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 537
 538
 539             <td class="sig">
 540                 <a id="Roo.Shadow-method-show"   name=".show"></a>
 541                 <div class="fixedFont">
 542                         <span class="attributes"></span><b class="itemname">show</b>
 543
 544                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>targetEl</i></B>)
 545
 546
 547
 548                 </div>
 549                 <div class="mdesc">
 550
 551                    <div class="short">Displays the shadow under the target element</div>
 552
 553
 554
 555                     <div class="long">
 556
 557                                 Displays the shadow under the target element
 558
 559
 560
 561
 562
 563
 564                                 <dl class="detailList">
 565                                 <dt class="heading">Parameters:</dt>
 566
 567                                         <dt>
 568                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>targetEl</b>
 569
 570                                         </dt>
 571                                         <dd>The id or element under which the shadow should display</dd>
 572
 573                                 </dl>
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585                     </div>
 586                 </div>
 587
 588             </td>
 589             <td class="msource">
 590
 591                         Roo.Shadow
 592                 &nbsp;
 593             </td>
 594         </tr>
 595
 596
 597     </table>
 598
 599
 600   <!-- ============================== events summary / details ======================== -->
 601
 602
 603   <a id="Roo.Shadow-events"></a>
 604
 605
 606
 607
 608
 609      <table cellspacing="0" class="member-table">
 610       <caption class="Empty">Events - Has None</caption>
 611      </table>
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621 <!-- ============================== footer ================================= -->
 622                 <div class="fineprint" style="clear:both">
 623
 624                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:07 GMT+0800 (HKT)
 625                         Based on
 626                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 627                 </div>
 628         </body>
 629 </html>